Skip to content

Commit

Permalink
chore: remove old metrics sdk
Browse files Browse the repository at this point in the history
  • Loading branch information
@dyladan
dyladan committed Nov 11, 2021
1 parent 0bc25fa commit 70b12dc
Show file tree
Hide file tree
Showing 32 changed files with 20 additions and 3,715 deletions.
182 changes: 8 additions & 174 deletions experimental/packages/opentelemetry-sdk-metrics-base/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,187 +7,21 @@

OpenTelemetry metrics allow a user to collect data and export it to a metrics backend like [Prometheus](https://prometheus.io/).

## Work In Progress

The OpenTelemetry SDK in this directory is undergoing drastic changes. If you need to use metrics, we recommend you use [version `0.27.0`](https://github.com/open-telemetry/opentelemetry-js/tree/v0.27.0/experimental/packages/opentelemetry-sdk-metrics-base).

## Installation

```bash
npm install --save @opentelemetry/sdk-metrics-base
npm install --save "@opentelemetry/sdk-metrics-base@~0.27.0"
```

## Usage

### Counter

Choose this kind of metric when the value is a quantity, the sum is of primary interest, and the event count and value distribution are not of primary interest. It is restricted to non-negative increments.
Example uses for Counter:

- count the number of bytes received
- count the number of requests completed
- count the number of accounts created
- count the number of checkpoints run
- count the number of 5xx errors.

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

// Initialize the Meter to capture measurements in various ways.
const meter = new MeterProvider().getMeter('your-meter-name');

const counter = meter.createCounter('metric_name', {
description: 'Example of a counter'
});

const attributes = { pid: process.pid };
counter.add(10, attributes);
```

### UpDownCounter

`UpDownCounter` is similar to `Counter` except that it supports negative increments. It is generally useful for capturing changes in an amount of resources used, or any quantity that rises and falls during a request.

Example uses for UpDownCounter:

- count the number of active requests
- count memory in use by instrumenting new and delete
- count queue size by instrumenting enqueue and dequeue
- count semaphore up and down operations

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

// Initialize the Meter to capture measurements in various ways.
const meter = new MeterProvider().getMeter('your-meter-name');

const counter = meter.createUpDownCounter('metric_name', {
description: 'Example of a UpDownCounter'
});

const attributes = { pid: process.pid };
counter.add(Math.random() > 0.5 ? 1 : -1, attributes);
```

### Observable Gauge

Choose this kind of metric when only last value is important without worry about aggregation.
The callback can be sync or async.

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

const meter = new MeterProvider().getMeter('your-meter-name');


// async callback - for operation that needs to wait for value
meter.createObservableGauge('your_metric_name', {
description: 'Example of an async observable gauge with callback',
}, async (observableResult) => {
const value = await getAsyncValue();
observableResult.observe(value, { attribute: '1' });
});

function getAsyncValue() {
return new Promise((resolve) => {
setTimeout(()=> {
resolve(Math.random());
}, 100);
});
}

// sync callback in case you don't need to wait for value
meter.createObservableGauge('your_metric_name', {
description: 'Example of a sync observable gauge with callback',
}, (observableResult) => {
observableResult.observe(getRandomValue(), { attribute: '1' });
observableResult.observe(getRandomValue(), { attribute: '2' });
});

function getRandomValue() {
return Math.random();
}
```

### ObservableUpDownCounter

Choose this kind of metric when sum is important and you want to capture any value that starts at zero and rises or falls throughout the process lifetime.
The callback can be sync or async.

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

const meter = new MeterProvider().getMeter('your-meter-name');

// async callback - for operation that needs to wait for value
meter.createObservableUpDownCounter('your_metric_name', {
description: 'Example of an async observable up down counter with callback',
}, async (observableResult) => {
const value = await getAsyncValue();
observableResult.observe(value, { attribute: '1' });
});

function getAsyncValue() {
return new Promise((resolve) => {
setTimeout(()=> {
resolve(Math.random());
}, 100);
});
}

// sync callback in case you don't need to wait for value
meter.createObservableUpDownCounter('your_metric_name', {
description: 'Example of a sync observable up down counter with callback',
}, (observableResult) => {
observableResult.observe(getRandomValue(), { attribute: '1' });
});

function getRandomValue() {
return Math.random();
}

```

### Observable Counter

Choose this kind of metric when collecting a sum that never decreases.
The callback can be sync or async.

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

const meter = new MeterProvider().getMeter('your-meter-name');

// async callback in case you need to wait for values
meter.createObservableCounter('example_metric', {
description: 'Example of an async observable counter with callback',
}, async (observableResult) => {
const value = await getAsyncValue();
observableResult.observe(value, { attribute: '1' });
});

function getAsyncValue() {
return new Promise((resolve) => {
setTimeout(() => {
resolve(Math.random());
}, 100)
});
}

// sync callback in case you don't need to wait for values
meter.createObservableCounter('example_metric', {
description: 'Example of a sync observable counter with callback',
}, (observableResult) => {
const value = getRandomValue();
observableResult.observe(value, { attribute: '1' });
});

function getRandomValue() {
return Math.random();
}
```

### Histogram
Please see the [version `0.27.0` README](https://github.com/open-telemetry/opentelemetry-js/tree/v0.27.0/experimental/packages/opentelemetry-sdk-metrics-base#usage).

`Histogram` is a non-additive synchronous instrument useful for recording any non-additive number, positive or negative.
Values captured by `Histogram.record(value)` are treated as individual events belonging to a distribution that is being summarized.
`Histogram` should be chosen either when capturing measurements that do not contribute meaningfully to a sum, or when capturing numbers that are additive in nature, but where the distribution of individual increments is considered interesting.
TODO: Add usage information for updated SDK

## Useful links

Expand All @@ -207,4 +41,4 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js.svg?path=packages%2Fopentelemetry-sdk-metrics-base&type=dev
[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-sdk-metrics-base&type=dev
[npm-url]: https://www.npmjs.com/package/@opentelemetry/sdk-metrics-base
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fsdk-metrics-base.svg
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fmetrics.svg
15 changes: 8 additions & 7 deletions experimental/packages/opentelemetry-sdk-metrics-base/package.json
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{
"name": "@opentelemetry/sdk-metrics-base",
"version": "0.27.0",
"description": "OpenTelemetry metrics SDK",
"name": "@opentelemetry/sdk-metrics-base-wip",
"version": "0.26.0",
"private": true,
"description": "Work in progress OpenTelemetry metrics SDK",
"main": "build/src/index.js",
"module": "build/esm/index.js",
"types": "build/src/index.d.ts",
Expand Down Expand Up @@ -55,17 +56,17 @@
"mocha": "7.2.0",
"nyc": "15.1.0",
"rimraf": "3.0.2",
"sinon": "12.0.1",
"sinon": "11.1.2",
"ts-mocha": "8.0.0",
"typescript": "4.3.5"
},
"peerDependencies": {
"@opentelemetry/api": "^1.0.0"
},
"dependencies": {
"@opentelemetry/api-metrics": "0.27.0",
"@opentelemetry/core": "1.0.1",
"@opentelemetry/resources": "1.0.1",
"@opentelemetry/api-metrics": "0.26.0",
"@opentelemetry/core": "1.0.0",
"@opentelemetry/resources": "1.0.0",
"lodash.merge": "^4.6.2"
}
}
149 changes: 0 additions & 149 deletions experimental/packages/opentelemetry-sdk-metrics-base/src/BoundInstrument.ts
View file

This file was deleted.

Loading

0 comments on commit 70b12dc

Please sign in to comment.