Class MetricsResource

Shard metrics, Prometheus export, audit log, and debug.

Index

Constructors

Methods

get getAudit getDebug prometheus

Constructors

constructor

new MetricsResource(http: BaseClient): MetricsResource
Parameters
- http: BaseClient
Returns MetricsResource
- Defined in src/resources/metrics.ts:11

Methods

get

get(sinceMinutes?: number): Promise<ShardMetricsResponse>
Fetches shard performance metrics.
Parameters
- OptionalsinceMinutes: number
  Lookback window in minutes. Omit for all available data.
Returns Promise<ShardMetricsResponse>
- Defined in src/resources/metrics.ts:19

getAudit

getAudit(limit?: number): Promise<ShardAuditResponse>
Fetches the audit log of API calls made with the owner key.
Parameters
- Optionallimit: number
  Maximum number of entries to return.
Returns Promise<ShardAuditResponse>
- Defined in src/resources/metrics.ts:33

getDebug

getDebug(): Promise<Record<string, unknown>>
Fetches internal debug state. Requires the shard token (scsh_...).

Returns Promise<Record<string, unknown>>
Throws
If shardToken was not provided in config.
- Defined in src/resources/metrics.ts:42

prometheus

prometheus(): Promise<string>
Fetches metrics in Prometheus exposition format (text/plain).

Returns Promise<string>
- Defined in src/resources/metrics.ts:25