@saidsef/tracing-node 4.1.0 → 4.1.1

package/README.md

@@ -31,38 +31,27 @@ Effortlessly supercharge your applications with world-class distributed tracing!
 - ...
 - Profit?
 
-## Instalation
+## Where the traces go
 
-```
-npm install @saidsef/tracing-node --save
-```
+`setupTracing` exports OTLP over gRPC, so any OpenTelemetry-compatible collector or backend will take it - point `url` at yours.
+
+If you do not have one yet, [grafana-loki-on-k8s](https://github.com/saidsef/grafana-loki-on-k8s) is a companion project that deploys the full LGTM+ stack - Grafana, Prometheus, Mimir, Loki, Tempo, Pyroscope, Alloy and Beyla - to Kubernetes with `kubectl apply -k ./deployment`, broken into small composable manifests rather than a single opaque chart. Send traces to its Alloy OTLP receiver and they land in Tempo, with the metrics-generator turning them into RED and service-graph metrics in Mimir:
 
-## Upgrading to 4.0.0
+```javascript
+setupTracing({serviceName: 'my-service', url: 'http://alloy:4317'});
+```
 
-**Breaking change: spans now carry the stable OpenTelemetry semantic conventions.**
+The W3C Trace Context propagation this library registers is what lets Tempo pair a caller's client span with the callee's server span, which is what a service graph is built from.
 
-The upstream instrumentations ([open-telemetry/opentelemetry-js-contrib#3585](https://github.com/open-telemetry/opentelemetry-js-contrib/pull/3585)) dropped the legacy attributes and removed the `OTEL_SEMCONV_STABILITY_OPT_IN` escape hatch, so there is no way to keep the old names. The public API of `setupTracing` / `stopTracing` is unchanged - no code changes are required - but any dashboard, alert or processor keyed on the old attribute names must be updated.
+## Instalation
 
-| Removed | Replacement | Affected spans |
-|---------|-------------|----------------|
-| `http.method` | `http.request.method` | HTTP |
-| `http.status_code` | `http.response.status_code` | HTTP, AWS SDK |
-| `http.url` | `url.full` | HTTP |
-| `http.target` | `url.path` + `url.query` | HTTP |
-| `http.scheme` | `url.scheme` | HTTP |
-| `http.user_agent` | `user_agent.original` | HTTP |
-| `http.client_ip` | `client.address` | HTTP |
-| `http.flavor` | `network.protocol.version` | HTTP |
-| `net.peer.name` | `server.address` | HTTP, IORedis |
-| `net.peer.port` | `server.port` | HTTP, IORedis |
-| `db.system` | `db.system.name` | IORedis, DynamoDB |
-| `db.statement` | `db.query.text` | IORedis, DynamoDB |
-| `db.operation` | `db.operation.name` | IORedis, DynamoDB |
-| `db.connection_string` | none | IORedis |
+```
+npm install @saidsef/tracing-node --save
+```
 
-Server-side HTTP metrics also move from `http.server.duration` (milliseconds) to `http.server.request.duration` (seconds), and the client equivalents likewise.
+## Upgrading
 
-`peer.service` is unchanged, so Tempo/Grafana service graphs keep working as before. IORedis spans also gain `db.operation.name`, which distinguishes `MULTI`/`PIPELINE` commands.
+Breaking changes and the attribute renames they bring are recorded in the [release notes](https://github.com/saidsef/tracing-node/releases) for the version concerned.
 
 ## Usage
 
@@ -93,7 +82,7 @@ setupTracing({hostname: 'hostname', serviceName: 'service_name', url: 'endpoint'
 
 ## Source
 
-Our latest and greatest source of `tracing-node` can be found on [GitHub](https://github.com/saidsef/tracing-nodec/fork). Fork us!
+Our latest and greatest source of `tracing-node` can be found on [GitHub](https://github.com/saidsef/tracing-node/fork). Fork us!
 
 ## Contributing
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saidsef/tracing-node",
-  "version": "4.1.0",
+  "version": "4.1.1",
   "description": "tracing NodeJS - Wrapper for OpenTelemetry instrumentation packages",
   "main": "libs/index.mjs",
   "scripts": {