@saidsef/tracing-node 5.0.1 → 6.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -1
- package/deployment/base/job.yml +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
Full documentation: [tracing-node.readthedocs.io](https://tracing-node.readthedocs.io/).
|
|
16
16
|
|
|
17
17
|
## Prerequisites
|
|
18
|
-
- NodeJS
|
|
18
|
+
- NodeJS >= 24.0.0
|
|
19
19
|
- Observability
|
|
20
20
|
- ...
|
|
21
21
|
- Profit?
|
|
@@ -36,6 +36,19 @@ setupTracing({hostname: 'hostname', serviceName: 'service_name', url: 'endpoint'
|
|
|
36
36
|
|
|
37
37
|
`serviceName` and `url` are required, and both fall back to the `SERVICE_NAME` and `ENDPOINT` environment variables. `setupTracing` has to run before the application imports the libraries being traced.
|
|
38
38
|
|
|
39
|
+
## Collector and backend
|
|
40
|
+
|
|
41
|
+
The exporter speaks OTLP over gRPC, so any OpenTelemetry-compatible collector accepts all three signals. Point `url` at yours.
|
|
42
|
+
|
|
43
|
+
[**grafana-loki-on-k8s**](https://github.com/saidsef/grafana-loki-on-k8s) is the companion stack, and the one the end to end harness in [`test/e2e/`](./test/e2e) targets. It deploys Grafana, Prometheus, Mimir, Loki, Tempo, Pyroscope, Alloy and Beyla to Kubernetes as small composable manifests.
|
|
44
|
+
|
|
45
|
+
```shell
|
|
46
|
+
git clone https://github.com/saidsef/grafana-loki-on-k8s
|
|
47
|
+
kubectl apply -k grafana-loki-on-k8s/deployment
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Traces sent to its Alloy OTLP receiver on port 4317 land in Tempo, log records in Loki and metrics in Mimir. Tempo's metrics generator turns the spans into RED and service graph metrics, which is what the `peer.service` attribute this library sets exists to feed.
|
|
51
|
+
|
|
39
52
|
## Documentation
|
|
40
53
|
|
|
41
54
|
The pages below are the manual. Their sources are in [`docs/`](./docs), and `npm run build-docs` renders the site into `site/`.
|
package/deployment/base/job.yml
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@saidsef/tracing-node",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "6.0.0",
|
|
4
4
|
"description": "tracing NodeJS - Wrapper for OpenTelemetry instrumentation packages",
|
|
5
5
|
"main": "libs/index.mjs",
|
|
6
6
|
"scripts": {
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
"author": "Said Sef <saidsef@gmail.com>",
|
|
26
26
|
"license": "Apache-2.0",
|
|
27
27
|
"engines": {
|
|
28
|
-
"node": ">=
|
|
28
|
+
"node": ">= 24.0.0"
|
|
29
29
|
},
|
|
30
30
|
"bugs": {
|
|
31
31
|
"url": "https://github.com/saidsef/tracing-node/issues"
|