Interface IFeatureUsageTrackingSession

Namespace

Splat.ApplicationPerformanceMonitoring

Assembly

Splat.dll

Represents a session for tracking the usage of a specific feature, allowing for hierarchical sub-feature tracking and exception reporting.

public interface IFeatureUsageTrackingSession : IDisposable

Inherited Members

IDisposable.Dispose()

Extension Methods

ReactiveExtensions.Schedule<T>(T, DateTimeOffset, IScheduler)

ReactiveExtensions.Schedule<T>(T, DateTimeOffset, IScheduler, Action<T>)

ReactiveExtensions.Schedule<T>(T, IScheduler, Func<T, T>)

ReactiveExtensions.Schedule<T>(T, TimeSpan, IScheduler)

ReactiveExtensions.Schedule<T>(T, TimeSpan, IScheduler, Action<T>)

ReactiveExtensions.Schedule<T>(T, TimeSpan, IScheduler, Func<T, T>)

EnableFeatureUsageTrackingExtensions.WithSubFeatureUsageTrackingSession(IFeatureUsageTrackingSession, string, Action<IFeatureUsageTrackingSession>)

Remarks

Implementations of this interface are intended to be used with application performance monitoring (APM) tools to record feature usage and exceptions. The session should be disposed when tracking is complete to ensure that all usage data is properly finalized and reported. Sub-feature sessions can be created to track nested operations within the main feature session.

Properties

FeatureName

Gets the name of the Feature being tracked.

string FeatureName { get; }

Property Value

string

Methods

OnException(Exception)

Notify the APM toolset an exception has occurred in the current tracking session.

void OnException(Exception exception)

Parameters

exception Exception

The exception that occurred.

SubFeature(string)

Creates a new sub-feature tracking session with the specified description.

IFeatureUsageTrackingSession SubFeature(string description)

Parameters

description string

A string that describes the sub-feature to be tracked. Cannot be null or empty.

Returns

IFeatureUsageTrackingSession

An IFeatureUsageTrackingSession instance for tracking usage of the specified sub-feature.

Remarks

Use sub-feature tracking sessions to record usage metrics for distinct operations or components within a larger feature. Each sub-feature session is independent and should be disposed when tracking is complete.