# @ceramicnetwork/observability

> Typescript library for instrumenting ceramic networks

Latest version **1.5.7** (published 2024-08-02) · (Apache-2.0 OR MIT) license · 0 weekly downloads

## Install

```sh
npm install @ceramicnetwork/observability
pnpm add @ceramicnetwork/observability
yarn add @ceramicnetwork/observability
bun add @ceramicnetwork/observability
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.7 |
| Published | 2024-08-02 |
| First published | 2022-11-11 |
| Weekly downloads | 0 |
| License | (Apache-2.0 OR MIT) |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 9 |
| Unpacked size | 19.6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Golda Velez |
| Maintainers | dav1do, ceramic-velvetshark, cb3box, jpham2023, npm.3box, smrz2001, oed, paul_lecam, stbrody, ukstv |
| Keywords | Metrics, instrumentation, OTLP |

## Links

- npm: https://www.npmjs.com/package/@ceramicnetwork/observability
- Repository: https://github.com/ceramicnetwork/observability
- Homepage: https://github.com/ceramicnetwork/observability#readme
- Issues: https://github.com/ceramicnetwork/observability/issues
- npm.io page: https://npm.io/package/@ceramicnetwork/observability

## Dependencies (9)

- [@types/node](https://npm.io/package/@types/node.md) ^20.11.16
- [@opentelemetry/api](https://npm.io/package/@opentelemetry/api.md) ^1.8.0
- [@opentelemetry/resources](https://npm.io/package/@opentelemetry/resources.md) ^1.23.0
- [@opentelemetry/sdk-metrics](https://npm.io/package/@opentelemetry/sdk-metrics.md) ^1.23.0
- [@opentelemetry/sdk-trace-base](https://npm.io/package/@opentelemetry/sdk-trace-base.md) ^1.23.0
- [@opentelemetry/exporter-prometheus](https://npm.io/package/@opentelemetry/exporter-prometheus.md) ^0.50.0
- [@opentelemetry/semantic-conventions](https://npm.io/package/@opentelemetry/semantic-conventions.md) ^1.23.0
- [@opentelemetry/exporter-trace-otlp-http](https://npm.io/package/@opentelemetry/exporter-trace-otlp-http.md) ^0.50.0
- [@opentelemetry/exporter-metrics-otlp-http](https://npm.io/package/@opentelemetry/exporter-metrics-otlp-http.md) ^0.50.0

## Recent versions

- 1.5.7 (latest) — 2024-08-02
- 1.5.6 — 2024-05-17
- 1.5.5 — 2024-05-15
- 1.5.4 — 2024-05-01
- 1.5.3 — 2024-05-01
- 1.5.2 — 2024-04-30
- 1.5.1 — 2024-04-27
- 1.5.0 — 2024-04-22
- 1.4.7 — 2024-04-19
- 1.4.6 — 2024-04-19
- 1.4.5 — 2024-04-19
- 1.4.4 — 2024-02-03
- 1.4.3 — 2024-02-03
- 1.4.2 — 2023-07-27
- 1.4.1 — 2023-07-10
- … 14 more at https://npm.io/package/@ceramicnetwork/observability/versions

## README

# Service Metrics

Exports metrics and traces to OTLP-compatible collector

 ## Purpose

Provides an interface for recording metrics and traces.

## Installation

```sh
npm install @ceramicnetwork/observability
```

## Usage

Import the class, start the metrics service and record metrics.

NOTE that an OTLP collector host must be provided or the functions will not be operative.

```ts
import { Metrics } from '@ceramicnetwork/observability'

```


## Configuration

Configuration settings should be passed to the `start` function which instantiates the metrics singleton instance.

```ts

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