Interface INeosTracer

Namespace

GroupeIsa.Neos.Shared.Tracing

Assembly

GroupeIsa.Neos.Shared.dll

Provides methods for tracing activities in the Neos framework.

public interface INeosTracer

Methods

GetCurrentActivity()

Gets the current tracing activity, if any.

INeosActivity GetCurrentActivity()

Returns

INeosActivity

A INeosActivity instance wrapping the current activity, or wrapping null if there is no current activity.

ResetCurrentActivity()

Resets the current tracing activity.

void ResetCurrentActivity()

StartActivity(string, ActivityKind, DateTimeOffset)

Starts a new tracing activity with the specified name and activity kind.

[ExcludeFromCodeCoverage(Justification = "Default parameter value")]
INeosActivity StartActivity(string name, ActivityKind activityKind = ActivityKind.Internal, DateTimeOffset startTime = default)

Parameters

name string

The name of the activity.

activityKind ActivityKind

The kind of activity (defaults to Internal).

startTime DateTimeOffset

The optional start timestamp to set on the created Activity object.

Returns

INeosActivity

A INeosActivity instance wrapping the started activity.

StartActivity(string, string?, ActivityKind, DateTimeOffset)

Starts a new tracing activity with the specified name, parent ID, and activity kind.

[ExcludeFromCodeCoverage(Justification = "Default parameter value")]
INeosActivity StartActivity(string name, string? parentId, ActivityKind activityKind = ActivityKind.Internal, DateTimeOffset startTime = default)

Parameters

name string

The name of the activity.

parentId string

The parent activity ID, or null if none.

activityKind ActivityKind

The kind of activity (defaults to Internal).

startTime DateTimeOffset

The optional start timestamp to set on the created Activity object.

Returns

INeosActivity

A INeosActivity instance wrapping the started activity.

StartRootActivity(string, ActivityKind)

Starts a new root tracing activity with the specified name and activity kind.

[ExcludeFromCodeCoverage(Justification = "Default parameter value")]
INeosActivity StartRootActivity(string name, ActivityKind activityKind = ActivityKind.Internal)

Parameters

name string

The name of the activity.

activityKind ActivityKind

The kind of activity (defaults to Internal).

Returns

INeosActivity

A INeosActivity instance wrapping the started activity.