Skip to content

Commit

Permalink
chore: update metrics README
Browse files Browse the repository at this point in the history
  • Loading branch information
mayurkale22 committed Nov 25, 2019
1 parent 88fcbd2 commit d4784ad
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions packages/opentelemetry-metrics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![devDependencies][devDependencies-image]][devDependencies-url]
[![Apache License][license-image]][license-image]

`Metric` instruments are the entry point for application and framework developers to instrument their code using `counters`, `gauges`, and `measures`.
OpenTelemetry metrics allow a user to collect data and export it to a metrics backend like [Prometheus](https://prometheus.io/).

## Installation

Expand All @@ -24,13 +24,16 @@ const { Meter } = require('@opentelemetry/metrics');
// Initialize the Meter to capture measurements in various ways.
const meter = new Meter();

const counter = meter.createCounter('metric_name');
const counter = meter.createCounter('metric_name', {
labelKeys: ["pid"],
description: "Example of a counter"
});

const labels = Meter.labels({ pid: process.pid });

// Create a Handle associated with specified label values.
const handle = counter.getHandle(['value1']);
const handle = counter.getHandle(labels);
handle.add(10);

// @todo: add exporter
```

### Gauge
Expand All @@ -42,18 +45,23 @@ const { Meter } = require('@opentelemetry/metrics');
// Initialize the Meter to capture measurements in various ways.
const meter = new Meter();

const gauge = meter.createGauge('metric_name');
const gauge = meter.createGauge('metric_name', {
labelKeys: ["pid"],
description: "Example of a gauge"
});

const labels = Meter.labels({ pid: process.pid });

// Create a Handle associated with specified label values.
const handle = gauge.getHandle(['value1']);
const handle = gauge.getHandle(labels);
handle.set(10); // Set to 10

// @todo: add exporter
```

### Measure
***Work in progress***

See [examples/prometheus](https://github.com/open-telemetry/opentelemetry-js/tree/master/examples/prometheus) for a short example.

## Useful links
- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
Expand All @@ -72,4 +80,4 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js/dev-status.svg?path=packages/opentelemetry-metrics
[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-metrics&type=dev
[npm-url]: https://www.npmjs.com/package/@opentelemetry/metrics
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fmetrics.svg
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fmetrics.svg

0 comments on commit d4784ad

Please sign in to comment.