Class S2Metrics

Metrics helper and argument types.

Index

Constructors

Properties

Methods

account basin stream

Constructors

constructor

new S2Metrics(client: Client, retryConfig?: RetryConfig): S2Metrics
Parameters
- client: Client
- OptionalretryConfig: RetryConfig
Returns S2Metrics
- Defined in packages/streamstore/src/metrics.ts:22

Properties

`Readonly`client

client: Client

Methods

account

account(
args: AccountMetricsArgs,
options?: S2RequestOptions,
): Promise<MetricSetResponse>
Account-level metrics.
Parameters
- args: AccountMetricsArgs
- Optionaloptions: S2RequestOptions
Returns Promise<MetricSetResponse>
- Defined in packages/streamstore/src/metrics.ts:35

basin

basin(
args: BasinMetricsArgs,
options?: S2RequestOptions,
): Promise<MetricSetResponse>
Basin-level metrics.
Parameters
- args: BasinMetricsArgs
- Optionaloptions: S2RequestOptions
Returns Promise<MetricSetResponse>
- Defined in packages/streamstore/src/metrics.ts:56

stream

stream(
args: StreamMetricsArgs,
options?: S2RequestOptions,
): Promise<MetricSetResponse>
Stream-level metrics.
Parameters
- args: StreamMetricsArgs
- Optionaloptions: S2RequestOptions
Returns Promise<MetricSetResponse>
- Defined in packages/streamstore/src/metrics.ts:79