# @opentelemetry/sdk-metrics-base

> Work in progress OpenTelemetry metrics SDK

Latest version **0.31.0** (published 2022-07-26) · Apache-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @opentelemetry/sdk-metrics-base
pnpm add @opentelemetry/sdk-metrics-base
yarn add @opentelemetry/sdk-metrics-base
bun add @opentelemetry/sdk-metrics-base
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.31.0 |
| Published | 2022-07-26 |
| First published | 2021-08-05 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=14 |
| Dependencies | 4 |
| Unpacked size | 1.3 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3473 |
| Author | OpenTelemetry Authors |
| Maintainers | bogdandrutu, dyladan |
| Keywords | opentelemetry, nodejs, metrics, stats, profiling |

## Links

- npm: https://www.npmjs.com/package/@opentelemetry/sdk-metrics-base
- Repository: https://github.com/open-telemetry/opentelemetry-js
- Homepage: https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-sdk-metrics-base
- Issues: https://github.com/open-telemetry/opentelemetry-js/issues
- npm.io page: https://npm.io/package/@opentelemetry/sdk-metrics-base

## Dependencies (4)

- [lodash.merge](https://npm.io/package/lodash.merge.md) 4.6.2
- [@opentelemetry/core](https://npm.io/package/@opentelemetry/core.md) 1.5.0
- [@opentelemetry/resources](https://npm.io/package/@opentelemetry/resources.md) 1.5.0
- [@opentelemetry/api-metrics](https://npm.io/package/@opentelemetry/api-metrics.md) 0.31.0

## Recent versions

- 0.31.0 (latest) — 2022-07-26
- 0.28.0 (next) — 2022-04-25
- 0.25.1-alpha.23 (canary) — 2021-09-08
- 0.30.0 — 2022-07-06
- 0.29.2 — 2022-06-06
- 0.29.1 — 2022-06-01
- 0.29.0 — 2022-05-27
- 0.27.0 — 2021-11-11
- 0.26.0 — 2021-10-05
- 0.25.1-alpha.13 — 2021-08-30
- 0.25.1-alpha.12 — 2021-08-30
- 0.25.1-alpha.4 — 2021-08-24
- 0.25.1-alpha.2 — 2021-08-23
- 0.25.0 — 2021-08-18
- 0.25.1-alpha.21 — 2021-08-18
- … 7 more at https://npm.io/package/@opentelemetry/sdk-metrics-base/versions

## README

# OpenTelemetry Metrics SDK

[![NPM Published Version][npm-img]][npm-url]
[![Apache License][license-image]][license-image]

OpenTelemetry metrics module contains the foundation for all metrics SDKs of [opentelemetry-js](https://github.com/open-telemetry/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

```bash
npm install --save @opentelemetry/api-metrics
npm install --save @opentelemetry/sdk-metrics-base
```

## Usage

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

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

// 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.setGlobalMeterProvider(new MeterProvider());

// To record a metric event, we used the global singleton meter to create an instrument.
const counter = opentelemetry.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:

```js
// Creating an async instrument, similar to synchronous instruments
const observableCounter = opentelemetry.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.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`:

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

## Example

See [examples/prometheus](https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/examples/prometheus) for an end-to-end example, including exporting metrics.

## 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][discussions-url]

## License

Apache 2.0 - See [LICENSE][license-url] for more information.

[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/main/LICENSE
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@opentelemetry/sdk-metrics-base
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fmetrics.svg

---
_Source: https://npm.io/package/@opentelemetry/sdk-metrics-base · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._