Step recording metrics about a particular phase or action happening during the ApplicationStartup.

The lifecycle of a StartupStep goes as follows:

the step is created and starts by calling the application startup and is assigned a unique id.
we can then attach information with Tags during processing
we then need to mark the end() of the step

Implementations can track the "execution time" or other metrics for steps.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	StartupStep.Tag Simple key/value association for storing step metadata.
public static interface	StartupStep.Tags Immutable collection of `Tag`.

Method Summary

Modifier and Type	Method and Description
public void	end() Record the state of the step and possibly other metrics like execution time.
public long	getId() Return the unique id for this step within the application startup.
public String	getName() Return the name of the startup step.
public Long	getParentId() Return, if available, the id of the parent step.
public StartupStep.Tags	getTags() Return the `Tag` collection for this step.
public StartupStep	tag(String tag key key, String tag value value) Add a `Tag` to the step.
public StartupStep	tag(String tag key key, Supplier<String> `Supplier` for the tag value value) Add a `Tag` to the step.

Method Detail

end	back to summary
public void end() Record the state of the step and possibly other metrics like execution time. Once ended, changes on the step state are not allowed.

end

back to summary

public void end()

Record the state of the step and possibly other metrics like execution time.

Once ended, changes on the step state are not allowed.

getId	back to summary
public long getId() Return the unique id for this step within the application startup.

getName	back to summary
public String getName() Return the name of the startup step. A step name describes the current action or phase. This technical name should be "." namespaced and can be reused to describe other instances of similar steps during application startup.

getName

back to summary

public String getName()

Return the name of the startup step.

A step name describes the current action or phase. This technical name should be "." namespaced and can be reused to describe other instances of similar steps during application startup.

getParentId	back to summary
public Long getParentId() Return, if available, the id of the parent step. The parent step is the step that was started the most recently when the current step was created. Annotations @Nullable

getParentId

back to summary

public Long getParentId()

Return, if available, the id of the parent step.

The parent step is the step that was started the most recently when the current step was created.

Annotations

@Nullable

getTags	back to summary
public StartupStep.Tags getTags() Return the `Tag` collection for this step.

tag back to summary

tag	back to summary
public StartupStep tag(String key, String value) Add a `Tag` to the step. Parameters key:String tag key value:String tag value

public StartupStep tag(String key, String value)

Add a Tag to the step.

Parameters

key:String: tag key
value:String: tag value

tag back to summary

tag	back to summary
public StartupStep tag(String key, Supplier<String> value) Add a `Tag` to the step. Parameters key:String tag key value:Supplier<String> `Supplier` for the tag value

public StartupStep tag(String key, Supplier<String> value)

Add a Tag to the step.

Parameters

key:String: tag key
value:Supplier<String>: Supplier for the tag value

org.springframework.core.metrics back to summary

public Interface StartupStep.Tag

Known Direct Implementers: org.springframework.core.metrics.jfr.FlightRecorderStartupStep.FlightRecorderTag

Simple key/value association for storing step metadata.

Method Summary

Modifier and Type	Method and Description
public String	getKey() Return the `Tag` name.
public String	getValue() Return the `Tag` value.

Method Detail

getKey	back to summary
public String getKey() Return the `Tag` name.

getValue	back to summary
public String getValue() Return the `Tag` value.

public Interface StartupStep

Nested and Inner Type Summary

Method Summary

Method Detail

public Interface StartupStep.Tag

Method Summary

Method Detail

public Interface StartupStep.Tags

Method Summary