Skip to content

docs(develop): Loosen metrics SDK spec for modules #17389

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
szokeasaurusrex wants to merge 2 commits into from
Closed

docs(develop): Loosen metrics SDK spec for modules #17389

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
476b41b
docs(develop): Loosen metrics SDK spec
szokeasaurusrex Apr 20, 2026
92d3323
Change prefix for metrics functions to 'metric'
szokeasaurusrex Apr 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions develop-docs/sdk/telemetry/metrics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,9 +370,13 @@ Sentry.init({

<SpecSection id="metrics-module" status="stable" since="2.0.0">

### Metrics Module
### Metrics Capturing Functionality
Copy link
Copy Markdown
Contributor

@coolguyzone coolguyzone Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Metrics Capturing Functionality
### Metrics Capture Functionality


SDKs **MUST** expose metrics methods in a `metrics` module or namespace. At minimum, the SDK **MUST** implement the following methods:
SDKs **MUST** expose functionality for capturing `count`, `gauge`, and `distribution` metrics.

Metrics-capturing functionality **SHOULD** be exposed as functions (or another suitable language construct) in a `metrics` module or namespace. If exposing the functionality in a module or namespace is infeasible in a particular SDK's language, the function names **SHOULD** be prefixed with the word `metric`.
Copy link
Copy Markdown
Contributor

@coolguyzone coolguyzone Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Metrics-capturing functionality **SHOULD** be exposed as functions (or another suitable language construct) in a `metrics` module or namespace. If exposing the functionality in a module or namespace is infeasible in a particular SDK's language, the function names **SHOULD** be prefixed with the word `metric`.
Metrics capture functionality **SHOULD** be exposed as functions (or another suitable language construct) in a `metrics` module or namespace. If exposing the functionality in a module or namespace is infeasible in a particular SDK's language, the function names **SHOULD** be prefixed with the word `metric`.


The **RECOMMENDED** API is as follows:

- `Sentry.metrics.count(name, value, options)` — increment a counter
- `Sentry.metrics.gauge(name, value, options)` — set a gauge value
Expand Down
Loading