npmpackage.info

Gathering detailed insights and metrics for @opentelemetry/api-metrics

Other packages similar to @opentelemetry/api-metrics

@opentelemetry/instrumentation-long-task

0.48.0

OpenTelemetry instrumentation for long task Web API

acelogger

0.17.6

a logger with tracing, metrics inspired by opentelemetry-js API

@zendesk/retrace

3.0.0

define and capture Product Operation Traces along with computed metrics with an optional friendly React beacon API

@yuanwen/acelogger

0.14.0

a logger with tracing, metrics inspired by opentelemetry-js API

Gathering detailed insights and metrics for @opentelemetry/api-metrics

@opentelemetry/api-metrics - 0.33.0 | npmpackage.info

@opentelemetry/api-metrics

OpenTelemetry JavaScript Client

0.33.0

3,033

Apache-2.0

TypeScript

239.09 kB

7.1

Installations

npm install @opentelemetry/api-metrics

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS, UMD

Min. Node Version

>=14

Node Version

14.18.1

NPM Version

lerna/5.4.3/node@v14.18.1+x64 (darwin)

Score

99.4

Supply Chain

98.9

Quality

79.7

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

38

Total

3,296

Closed

623

Merged

2,635

Issues

Open

226

Total

2,108

Closed

1,882

Releases

151

semconv/v1.36.0

Updated on Jul 10, 2025

experimental/v0.203.0

Updated on Jul 09, 2025

experimental/v0.202.0

Updated on Jun 02, 2025

semconv/v1.34.0

Updated on May 21, 2025

semconv/v1.33.1

Updated on May 20, 2025

experimental/v0.201.1

Updated on May 19, 2025

View All 151 releases

Languages

TypeScript

JavaScript

Jinja

Shell

TypeScript (96.75%)

JavaScript (2.95%)

Jinja (0.21%)

Shell (0.08%)

Developer

open-telemetry

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

Apache-2.0 License

3,033 Stars

2,718 Commits

909 Forks

53 Watchers

19 Branches

338 Contributors

Updated on Jul 14, 2025

Maintainers

View All 338 Contributors

Package Meta Information

Latest Version

0.33.0

Package Id

@opentelemetry/api-metrics@0.33.0

Unpacked Size

239.09 kB

Size

26.50 kB

File Count

138

NPM Version

lerna/5.4.3/node@v14.18.1+x64 (darwin)

Node Version

14.18.1

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@opentelemetry/api

Dev Dependencies

@types/mocha @types/node @types/webpack-env codecov istanbul-instrumenter-loader karma karma-chrome-launcher karma-coverage-istanbul-reporter karma-mocha karma-spec-reporter karma-webpack mocha nyc ts-loader ts-mocha typescript webpack

OpenTelemetry API for JavaScript

Note: This is an experimental package under active development. New releases may include breaking changes.

This package provides everything needed to interact with the unstable OpenTelemetry Metrics API, including all TypeScript interfaces, enums, and no-op implementations. It is intended for use both on the server and in the browser.

Beta Software - Use at your own risk

The metrics API is considered alpha software and there is no guarantee of stability or long-term support. When the API is stabilized, it will be made available and supported long-term in the @opentelemetry/api package and this package will be deprecated.

Quick Start

To get started you need to install the SDK and instrumentations, create a MeterProvider, and register it with the API.

Install Dependencies

1$ # Install metrics dependencies
2$ npm install \
3    @opentelemetry/api-metrics \
4    @opentelemetry/sdk-metrics \
5    @opentelemetry/exporter-prometheus # add exporters as needed

Note: this example is for node.js. See examples/tracer-web for a browser example.

Initialize the SDK

Before any other module in your application is loaded, you must initialize the global tracer and meter providers. If you fail to initialize a provider, no-op implementations will be provided to any library which acquires them from the API.

To collect traces and metrics, you will have to tell the SDK where to export telemetry data to. This example uses Jaeger and Prometheus, but exporters exist for other tracing backends. If you're not sure if there is an exporter for your tracing backend, contact your tracing provider.

Metrics

1const api = require("@opentelemetry/api-metrics");
2const { MeterProvider } = require("@opentelemetry/sdk-metrics");
3const { PrometheusExporter } = require("@opentelemetry/exporter-prometheus");
4
5// The Prometheus exporter runs an HTTP server which the Prometheus backend
6// scrapes to collect metrics.
7const exporter = new PrometheusExporter({ startServer: true });
8// Creates MeterProvider and installs the exporter as a MetricReader
9const meterProvider = new MeterProvider();
10meterProvider.addMetricReader(exporter);
11
12/**
13 * Registering the provider with the API allows it to be discovered
14 * and used by instrumentation libraries.
15 */
16api.metrics.setGlobalMeterProvider(meterProvider);

