Skip to content

Commit 8daf69a

Browse files
committed
docs: update readme
1 parent 07deb53 commit 8daf69a

2 files changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
- 🏷️ Named caches
2020
- 📖 Well documented + handy JSDoc annotations
2121
- 📊 Events. Useful for monitoring and metrics
22+
- 🧭 OpenTelemetry instrumentation package for distributed tracing
2223
- 📝 Easy Prometheus integration and ready-to-use Grafana dashboard
2324
- 🧩 Easily extendable with your own driver
2425

@@ -129,6 +130,13 @@ bento.on('cache:miss', () => {})
129130

130131
See the [events documentation](https://bentocache.dev/docs/events) for more information.
131132

133+
### OpenTelemetry
134+
135+
Bentocache ships with an official OpenTelemetry package: `@bentocache/otel`.
136+
It lets you instrument cache operations as spans and integrate with any OpenTelemetry-compatible tracing system (Jaeger, Zipkin, Datadog, New Relic, etc.). You can track cache hits, misses, evictions, and more in your distributed tracing setup.
137+
138+
See the [telemetry documentation](https://bentocache.dev/docs/telemetry) for setup and examples.
139+
132140
### Friendly TTLs
133141

134142
All TTLs can be passed in a human-readable string format. We use [lukeed/ms](https://github.com/lukeed/ms) under the hood. (this is optional, and you can pass a `number` in milliseconds if you prefer)

docs/content/docs/introduction.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Bentocache is a robust multi-tier caching library for Node.js applications
1919
- 🏷️ Named caches
2020
- 📖 Well documented + handy JSDoc annotations
2121
- 📊 Events. Useful for monitoring and metrics
22+
- 🧭 OpenTelemetry instrumentation package
2223
- 📝 Easy Prometheus integration and ready-to-use Grafana dashboard
2324
- 🧩 Easily extendable with your own driver
2425

@@ -142,6 +143,13 @@ bento.on('cache:miss', () => {})
142143

143144
See the [events documentation](./digging_deeper/events.md) for more information.
144145

146+
### OpenTelemetry
147+
148+
Bentocache ships with an official OpenTelemetry package: `@bentocache/otel`.
149+
It lets you instrument cache operations as spans and integrate with any OpenTelemetry-compatible tracing system (Jaeger, Zipkin, Datadog, New Relic, etc.). You can track cache hits, misses, evictions, and more in your distributed tracing setup.
150+
151+
See the [telemetry documentation](./telemetry.md) for setup and examples.
152+
145153
### Friendly TTLs
146154

147155
All TTLs can be passed in a human-readable string format. We use [lukeed/ms](https://github.com/lukeed/ms) under the hood. (this is optional, and you can pass a `number` in milliseconds if you prefer)

0 commit comments

Comments
 (0)