Interface IInitializationPipelineTelemetry

Interface for telemetry events during the initialization pipeline execution.

Namespace: Serenity.InitializationPipeline.Application.Interfaces

Assembly: Serenity.InitializationPipeline.Application.dll

Syntax

public interface IInitializationPipelineTelemetry

Methods

OnCompleted(TimeSpan, bool)

Called when the entire initialization pipeline completes.

Declaration

void OnCompleted(TimeSpan total, bool success)

Parameters

Type	Name	Description
TimeSpan	total	The total time taken to complete the pipeline.
bool	success	Indicates whether the pipeline completed successfully.

OnProgress(string, float)

Called to report progress of a specific task within the pipeline.

Declaration

void OnProgress(string taskId, float stepProgress01)

Parameters

Type	Name	Description
string	taskId	The identifier of the task reporting progress.
float	stepProgress01	Progress value between 0 and 1 indicating the completion status of the task.

OnStarted(IEnumerable<InitializationPipelineStep>)

Called when the initialization pipeline starts.

Declaration

void OnStarted(IEnumerable<InitializationPipelineStep> plan)

Parameters

Type	Name	Description
IEnumerable<InitializationPipelineStep>	plan	The planned steps of the initialization pipeline.

OnTaskCompleted(string, TimeSpan)

Called when a specific task within the pipeline completes successfully.

Declaration

void OnTaskCompleted(string taskId, TimeSpan elapsed)

Parameters

Type	Name	Description
string	taskId	The identifier of the completed task.
TimeSpan	elapsed	The time taken to complete the task.

OnTaskFailed(string, Exception, bool)

Called when a specific task within the pipeline fails.

Declaration

void OnTaskFailed(string taskId, Exception error, bool isCritical)

Parameters

Type	Name	Description
string	taskId	The identifier of the failed task.
Exception	error	The exception representing the error that occurred.
bool	isCritical	Indicates whether the failure is critical to the overall pipeline.