Skip to content
This repository has been archived by the owner on Nov 19, 2024. It is now read-only.

Commit

Permalink
mark metrics endpoint experimental
Browse files Browse the repository at this point in the history
  • Loading branch information
mraszyk committed Sep 4, 2023
1 parent 147f0cc commit 78b015b
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions spec/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2116,6 +2116,12 @@ The [standard nearest-rank estimation method](https://en.wikipedia.org/wiki/Perc

### IC method `metrics` {#ic-metrics}

:::note

The metrics management canister API is considered EXPERIMENTAL. Canister developers must be aware that the API may evolve in a non-backward-compatible way.

:::

Given a subnet ID as input, this method returns a collection of metrics for the given subnet.

A single metric entry is of an enumeration type with a single variant (in the future, more variants might be added):
Expand Down Expand Up @@ -4153,6 +4159,12 @@ S with

#### IC Management Canister: Metrics

:::note

The metrics management canister API is considered EXPERIMENTAL. Canister developers must be aware that the API may evolve in a non-backward-compatible way.

:::

The management canister returns metrics for a given subnet. The definition of the metrics values
is not captured in this formal semantics.

Expand Down

0 comments on commit 78b015b

Please sign in to comment.