Skip to content

Commit

Permalink
chore(docs): add to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
djMax committed Oct 13, 2023
1 parent 5448bf8 commit b196c40
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@

A modernized set of node metrics for OpenTelemetry. Based on two excellent modules:

* [Marc Bachmann's opentelemetry-node-metrics](https://github.com/marcbachmann/opentelemetry-node-metrics)
* [Simon Nyberg's prom-client](https://github.com/siimon/prom-client)
- [Marc Bachmann's opentelemetry-node-metrics](https://github.com/marcbachmann/opentelemetry-node-metrics)
- [Simon Nyberg's prom-client](https://github.com/siimon/prom-client)

Usage:

```sh
yarn add @sesamecare-oss/opentelemetry-node-metrics
```
Expand All @@ -21,3 +22,5 @@ setupNodeMetrics(meter);
```

Now your Prometheus-exported metrics should be included along with whatever other metrics you ahve selected. See [openapi-typescript-infra/service](https://github.com/openapi-typescript-infra/service) for a more complete example of metrics integrated with an express service host.

One notable change from the existing libraries - they divide active handles and active 'requests' using deprecated Node APIs. I've chosed to merge these into 'resources' using the new getActiveResourcesInfo API, which is Node17+. It should fail gracefully if that function is not available.

0 comments on commit b196c40

Please sign in to comment.