Class S2Metrics

Helper for querying account, basin, and stream level metrics.

Access via S2.metrics. Responses are automatically converted to Date-friendly SDK 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:71

Properties

`Readonly`client

client: Client

Methods

account

account(
args: AccountMetricsInput,
options?: S2RequestOptions,
): Promise<MetricSetResponse>
Account-level metrics.
Parameters
- args: AccountMetricsInput
  Input for account-level metrics.
  - Optionalend?: number | Date
    End timestamp (Date, or milliseconds since Unix epoch), if applicable for the metric set.
  - Optionalinterval?: TimeseriesInterval
    Interval to aggregate over for timeseries metric sets.
  - set: AccountMetricSet
    Metric set to return.
  - Optionalstart?: number | Date
    Start timestamp (Date, or milliseconds since Unix epoch), if applicable for the metric set.
- Optionaloptions: S2RequestOptions
Returns Promise<MetricSetResponse>
- Defined in packages/streamstore/src/metrics.ts:84

basin

basin(
args: BasinMetricsInput,
options?: S2RequestOptions,
): Promise<MetricSetResponse>
Basin-level metrics.
Parameters
- args: BasinMetricsInput
  Input for basin-level metrics.
  - basin: string
    Basin name.
  - Optionalend?: number | Date
    End timestamp (Date, or milliseconds since Unix epoch), if applicable for the metric set.
  - Optionalinterval?: TimeseriesInterval
    Interval to aggregate over for timeseries metric sets.
  - set: BasinMetricSet
    Metric set to return.
  - Optionalstart?: number | Date
    Start timestamp (Date, or milliseconds since Unix epoch), if applicable for the metric set.
- Optionaloptions: S2RequestOptions
Returns Promise<MetricSetResponse>
- Defined in packages/streamstore/src/metrics.ts:113

stream

stream(
args: StreamMetricsInput,
options?: S2RequestOptions,
): Promise<MetricSetResponse>
Stream-level metrics.
Parameters
- args: StreamMetricsInput
  Input for stream-level metrics.
  - basin: string
    Basin name.
  - Optionalend?: number | Date
    End timestamp (Date, or milliseconds since Unix epoch), if applicable for the metric set.
  - Optionalinterval?: TimeseriesInterval
    Interval to aggregate over for timeseries metric sets.
  - set: "storage"
    Metric set to return.
  - Optionalstart?: number | Date
    Start timestamp (Date, or milliseconds since Unix epoch), if applicable for the metric set.
  - stream: string
    Stream name.
- Optionaloptions: S2RequestOptions
Returns Promise<MetricSetResponse>
- Defined in packages/streamstore/src/metrics.ts:144