Interface IProfilingSession

Namespace

DotCompute.Runtime.Services.Interfaces

Assembly

DotCompute.Runtime.dll

Profiling session for tracking operation performance. Represents an active profiling context that collects metrics for a specific operation.

public interface IProfilingSession : IDisposable

Inherited Members

IDisposable.Dispose()

Extension Methods

BufferExtensions.IsSafeToDispose(IDisposable)

BufferExtensions.SafeDispose(IDisposable)

Properties

OperationName

Gets the name of the operation being profiled. Identifies what operation or workflow this session is tracking.

string OperationName { get; }

Property Value

string

SessionId

Gets the unique session identifier. Used to correlate metrics and events within this profiling session.

string SessionId { get; }

Property Value

string

StartTime

Gets the start time of the profiling session. Marks when the profiling began for duration calculations.

DateTime StartTime { get; }

Property Value

DateTime

Methods

AddTag(string, string)

Adds a tag to this session. Tags provide additional context and metadata for the profiling session.

void AddTag(string key, string value)

Parameters

key string

The tag key.

value string

The tag value.

End()

Ends the profiling session. Finalizes metric collection and returns the complete session results.

ProfilingSessionResult End()

Returns

ProfilingSessionResult

Final profiling session results.

GetMetrics()

Gets the current session metrics. Returns intermediate metrics collected so far in the session.

SessionMetrics GetMetrics()

Returns

SessionMetrics

Current session metrics.

RecordMetric(string, double)

Records a custom metric for this session. Allows tracking of application-specific performance indicators.

void RecordMetric(string name, double value)

Parameters

name string

The metric name.

value double

The metric value.