IntelligenceX

API Reference

Class

GitHubRepositoryObservabilityService

Edit on GitHub
Namespace IntelligenceX.Telemetry.GitHub
Assembly IntelligenceX
Source IntelligenceX/Telemetry/GitHub/GitHubRepositoryObservabilityService.cs:19
Modifiers sealed

Coordinates repository watch management and persisted snapshot history.

Inheritance

  • Object
  • GitHubRepositoryObservabilityService

Constructors

public GitHubRepositoryObservabilityService(IGitHubRepositoryWatchStore watchStore, IGitHubRepositorySnapshotStore snapshotStore) #
IntelligenceX/Telemetry/GitHub/GitHubRepositoryObservabilityService.cs:19

Initializes a new observability service.

Parameters

watchStore IntelligenceX.Telemetry.GitHub.IGitHubRepositoryWatchStore requiredposition: 0
Watch-definition store.
snapshotStore IntelligenceX.Telemetry.GitHub.IGitHubRepositorySnapshotStore requiredposition: 1
Snapshot-history store.

Methods

public GitHubRepositoryWatchRecord EnsureWatch(String repositoryNameWithOwner, Nullable<DateTimeOffset> createdAtUtc = null, String displayName = null, String category = null, String notes = null, Nullable<Boolean> enabled = null) #
IntelligenceX/Telemetry/GitHub/GitHubRepositoryObservabilityService.cs:43
Returns: GitHubRepositoryWatchRecord

Ensures a watch exists for the supplied repository.

Parameters

repositoryNameWithOwner System.String requiredposition: 0
Repository name in owner/name form.
createdAtUtc System.Nullable{System.DateTimeOffset} = null optionalposition: 1
Optional watch creation time.
displayName System.String = null optionalposition: 2
Optional user-facing label.
category System.String = null optionalposition: 3
Optional grouping label.
notes System.String = null optionalposition: 4
Optional freeform notes.
enabled System.Nullable{System.Boolean} = null optionalposition: 5
Optional enabled-state override.

Returns

The persisted watch definition.

public IReadOnlyList<GitHubRepositorySnapshotDelta> GetLatestDeltas(Boolean enabledOnly = true) #
IntelligenceX/Telemetry/GitHub/GitHubRepositoryObservabilityService.cs:115
Returns: IReadOnlyList<GitHubRepositorySnapshotDelta>

Returns the latest per-watch deltas across known watches.

Parameters

enabledOnly System.Boolean = true optionalposition: 0
When true, includes only enabled watches.

Returns

Latest per-watch deltas ordered by repository.

public IReadOnlyList<GitHubRepositorySnapshotRecord> GetSnapshots(String watchId = null) #
IntelligenceX/Telemetry/GitHub/GitHubRepositoryObservabilityService.cs:102
Returns: IReadOnlyList<GitHubRepositorySnapshotRecord>

Returns all persisted snapshots.

Parameters

watchId System.String = null optionalposition: 0
Optional watch identifier filter.

Returns

Ordered snapshot history.

public IReadOnlyList<GitHubRepositoryWatchRecord> GetWatches(Boolean enabledOnly = false) #
IntelligenceX/Telemetry/GitHub/GitHubRepositoryObservabilityService.cs:73
Returns: IReadOnlyList<GitHubRepositoryWatchRecord>

Returns all known watches.

Parameters

enabledOnly System.Boolean = false optionalposition: 0
When true, returns only enabled watches.

Returns

Ordered watch definitions.

public GitHubRepositorySnapshotDelta RecordSnapshot(GitHubRepositorySnapshotRecord snapshot) #
IntelligenceX/Telemetry/GitHub/GitHubRepositoryObservabilityService.cs:87
Returns: GitHubRepositorySnapshotDelta

Persists a snapshot and returns its latest delta versus the prior snapshot.

Parameters

snapshot IntelligenceX.Telemetry.GitHub.GitHubRepositorySnapshotRecord requiredposition: 0
Snapshot to persist.

Returns

Delta versus the immediately prior snapshot when available.