Version Compatibility

Because the npm installer and node module resolution algorithm could potentially allow two or more copies of any given package to exist within the same node_modules structure, the OpenTelemetry API takes advantage of a variable on the global object to store the global API. When an API method in the API package is called, it checks if this global API exists and proxies calls to it if and only if it is a compatible API version. This means if a package has a dependency on an OpenTelemetry API version which is not compatible with the API used by the end user, the package will receive a no-op implementation of the API.

Advanced Use

API Methods

If you are writing an instrumentation library, or prefer to call the API methods directly rather than using the register method on the Tracer/Meter Provider, OpenTelemetry provides direct access to the underlying API methods through the @opentelemetry/api-metrics package. API entry points are defined as global singleton objects trace, metrics, propagation, and context which contain methods used to initialize SDK implementations and acquire resources from the API.

Metrics API Documentation

1const api = require("@opentelemetry/api-metrics");
2
3/* Initialize MeterProvider */
4api.metrics.setGlobalMeterProvider(meterProvider);
5/* returns meterProvider (no-op if a working provider has not been initialized) */
6api.metrics.getMeterProvider();
7/* returns a meter from the registered global meter provider (no-op if a working provider has not been initialized) */
8api.metrics.getMeter(name, version);

Useful links

For more information on OpenTelemetry, visit: https://opentelemetry.io/
For more about OpenTelemetry JavaScript: https://github.com/open-telemetry/opentelemetry-js
For help or feedback on this project, join us in GitHub Discussions

License

Apache 2.0 - See LICENSE for more information.

No vulnerabilities found.

10

Dependency-Update-Tool

Determines if the project uses a dependency update tool.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Maintained

Determines if the project is "actively maintained".

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

10

License

Determines if the project has defined a license.

10

SAST

Determines if the project uses static code analysis.

10

Security-Policy

Determines if the project has published a security policy.

10

CI-Tests

Determines if the project runs tests before pull requests are merged.

10

Contributors

Determines if the project has a set of contributors from multiple organizations (e.g., companies).

9

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 3

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/benchmark.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/benchmark.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/benchmark.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/benchmark.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/benchmark.yml:48: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/benchmark.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/changelog.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/changelog.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/close-stale.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/close-stale.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/create-or-update-release-pr.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/create-or-update-release-pr.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/create-or-update-release-pr.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/create-or-update-release-pr.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yaml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/docs.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yaml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/docs.yaml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/docs.yaml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/docs.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/e2e.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/e2e.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/e2e.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/e2e.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/lint.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/lint.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/peer-api.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/peer-api.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-to-npm.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/publish-to-npm.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-to-npm.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/publish-to-npm.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sbom.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/sbom.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sbom.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/sbom.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sbom.yml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/sbom.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sbom.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/sbom.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/sbom.yml:72: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/sbom.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/survey-on-merged-pr.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/survey-on-merged-pr.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-test.yml:83: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-test.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-test.yml:110: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-test.yml:112: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/unit-test.yml:128: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-test.yml:139: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-test.yml:140: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/unit-test.yml:156: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-test.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/unit-test.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/unit-test.yml:72: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/unit-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/w3c-integration-test.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/w3c-integration-test.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/w3c-integration-test.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/open-telemetry/opentelemetry-js/w3c-integration-test.yml/main?enable=pin
Warn: pipCommand not pinned by hash: integration-tests/tracecontext-integration-test.sh:13
Warn: pipCommand not pinned by hash: integration-tests/tracecontext-integration-test.sh:14
Warn: npmCommand not pinned by hash: .github/workflows/benchmark.yml:35
Warn: npmCommand not pinned by hash: .github/workflows/create-or-update-release-pr.yml:52
Warn: npmCommand not pinned by hash: .github/workflows/e2e.yml:38
Warn: npmCommand not pinned by hash: .github/workflows/e2e.yml:44
Warn: npmCommand not pinned by hash: .github/workflows/peer-api.yml:24
Warn: npmCommand not pinned by hash: .github/workflows/peer-api.yml:27
Warn: npmCommand not pinned by hash: .github/workflows/sbom.yml:22
Warn: npmCommand not pinned by hash: .github/workflows/unit-test.yml:43
Warn: npmCommand not pinned by hash: .github/workflows/unit-test.yml:49
Info: 4 out of 39 GitHub-owned GitHubAction dependencies pinned
Info: 2 out of 7 third-party GitHubAction dependencies pinned
Info: 11 out of 20 npmCommand dependencies pinned
Info: 0 out of 2 pipCommand dependencies pinned

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

7.1

/10

Last Scanned on 2025-07-12T18:52:01Z

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More