Skip to main content
S2 exposes metrics about account, basin, and stream resources. The metrics API powers visualizations within the dashboard, but is also accessible from the CLI, SDKs, and REST API for custom uses.
The metrics API may show the result of duplicate counts or other slight discrepancies due to our use of materialized views for efficiency. Metrics computed for billing, on the other hand, do not use such views and should always be accurate (reach out to us if you have any questions about something you are seeing).

​
Metric sets

Metric sets are groupings of metrics evaluated either at the account, basin, or stream level. For example, the account-level active-basins metric set can be obtained with: 
curl \
  --request GET \
  --url "https://aws.s2.dev/v1/metrics?set=active-basins&start=${START}&end=${END}" \
  --header "Authorization: Bearer ${S2_ACCESS_TOKEN}"

​
Common parameters

  • set specifies the requested metric set
  • start and end timestamps, in Unix epoch seconds
    • The time period specified should not exceed 30 days
    • The end timestamp should not be in the future (though some leeway is given to accommodate clock differences)
  • interval represents a duration for use by metric sets that return timeseries
    • for accumulation, this specifies the requested bucket length, or the window of time which the relevant value is an aggregation over
    • for gauge, this specifies the unit to divide the start/end period into, and the timeseries will reflect a momentary reading at each of these divisions of time

​
Metric types

​
scalar

Represents a single numeric value. Can represent a summary, or aggregation, if the metric set requires a start and end period, or an instantaneous value if not.

​
accumulation

Timeseries where each (epoch, value) tuple represents an aggregation value for a bucket of time beginning at the epoch, lasting for the specified bucket_length. Buckets within the time period which have no data will be omitted (unlike with GaugeTimeseries).

​
gauge

Timeseries where each (epoch, value) tuple represents a momentary reading of a value, at the specified epoch instance. Gauge timeseries will contain entries for every interval within the requested time period.

​
label

A set of string labels representing a set. It can represent a summary or aggregation if the metric set requires a start and end period, or an instantaneous set if not.

​
Available metrics

Account

Active basins, storage, throughput

Basin

Active streams, storage, throughput

Stream

Storage, throughput