IntelligenceX

API Reference

Class

UsageTelemetrySnapshotService

Edit on GitHub
Namespace IntelligenceX.Telemetry.Usage
Assembly IntelligenceX
Source IntelligenceX/Telemetry/Usage/UsageTelemetrySnapshotService.cs:26
Modifiers sealed

Shared snapshot service for lightweight usage discovery and aggregation.

Inheritance

  • Object
  • UsageTelemetrySnapshotService

Constructors

public UsageTelemetrySnapshotService(IRawArtifactStore rawArtifactStore = null) #
IntelligenceX/Telemetry/Usage/UsageTelemetrySnapshotService.cs:26

Initializes a new shared snapshot service.

Parameters

rawArtifactStore IntelligenceX.Telemetry.Usage.IRawArtifactStore = null optionalposition: 0

Methods

public async Task<UsageTelemetrySnapshot> ScanAsync(CancellationToken cancellationToken = null, IProgress<UsageTelemetryScanProgress> progress = null, Boolean startupWarmup = false) #
Returns: Task<UsageTelemetrySnapshot>

Discovers usage roots and returns a provider-grouped quick snapshot.

Parameters

cancellationToken System.Threading.CancellationToken = null optionalposition: 0
Optional cancellation token.
progress System.IProgress{IntelligenceX.Telemetry.Usage.UsageTelemetryScanProgress} = null optionalposition: 1
Optional progress receiver for staged scan updates.
startupWarmup System.Boolean = false optionalposition: 2
When true, returns a capped recent-artifact startup snapshot before the full scan catches up.

Returns

Usage snapshot with events, timing, and any non-fatal discovery errors.

public UsageTelemetrySnapshot TryLoadCachedSnapshot() #
IntelligenceX/Telemetry/Usage/UsageTelemetrySnapshotService.cs:46
Returns: UsageTelemetrySnapshot

Attempts to load a quick startup snapshot directly from cached quick-report artifacts.

Returns

A cached snapshot when quick-report artifact state is available; otherwise null.