@edirect/trace 11.0.39 → 11.0.41

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 (4) hide show
  1. package/README.md +41 -5
  2. package/dist/README.md +41 -5
  3. package/dist/package.json +12 -12
  4. package/package.json +16 -17
package/README.md CHANGED
@@ -1,4 +1,10 @@
1
- # Open Telemetry Trace
1
+ # @edirect/trace
2
+
3
+ **DEPRECATED! Stop Using it!**
4
+
5
+ `@edirect/trace` provides OpenTelemetry-based distributed tracing for Node.js, NestJS, Express, and NextJS applications in the Bolttech ecosystem. It enables deep visibility into business flows, exceptions, and service interactions, supporting both automatic and manual instrumentation.
6
+
7
+ ---
2
8
 
3
9
  ## Background
4
10
 
@@ -46,7 +52,7 @@ Taking the requirements in consideration, the proposed solutions employs an appl
46
52
  - [Service Visibility Frontend](https://bitbucket.org/gofrank/service-visibility-frontend/src/main/)
47
53
  - [Service Visibility Backend](https://bitbucket.org/gofrank/service-visibility-backend/src/main/)
48
54
 
49
- ## Sample application
55
+ ## Sample Application
50
56
 
51
57
  - [Service Visibility Samples](https://bitbucket.org/gofrank/service-visibility-samples/src/master/)
52
58
  1. Expressjs Sample
@@ -96,7 +102,7 @@ NestJs applications **should be upgraded to version 9.**
96
102
  const apm = new APM(
97
103
  apmConfig.service,
98
104
  apmConfig.url,
99
- apmConfig.traceServer,
105
+ apmConfig.traceServer
100
106
  );
101
107
  apm.startTrace();
102
108
  }
@@ -252,7 +258,7 @@ NextJS applications **should be upgraded to version 12 or above**.
252
258
  const apm = new APM(
253
259
  apmConfig.service,
254
260
  apmConfig.url,
255
- apmConfig.traceServer,
261
+ apmConfig.traceServer
256
262
  );
257
263
  apm.startTrace();
258
264
  }
@@ -276,7 +282,37 @@ NextJS applications **should be upgraded to version 12 or above**.
276
282
  app.use(new traceMiddlewares.Body().body);
277
283
  ```
278
284
 
279
- ## Applying k8s configurations (Required)
285
+ ## Configuration & Environment Variables
286
+
287
+ `@edirect/trace` relies on several environment variables for correct operation. These are typically set in your deployment environment or `.env` files:
288
+
289
+ - `TRACE_TAG_OWNER` (string): Owner of the service
290
+ - `TRACE_TAG_SCOPE` (string): Tech center or scope
291
+ - `TRACE_TAG_SERVICENAME` (string): Service name
292
+ - `TRACE_TAG_TENANT` (string): Tenant or namespace
293
+ - `TRACE_SERVER_URL` (string): OpenTelemetry collector URL
294
+ - `TRACE_TAG_SERVICE` (string): Service identifier
295
+ - `TRACE_TAG_VERSION` (string): Service version
296
+ - `TRACE_TAG_CLUSTER` (string): Cluster name
297
+ - `TRACE_TAG_ENV` (string): Environment (e.g., development, staging, production)
298
+
299
+ **Example .env:**
300
+
301
+ ```env
302
+ TRACE_TAG_OWNER=OWNER
303
+ TRACE_TAG_SCOPE=pgw
304
+ TRACE_TAG_SERVICENAME=payment-gateway
305
+ TRACE_TAG_TENANT=local-paythbroker
306
+ TRACE_SERVER_URL=opentelemetry-collector.stag.bolttechpay.net
307
+ TRACE_TAG_SERVICE=payment-gateway-local-paythbroker
308
+ TRACE_TAG_VERSION=1.0.0
309
+ TRACE_TAG_CLUSTER=localhost
310
+ TRACE_TAG_ENV=development
311
+ ```
312
+
313
+ **Note:** Never commit sensitive credentials to version control. Use environment variables or secure secrets management.
314
+
315
+ ---
280
316
 
281
317
  We created a standard way to deploy our application configurations and simplify its configurations:
282
318
 
package/dist/README.md CHANGED
@@ -1,4 +1,10 @@
1
- # Open Telemetry Trace
1
+ # @edirect/trace
2
+
3
+ **DEPRECATED! Stop Using it!**
4
+
5
+ `@edirect/trace` provides OpenTelemetry-based distributed tracing for Node.js, NestJS, Express, and NextJS applications in the Bolttech ecosystem. It enables deep visibility into business flows, exceptions, and service interactions, supporting both automatic and manual instrumentation.
6
+
7
+ ---
2
8
 
3
9
  ## Background
4
10
 
@@ -46,7 +52,7 @@ Taking the requirements in consideration, the proposed solutions employs an appl
46
52
  - [Service Visibility Frontend](https://bitbucket.org/gofrank/service-visibility-frontend/src/main/)
47
53
  - [Service Visibility Backend](https://bitbucket.org/gofrank/service-visibility-backend/src/main/)
48
54
 
49
- ## Sample application
55
+ ## Sample Application
50
56
 
51
57
  - [Service Visibility Samples](https://bitbucket.org/gofrank/service-visibility-samples/src/master/)
52
58
  1. Expressjs Sample
@@ -96,7 +102,7 @@ NestJs applications **should be upgraded to version 9.**
96
102
  const apm = new APM(
97
103
  apmConfig.service,
98
104
  apmConfig.url,
99
- apmConfig.traceServer,
105
+ apmConfig.traceServer
100
106
  );
101
107
  apm.startTrace();
102
108
  }
@@ -252,7 +258,7 @@ NextJS applications **should be upgraded to version 12 or above**.
252
258
  const apm = new APM(
253
259
  apmConfig.service,
254
260
  apmConfig.url,
255
- apmConfig.traceServer,
261
+ apmConfig.traceServer
256
262
  );
257
263
  apm.startTrace();
258
264
  }
@@ -276,7 +282,37 @@ NextJS applications **should be upgraded to version 12 or above**.
276
282
  app.use(new traceMiddlewares.Body().body);
277
283
  ```
278
284
 
279
- ## Applying k8s configurations (Required)
285
+ ## Configuration & Environment Variables
286
+
287
+ `@edirect/trace` relies on several environment variables for correct operation. These are typically set in your deployment environment or `.env` files:
288
+
289
+ - `TRACE_TAG_OWNER` (string): Owner of the service
290
+ - `TRACE_TAG_SCOPE` (string): Tech center or scope
291
+ - `TRACE_TAG_SERVICENAME` (string): Service name
292
+ - `TRACE_TAG_TENANT` (string): Tenant or namespace
293
+ - `TRACE_SERVER_URL` (string): OpenTelemetry collector URL
294
+ - `TRACE_TAG_SERVICE` (string): Service identifier
295
+ - `TRACE_TAG_VERSION` (string): Service version
296
+ - `TRACE_TAG_CLUSTER` (string): Cluster name
297
+ - `TRACE_TAG_ENV` (string): Environment (e.g., development, staging, production)
298
+
299
+ **Example .env:**
300
+
301
+ ```env
302
+ TRACE_TAG_OWNER=OWNER
303
+ TRACE_TAG_SCOPE=pgw
304
+ TRACE_TAG_SERVICENAME=payment-gateway
305
+ TRACE_TAG_TENANT=local-paythbroker
306
+ TRACE_SERVER_URL=opentelemetry-collector.stag.bolttechpay.net
307
+ TRACE_TAG_SERVICE=payment-gateway-local-paythbroker
308
+ TRACE_TAG_VERSION=1.0.0
309
+ TRACE_TAG_CLUSTER=localhost
310
+ TRACE_TAG_ENV=development
311
+ ```
312
+
313
+ **Note:** Never commit sensitive credentials to version control. Use environment variables or secure secrets management.
314
+
315
+ ---
280
316
 
281
317
  We created a standard way to deploy our application configurations and simplify its configurations:
282
318
 
package/dist/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@edirect/trace",
3
- "version": "11.0.39",
3
+ "version": "11.0.40",
4
4
  "description": "Edirect trace",
5
5
  "main": "./dist/src/index.js",
6
6
  "types": "./dist/src/index.d.ts",
@@ -20,16 +20,16 @@
20
20
  "license": "ISC",
21
21
  "dependencies": {
22
22
  "@opentelemetry/api": "^1.9.0",
23
- "@opentelemetry/auto-instrumentations-node": "^0.67.3",
24
- "@opentelemetry/exporter-trace-otlp-http": "^0.208.0",
25
- "@opentelemetry/instrumentation": "^0.208.0",
26
- "@opentelemetry/instrumentation-express": "^0.57.1",
27
- "@opentelemetry/instrumentation-http": "^0.208.0",
28
- "@opentelemetry/resources": "^2.2.0",
29
- "@opentelemetry/sdk-node": "^0.208.0",
30
- "@opentelemetry/sdk-trace-base": "^2.2.0",
31
- "@opentelemetry/sdk-trace-node": "^2.2.0",
32
- "@opentelemetry/semantic-conventions": "^1.38.0",
23
+ "@opentelemetry/auto-instrumentations-node": "^0.69.0",
24
+ "@opentelemetry/exporter-trace-otlp-http": "^0.211.0",
25
+ "@opentelemetry/instrumentation": "^0.211.0",
26
+ "@opentelemetry/instrumentation-express": "^0.59.0",
27
+ "@opentelemetry/instrumentation-http": "^0.211.0",
28
+ "@opentelemetry/resources": "^2.5.0",
29
+ "@opentelemetry/sdk-node": "^0.211.0",
30
+ "@opentelemetry/sdk-trace-base": "^2.5.0",
31
+ "@opentelemetry/sdk-trace-node": "^2.5.0",
32
+ "@opentelemetry/semantic-conventions": "^1.39.0",
33
33
  "cls-hooked": "^4.2.2",
34
34
  "express-mung": "^0.5.1",
35
35
  "reflect-metadata": "^0.2.2",
@@ -37,7 +37,7 @@
37
37
  },
38
38
  "devDependencies": {
39
39
  "@types/express": "^5.0.6",
40
- "@types/node": "^25.0.3",
40
+ "@types/node": "^25.0.10",
41
41
  "typescript": "^5.9.3"
42
42
  },
43
43
  "type": "commonjs"
package/package.json CHANGED
@@ -1,13 +1,12 @@
1
1
  {
2
2
  "name": "@edirect/trace",
3
- "version": "11.0.39",
3
+ "version": "11.0.41",
4
4
  "description": "Edirect trace",
5
5
  "packageScope": "@edirect",
6
6
  "main": "./dist/src/index.js",
7
7
  "types": "./dist/src/index.d.ts",
8
8
  "exports": {
9
9
  ".": {
10
- "development": "./src/index.ts",
11
10
  "import": "./dist/src/index.js",
12
11
  "default": "./dist/src/index.js",
13
12
  "require": "./dist/src/index.js",
@@ -22,16 +21,16 @@
22
21
  "license": "ISC",
23
22
  "dependencies": {
24
23
  "@opentelemetry/api": "^1.9.0",
25
- "@opentelemetry/auto-instrumentations-node": "^0.67.3",
26
- "@opentelemetry/exporter-trace-otlp-http": "^0.208.0",
27
- "@opentelemetry/instrumentation": "^0.208.0",
28
- "@opentelemetry/instrumentation-express": "^0.57.1",
29
- "@opentelemetry/instrumentation-http": "^0.208.0",
30
- "@opentelemetry/resources": "^2.2.0",
31
- "@opentelemetry/sdk-node": "^0.208.0",
32
- "@opentelemetry/sdk-trace-base": "^2.2.0",
33
- "@opentelemetry/sdk-trace-node": "^2.2.0",
34
- "@opentelemetry/semantic-conventions": "^1.38.0",
24
+ "@opentelemetry/auto-instrumentations-node": "^0.69.0",
25
+ "@opentelemetry/exporter-trace-otlp-http": "^0.211.0",
26
+ "@opentelemetry/instrumentation": "^0.211.0",
27
+ "@opentelemetry/instrumentation-express": "^0.59.0",
28
+ "@opentelemetry/instrumentation-http": "^0.211.0",
29
+ "@opentelemetry/resources": "^2.5.0",
30
+ "@opentelemetry/sdk-node": "^0.211.0",
31
+ "@opentelemetry/sdk-trace-base": "^2.5.0",
32
+ "@opentelemetry/sdk-trace-node": "^2.5.0",
33
+ "@opentelemetry/semantic-conventions": "^1.39.0",
35
34
  "cls-hooked": "^4.2.2",
36
35
  "express-mung": "^0.5.1",
37
36
  "reflect-metadata": "^0.2.2",
@@ -39,14 +38,14 @@
39
38
  },
40
39
  "devDependencies": {
41
40
  "@types/express": "^5.0.6",
42
- "@types/node": "^25.0.3",
43
- "@typescript-eslint/eslint-plugin": "^8.52.0",
44
- "@typescript-eslint/parser": "^8.52.0",
41
+ "@types/node": "^25.0.10",
42
+ "@typescript-eslint/eslint-plugin": "^8.53.1",
43
+ "@typescript-eslint/parser": "^8.53.1",
45
44
  "eslint": "^9.39.2",
46
45
  "eslint-config-prettier": "^10.1.8",
47
- "eslint-plugin-prettier": "^5.5.4",
46
+ "eslint-plugin-prettier": "^5.5.5",
48
47
  "husky": "^9.1.7",
49
- "prettier": "^3.7.4",
48
+ "prettier": "^3.8.1",
50
49
  "typescript": "^5.9.3"
51
50
  },
52
51
  "nx": {