IntelligenceX

API Reference

Class

UsageTelemetrySnapshot

Namespace IntelligenceX.Telemetry.Usage
Assembly IntelligenceX
Modifiers sealed

Lightweight snapshot returned by UsageTelemetrySnapshotService.

Inheritance

  • Object
  • UsageTelemetrySnapshot

Constructors

public UsageTelemetrySnapshot(IReadOnlyList<UsageEventRecord> events, DateTimeOffset scannedAtUtc, Int32 rootsFound, Int64 scanDurationMs, IReadOnlyList<String> errors, IReadOnlyList<String> discoveredProviderIds = null, IReadOnlyList<SourceRootRecord> sourceRoots = null, UsageTelemetrySnapshotHealth health = null) #

Initializes a new snapshot.

Parameters

events System.Collections.Generic.IReadOnlyList{IntelligenceX.Telemetry.Usage.UsageEventRecord} requiredposition: 0
scannedAtUtc System.DateTimeOffset requiredposition: 1
rootsFound System.Int32 requiredposition: 2
scanDurationMs System.Int64 requiredposition: 3
errors System.Collections.Generic.IReadOnlyList{System.String} requiredposition: 4
discoveredProviderIds System.Collections.Generic.IReadOnlyList{System.String} = null optionalposition: 5
sourceRoots System.Collections.Generic.IReadOnlyList{IntelligenceX.Telemetry.Usage.SourceRootRecord} = null optionalposition: 6
health IntelligenceX.Telemetry.Usage.UsageTelemetrySnapshotHealth = null optionalposition: 7

Properties

public IReadOnlyList<UsageEventRecord> Events { get; } #

Gets the discovered usage events.

public DateTimeOffset ScannedAtUtc { get; } #

Gets the snapshot capture time.

public Int32 RootsFound { get; } #

Gets the number of roots discovered before scanning.

public Int64 ScanDurationMs { get; } #

Gets the scan duration in milliseconds.

public IReadOnlyList<String> Errors { get; } #

Gets non-fatal discovery or scan errors.

public IReadOnlyList<String> DiscoveredProviderIds { get; } #

Gets the provider ids discovered during the scan, even when some providers produced no events.

public IReadOnlyList<SourceRootRecord> SourceRoots { get; } #

Gets the enabled source roots that were discovered for this snapshot.

public UsageTelemetrySnapshotHealth Health { get; } #

Gets derived health and freshness details for the snapshot when available.