Package org.springframework.cloud.task.listener

Class TaskObservations

java.lang.Object

org.springframework.cloud.task.listener.TaskObservations

public class TaskObservations
extends Object

Utility class for publishing Spring Cloud Task specific Observations via Micrometer. Intended for internal use only.

Since:

2.2

Author:

Christian Tzolov, Glenn Renfro

Field Summary

Fields

Modifier and Type	Field	Description
static final String	STATUS_FAILURE	Failing task execution status indicator.
static final String	STATUS_SUCCESS	Successful task execution status indicator.
static final String	UNKNOWN	Default for when value is not present.

Constructor Summary

Constructors

Constructor	Description
TaskObservations(io.micrometer.observation.ObservationRegistry observationRegistry, TaskObservationCloudKeyValues taskObservationCloudKeyValues, io.micrometer.observation.ObservationConvention customObservationConvention)

Method Summary

Modifier and Type	Method	Description
void	onTaskEnd(TaskExecution taskExecution)
void	onTaskFailed(Throwable throwable)
void	onTaskStartup(TaskExecution taskExecution)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

STATUS_SUCCESS

public static final String STATUS_SUCCESS

Successful task execution status indicator.

See Also:

• Constant Field Values

STATUS_FAILURE

public static final String STATUS_FAILURE

Failing task execution status indicator.

See Also:

• Constant Field Values

UNKNOWN

public static final String UNKNOWN

Default for when value is not present.

See Also:

• Constant Field Values

Constructor Details

TaskObservations

public TaskObservations(io.micrometer.observation.ObservationRegistry observationRegistry,
 TaskObservationCloudKeyValues taskObservationCloudKeyValues,
 io.micrometer.observation.ObservationConvention customObservationConvention)

Method Details

onTaskStartup

public void onTaskStartup(TaskExecution taskExecution)

onTaskFailed

public void onTaskFailed(Throwable throwable)

onTaskEnd

public void onTaskEnd(TaskExecution taskExecution)