@saidsef/tracing-node 4.1.1 → 4.2.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.
Files changed (2) hide show
  1. package/README.md +17 -0
  2. package/package.json +22 -20
package/README.md CHANGED
@@ -80,6 +80,23 @@ setupTracing({hostname: 'hostname', serviceName: 'service_name', url: 'endpoint'
80
80
  | enableFsInstrumentation | boolean | enable FS instrumentation | No | `false` |
81
81
  | enableDnsInstrumentation | boolean | enable DNS instrumentation | No | `false` |
82
82
 
83
+ ## Documentation
84
+
85
+ Full documentation is in the [`docs/`](./docs) directory and built with [MkDocs Material](https://squidfunk.github.io/mkdocs-material/).
86
+
87
+ Live docs: [tracing-node.readthedocs.io](https://tracing-node.readthedocs.io/)
88
+
89
+ | Page | Contents |
90
+ |------|----------|
91
+ | [Architecture](./docs/architecture.md) | The pipeline `setupTracing` builds, and how the service graph is fed |
92
+ | [Configuration](./docs/usage.md) | Options, environment variables, initialisation order and shutdown |
93
+ | [Instrumentation](./docs/instrumentation.md) | Each instrumentation, and the attributes it emits |
94
+ | [Deployment](./docs/deployment.md) | Running instrumented services in containers and Kubernetes |
95
+ | [Testing](./docs/testing.md) | The unit tests and the end to end harness |
96
+ | [Troubleshooting](./docs/troubleshooting.md) | Symptoms, causes and fixes |
97
+
98
+ Build them locally with `npm run build-docs`, which renders the site into `site/`.
99
+
83
100
  ## Source
84
101
 
85
102
  Our latest and greatest source of `tracing-node` can be found on [GitHub](https://github.com/saidsef/tracing-node/fork). Fork us!
package/package.json CHANGED
@@ -1,12 +1,14 @@
1
1
  {
2
2
  "name": "@saidsef/tracing-node",
3
- "version": "4.1.1",
3
+ "version": "4.2.0",
4
4
  "description": "tracing NodeJS - Wrapper for OpenTelemetry instrumentation packages",
5
5
  "main": "libs/index.mjs",
6
6
  "scripts": {
7
7
  "test": "node --trace-warnings --test --report-uncaught-exception libs/index.test.mjs",
8
8
  "lint": "eslint .",
9
- "rebuild": "rm -rfv node_modules/ package-lock.json && npm install --prod --omit=dev"
9
+ "rebuild": "rm -rfv node_modules/ package-lock.json && npm install --prod --omit=dev",
10
+ "build-docs": "podman run --rm -v .:/docs docker.io/squidfunk/mkdocs-material:9 build",
11
+ "clean-docs": "rm -rf site"
10
12
  },
11
13
  "type": "module",
12
14
  "private": false,
@@ -30,32 +32,32 @@
30
32
  },
31
33
  "homepage": "https://github.com/saidsef/tracing-node#readme",
32
34
  "dependencies": {
33
- "@opentelemetry/api": "^1.9.0",
34
- "@opentelemetry/exporter-trace-otlp-grpc": "^0.221.0",
35
- "@opentelemetry/instrumentation": "^0.221.0",
36
- "@opentelemetry/instrumentation-aws-sdk": "^0.76.0",
37
- "@opentelemetry/instrumentation-connect": "^0.64.0",
38
- "@opentelemetry/instrumentation-dns": "^0.64.0",
39
- "@opentelemetry/instrumentation-express": "^0.69.0",
40
- "@opentelemetry/instrumentation-fs": "^0.40.0",
41
- "@opentelemetry/instrumentation-http": "^0.221.0",
42
- "@opentelemetry/instrumentation-ioredis": "^0.69.0",
43
- "@opentelemetry/instrumentation-pino": "^0.67.0",
44
- "@opentelemetry/instrumentation-undici": "^0.31.0",
45
- "@opentelemetry/resources": "^2.10.0",
46
- "@opentelemetry/sdk-trace-base": "^2.10.0",
47
- "@opentelemetry/sdk-trace-node": "^2.10.0",
35
+ "@opentelemetry/api": "^1.9.1",
36
+ "@opentelemetry/exporter-trace-otlp-grpc": "^0.222.0",
37
+ "@opentelemetry/instrumentation": "^0.222.0",
38
+ "@opentelemetry/instrumentation-aws-sdk": "^0.77.0",
39
+ "@opentelemetry/instrumentation-connect": "^0.65.0",
40
+ "@opentelemetry/instrumentation-dns": "^0.65.0",
41
+ "@opentelemetry/instrumentation-express": "^0.70.0",
42
+ "@opentelemetry/instrumentation-fs": "^0.41.0",
43
+ "@opentelemetry/instrumentation-http": "^0.222.0",
44
+ "@opentelemetry/instrumentation-ioredis": "^0.70.0",
45
+ "@opentelemetry/instrumentation-pino": "^0.68.0",
46
+ "@opentelemetry/instrumentation-undici": "^0.32.0",
47
+ "@opentelemetry/resources": "^2.11.0",
48
+ "@opentelemetry/sdk-trace-base": "^2.11.0",
49
+ "@opentelemetry/sdk-trace-node": "^2.11.0",
48
50
  "@opentelemetry/semantic-conventions": "^1.43.0",
49
51
  "opentelemetry-instrumentation-elasticsearch": "^0.41.0"
50
52
  },
51
53
  "devDependencies": {
52
- "eslint": "^10.8.0"
54
+ "eslint": "^10.10.0"
53
55
  },
54
56
  "overrides": {
55
57
  "protobufjs": "^7.5.3",
56
- "@opentelemetry/core": "^2.10.0"
58
+ "@opentelemetry/core": "^2.11.0"
57
59
  },
58
60
  "allowScripts": {
59
- "protobufjs@7.6.5": true
61
+ "protobufjs@7.6.6": true
60
62
  }
61
63
  }