2.0.1 • Published 5 months ago

@opentelemetry/sdk-metrics v2.0.1

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
5 months ago

OpenTelemetry Metrics SDK

NPM Published Version Apache License

This module contains the Metrics SDK of opentelemetry-js.

Used standalone, this module provides methods for manual instrumentation of code, offering full control over recording metrics for client-side JavaScript (browser) and Node.js.

It does not provide automated instrumentation of known libraries or host environment metrics out-of-the-box.

Installation

npm install --save @opentelemetry/api
npm install --save @opentelemetry/sdk-metrics

Usage

The basic setup of the SDK can be seen as followings:

const opentelemetry = require('@opentelemetry/api');
const { MeterProvider } = require('@opentelemetry/sdk-metrics');

// To create an instrument, you first need to initialize the Meter provider.
// NOTE: The default OpenTelemetry meter provider does not record any metric instruments.
//       Registering a working meter provider allows the API methods to record instruments.
opentelemetry.metrics.setGlobalMeterProvider(new MeterProvider());

// To record a metric event, we used the global singleton meter to create an instrument.
const counter = opentelemetry.metrics.getMeter('default').createCounter('foo');

// record a metric event.
counter.add(1, { attributeKey: 'attribute-value' });

In conditions, we may need to setup an async instrument to observe costly events:

// Creating an async instrument, similar to synchronous instruments
const observableCounter = opentelemetry.metrics.getMeter('default')
  .createObservableCounter('observable-counter');

// Register a single-instrument callback to the async instrument.
observableCounter.addCallback(async (observableResult) => {
  // ... do async stuff
  observableResult.observe(1, { attributeKey: 'attribute-value' });
});

// Register a multi-instrument callback and associate it with a set of async instruments.
opentelemetry.metrics.getMeter('default')
  .addBatchObservableCallback(batchObservableCallback, [ observableCounter ]);
async function batchObservableCallback(batchObservableResult) {
  // ... do async stuff
  batchObservableResult.observe(observableCounter, 1, { attributeKey: 'attribute-value' });
}

Views can be registered when instantiating a MeterProvider:

const meterProvider = new MeterProvider({
  views: [
    // override the bucket boundaries on `my.histogram` to [0, 50, 100]
    {
      aggregation: {
        type: AggregationType.EXPLICIT_BUCKET_HISTOGRAM,
        options: {
          boundaries: [0, 50, 100]
        }
      },
      instrumentName: 'my.histogram'
    },
    // rename 'my.counter' to 'my.renamed.counter'
    { name: 'my.renamed.counter', instrumentName: 'my.counter'}
  ]
})

Example

See examples/prometheus for an end-to-end example, including exporting metrics.

Useful links

License

Apache 2.0 - See LICENSE for more information.

khue-open-telemetry@everything-registry/sub-chunk-690@turnly/observability@braintrust/proxy@powersync/service-core@prairielearn/opentelemetryautonomize-otlp-sdkautonomize-sdk-jsiudexjsexpert-libjohnny-comb-opentelemetry-nodehumanloopinfrastack-interview-fs-bsinfrastack-interview-fs-kainfrastack-interview-fs-mkiinfrastack-sdkhelios-opentelemetry-sdkhealthcheck-testlightstep-opentelemetry-launcher-nodemagic-otelmackerel-exporterlogzio-nodejs-metrics-sdk@webda/otel@totalsoft/metrics@tinybudgie/opentelemetry@vizydrop/tracer@vtex/diagnostics-core@uptrace/node@yellowcab/app-telemetry@zalastax/nolb-_opent@zonneplan/open-telemetry-nest@zonneplan/open-telemetry-node@zonneplan/open-telemetry-zonneplanaccessibility-insights-scanai-proxyatatus-nodejsartillery-plugin-publish-metricsapplicationinsights@google-cloud/bigtable@isartech/chat@dynatrace/opentelemetry-exporter-metrics@graffiticode/tracing@growthbook/proxy@hankts/shopify-cli-kit@aztec/telemetry-client@azure/monitor-opentelemetry-exporter@azure/monitor-opentelemetry@acaad/core@agoric/cosmic-swingset@aiondigital/opentelemetry@agoric/telemetry@agentpaid/ap-node-client@agentuity/sdk@cn-npm/logtrace@codefresh-io/cf-telemetry@comprehend/metrics@contrast/sec-obs@cornie-js/backend-monitoring@crymbo/sdk-logging@conciergus/chat@alerty/core@connexup/logging-next@hasura/ndc-sdk-typescript@fleekxyz/graphql-test@cap-js/telemetry@ceramicnetwork/metrics@ceramicnetwork/observability@bosca/common@boxyhq/metrics@bonniernews/exp-metrics@infinitebrahmanuniverse/nolb-_opent@labdigital/exporter-oltp-sqs@labshare/exporter-prometheus-push@netwerk-digitaal-erfgoed/network-of-terms-query@nahuelsegoviaflux/node-observability@nahuelsegoviaflux/observability@kimitsu/otel-sdk-web@saasquatch/integration-boilerplate-node@salesforcedevs/apmagent@safaricom-mxl/node@sap/opentelemetry-exporter-for-sap-cloud-logging@scegfod/opentelemetry-utils-node-http-proto@pocket-tools/tracing@restsense/agent@security-alliance/opencti-graphqlmw-node-apm-tsmurnitur-otlp-exporteropenlitotel-agent-nodejsotel-carbon-footprintotel-websocket-exporteropentelemetry-nehalrsshubsample-otel-instrumentationnode-red-contrib-opentelemetrynode-red-contrib-opentelemetry-nwwznode-agent-test1node-apm-b3nitro-opentelemetrynew-fe-opentelemetry
2.0.0-rc.1

7 months ago

2.0.1

5 months ago

2.0.0

7 months ago

1.29.0

11 months ago

1.28.0

11 months ago

2.0.0-dev.1

8 months ago

2.0.0-dev.0

8 months ago

1.30.0

10 months ago

1.30.1

9 months ago

1.27.0

12 months ago

1.26.0

1 year ago

1.25.0

1 year ago

1.25.1

1 year ago

1.24.1

1 year ago

1.24.0

1 year ago

1.23.0

2 years ago

1.22.0

2 years ago

1.21.0

2 years ago

1.20.0

2 years ago

1.19.0

2 years ago

1.15.0

2 years ago

1.18.1

2 years ago

1.18.0

2 years ago

1.17.1

2 years ago

1.17.0

2 years ago

1.15.2

2 years ago

1.16.0

2 years ago

1.15.1

2 years ago

1.14.0

2 years ago

1.13.0

2 years ago

1.12.0

3 years ago

1.11.0

3 years ago

1.10.1

3 years ago

1.10.0

3 years ago

1.9.1

3 years ago

1.9.0

3 years ago

1.8.0

3 years ago

0.33.0

3 years ago

0.32.0

3 years ago