nestjs-otel 3.0.2 → 4.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.
Files changed (151) hide show
  1. package/.eslintignore +1 -0
  2. package/.eslintrc.js +27 -0
  3. package/CHANGELOG.md +34 -0
  4. package/README.md +15 -23
  5. package/lib/index.js +5 -1
  6. package/lib/index.js.map +1 -1
  7. package/lib/interfaces/index.js +5 -1
  8. package/lib/interfaces/index.js.map +1 -1
  9. package/lib/interfaces/opentelemetry-options.interface.d.ts +2 -6
  10. package/lib/metrics/decorators/common.d.ts +1 -1
  11. package/lib/metrics/decorators/common.js +12 -7
  12. package/lib/metrics/decorators/common.js.map +1 -1
  13. package/lib/metrics/decorators/common.spec.d.ts +1 -0
  14. package/lib/metrics/decorators/common.spec.js +48 -0
  15. package/lib/metrics/decorators/common.spec.js.map +1 -0
  16. package/lib/metrics/decorators/index.js +5 -1
  17. package/lib/metrics/decorators/index.js.map +1 -1
  18. package/lib/metrics/metric-data.d.ts +4 -4
  19. package/lib/metrics/metric-data.js +6 -6
  20. package/lib/metrics/metric-data.js.map +1 -1
  21. package/lib/metrics/metric.service.d.ts +4 -4
  22. package/lib/metrics/metric.service.js +6 -6
  23. package/lib/metrics/metric.service.js.map +1 -1
  24. package/lib/middleware/api-metrics.middleware.d.ts +10 -17
  25. package/lib/middleware/api-metrics.middleware.js +40 -50
  26. package/lib/middleware/api-metrics.middleware.js.map +1 -1
  27. package/lib/middleware/index.js +5 -1
  28. package/lib/middleware/index.js.map +1 -1
  29. package/lib/opentelemetry-core.module.js +3 -11
  30. package/lib/opentelemetry-core.module.js.map +1 -1
  31. package/lib/opentelemetry.module.js.map +1 -1
  32. package/lib/opentelemetry.utils.d.ts +1 -0
  33. package/lib/opentelemetry.utils.js +10 -0
  34. package/lib/opentelemetry.utils.js.map +1 -0
  35. package/lib/tracing/decorators/span.d.ts +2 -1
  36. package/lib/tracing/decorators/span.js +29 -9
  37. package/lib/tracing/decorators/span.js.map +1 -1
  38. package/lib/tracing/decorators/span.spec.d.ts +1 -1
  39. package/lib/tracing/decorators/span.spec.js +80 -15
  40. package/lib/tracing/decorators/span.spec.js.map +1 -1
  41. package/lib/tracing/trace.service.js.map +1 -1
  42. package/lib/tsconfig.tsbuildinfo +1 -1
  43. package/package.json +31 -30
  44. package/tsconfig.json +16 -0
  45. package/.editorconfig +0 -21
  46. package/.husky/commit-msg +0 -4
  47. package/.husky/pre-commit +0 -5
  48. package/.prettierrc.js +0 -47
  49. package/.vscode/settings.json +0 -8
  50. package/REFERENCE.md +0 -5
  51. package/commitlint.config.js +0 -7
  52. package/examples/nestjs-fastify-prom-grafana-tempo/.dockerignore +0 -5
  53. package/examples/nestjs-fastify-prom-grafana-tempo/Dockerfile +0 -17
  54. package/examples/nestjs-fastify-prom-grafana-tempo/README.md +0 -5
  55. package/examples/nestjs-fastify-prom-grafana-tempo/data/grafana-data/dashboards/nestjs-otel.json +0 -1838
  56. package/examples/nestjs-fastify-prom-grafana-tempo/data/grafana-data/dashboards-provisioning/dashboards.yaml +0 -14
  57. package/examples/nestjs-fastify-prom-grafana-tempo/data/grafana-data/datasources/datasource.yml +0 -60
  58. package/examples/nestjs-fastify-prom-grafana-tempo/docker-compose.yml +0 -86
  59. package/examples/nestjs-fastify-prom-grafana-tempo/etc/loki-local.yaml +0 -64
  60. package/examples/nestjs-fastify-prom-grafana-tempo/etc/prometheus.yaml +0 -27
  61. package/examples/nestjs-fastify-prom-grafana-tempo/etc/promtail-local.yaml +0 -43
  62. package/examples/nestjs-fastify-prom-grafana-tempo/etc/tempo-local.yaml +0 -45
  63. package/examples/nestjs-fastify-prom-grafana-tempo/grafana-dashboard.png +0 -0
  64. package/examples/nestjs-fastify-prom-grafana-tempo/loki-logs.png +0 -0
  65. package/examples/nestjs-fastify-prom-grafana-tempo/nest-cli.json +0 -4
  66. package/examples/nestjs-fastify-prom-grafana-tempo/package.json +0 -85
  67. package/examples/nestjs-fastify-prom-grafana-tempo/src/app.controller.spec.ts +0 -22
  68. package/examples/nestjs-fastify-prom-grafana-tempo/src/app.controller.ts +0 -26
  69. package/examples/nestjs-fastify-prom-grafana-tempo/src/app.module.ts +0 -22
  70. package/examples/nestjs-fastify-prom-grafana-tempo/src/app.service.ts +0 -8
  71. package/examples/nestjs-fastify-prom-grafana-tempo/src/logger/logger.module.ts +0 -17
  72. package/examples/nestjs-fastify-prom-grafana-tempo/src/logger/logger.ts +0 -33
  73. package/examples/nestjs-fastify-prom-grafana-tempo/src/main.ts +0 -20
  74. package/examples/nestjs-fastify-prom-grafana-tempo/src/tracing.ts +0 -48
  75. package/examples/nestjs-fastify-prom-grafana-tempo/test/app.e2e-spec.ts +0 -24
  76. package/examples/nestjs-fastify-prom-grafana-tempo/test/jest-e2e.json +0 -9
  77. package/examples/nestjs-fastify-prom-grafana-tempo/tsconfig.build.json +0 -4
  78. package/examples/nestjs-prom-grafana-tempo/.dockerignore +0 -5
  79. package/examples/nestjs-prom-grafana-tempo/Dockerfile +0 -17
  80. package/examples/nestjs-prom-grafana-tempo/README.md +0 -11
  81. package/examples/nestjs-prom-grafana-tempo/data/grafana-data/dashboards/nestjs-otel.json +0 -1838
  82. package/examples/nestjs-prom-grafana-tempo/data/grafana-data/dashboards-provisioning/dashboards.yaml +0 -14
  83. package/examples/nestjs-prom-grafana-tempo/data/grafana-data/datasources/datasource.yml +0 -60
  84. package/examples/nestjs-prom-grafana-tempo/docker-compose.yml +0 -86
  85. package/examples/nestjs-prom-grafana-tempo/etc/loki-local.yaml +0 -64
  86. package/examples/nestjs-prom-grafana-tempo/etc/prometheus.yaml +0 -27
  87. package/examples/nestjs-prom-grafana-tempo/etc/promtail-local.yaml +0 -43
  88. package/examples/nestjs-prom-grafana-tempo/etc/tempo-local.yaml +0 -45
  89. package/examples/nestjs-prom-grafana-tempo/grafana-dashboard.png +0 -0
  90. package/examples/nestjs-prom-grafana-tempo/loki-logs.png +0 -0
  91. package/examples/nestjs-prom-grafana-tempo/nest-cli.json +0 -4
  92. package/examples/nestjs-prom-grafana-tempo/package.json +0 -89
  93. package/examples/nestjs-prom-grafana-tempo/src/app.controller.spec.ts +0 -22
  94. package/examples/nestjs-prom-grafana-tempo/src/app.controller.ts +0 -26
  95. package/examples/nestjs-prom-grafana-tempo/src/app.module.ts +0 -23
  96. package/examples/nestjs-prom-grafana-tempo/src/app.service.ts +0 -8
  97. package/examples/nestjs-prom-grafana-tempo/src/logger/logger.module.ts +0 -17
  98. package/examples/nestjs-prom-grafana-tempo/src/logger/logger.ts +0 -33
  99. package/examples/nestjs-prom-grafana-tempo/src/main.ts +0 -26
  100. package/examples/nestjs-prom-grafana-tempo/src/team/team.controller.ts +0 -22
  101. package/examples/nestjs-prom-grafana-tempo/src/team/team.entity.ts +0 -18
  102. package/examples/nestjs-prom-grafana-tempo/src/team/team.module.ts +0 -9
  103. package/examples/nestjs-prom-grafana-tempo/src/team/team.service.ts +0 -30
  104. package/examples/nestjs-prom-grafana-tempo/src/tracing.ts +0 -48
  105. package/examples/nestjs-prom-grafana-tempo/test/app.e2e-spec.ts +0 -24
  106. package/examples/nestjs-prom-grafana-tempo/test/jest-e2e.json +0 -9
  107. package/examples/nestjs-prom-grafana-tempo/tsconfig.build.json +0 -4
  108. package/examples/nestjs-prom-grafana-tempo-otel-collector/.dockerignore +0 -5
  109. package/examples/nestjs-prom-grafana-tempo-otel-collector/Dockerfile +0 -17
  110. package/examples/nestjs-prom-grafana-tempo-otel-collector/README.md +0 -5
  111. package/examples/nestjs-prom-grafana-tempo-otel-collector/data/grafana-data/dashboards/nestjs-otel.json +0 -1838
  112. package/examples/nestjs-prom-grafana-tempo-otel-collector/data/grafana-data/dashboards-provisioning/dashboards.yaml +0 -14
  113. package/examples/nestjs-prom-grafana-tempo-otel-collector/data/grafana-data/datasources/datasource.yml +0 -60
  114. package/examples/nestjs-prom-grafana-tempo-otel-collector/docker-compose.yml +0 -101
  115. package/examples/nestjs-prom-grafana-tempo-otel-collector/etc/loki-local.yaml +0 -64
  116. package/examples/nestjs-prom-grafana-tempo-otel-collector/etc/otel-collector-config.yaml +0 -37
  117. package/examples/nestjs-prom-grafana-tempo-otel-collector/etc/prometheus.yaml +0 -28
  118. package/examples/nestjs-prom-grafana-tempo-otel-collector/etc/promtail-local.yaml +0 -43
  119. package/examples/nestjs-prom-grafana-tempo-otel-collector/etc/tempo-local.yaml +0 -45
  120. package/examples/nestjs-prom-grafana-tempo-otel-collector/grafana-dashboard.png +0 -0
  121. package/examples/nestjs-prom-grafana-tempo-otel-collector/loki-logs.png +0 -0
  122. package/examples/nestjs-prom-grafana-tempo-otel-collector/nest-cli.json +0 -4
  123. package/examples/nestjs-prom-grafana-tempo-otel-collector/package.json +0 -86
  124. package/examples/nestjs-prom-grafana-tempo-otel-collector/src/app.controller.spec.ts +0 -22
  125. package/examples/nestjs-prom-grafana-tempo-otel-collector/src/app.controller.ts +0 -26
  126. package/examples/nestjs-prom-grafana-tempo-otel-collector/src/app.module.ts +0 -22
  127. package/examples/nestjs-prom-grafana-tempo-otel-collector/src/app.service.ts +0 -8
  128. package/examples/nestjs-prom-grafana-tempo-otel-collector/src/logger/logger.module.ts +0 -17
  129. package/examples/nestjs-prom-grafana-tempo-otel-collector/src/logger/logger.ts +0 -33
  130. package/examples/nestjs-prom-grafana-tempo-otel-collector/src/main.ts +0 -13
  131. package/examples/nestjs-prom-grafana-tempo-otel-collector/src/tracing.ts +0 -54
  132. package/examples/nestjs-prom-grafana-tempo-otel-collector/test/app.e2e-spec.ts +0 -24
  133. package/examples/nestjs-prom-grafana-tempo-otel-collector/test/jest-e2e.json +0 -9
  134. package/examples/nestjs-prom-grafana-tempo-otel-collector/tsconfig.build.json +0 -4
  135. package/src/interfaces/opentelemetry-options.interface.ts +0 -59
  136. package/src/metrics/decorators/common.ts +0 -52
  137. package/src/metrics/decorators/counter.ts +0 -17
  138. package/src/metrics/decorators/histogram.ts +0 -10
  139. package/src/metrics/decorators/observable.ts +0 -28
  140. package/src/metrics/injector.ts +0 -14
  141. package/src/metrics/metric-data.ts +0 -116
  142. package/src/metrics/metric.service.ts +0 -48
  143. package/src/metrics/utils.spec.ts +0 -9
  144. package/src/metrics/utils.ts +0 -6
  145. package/src/middleware/api-metrics.middleware.ts +0 -174
  146. package/src/opentelemetry-core.module.ts +0 -175
  147. package/src/opentelemetry.constants.ts +0 -2
  148. package/src/opentelemetry.module.ts +0 -34
  149. package/src/tracing/decorators/span.spec.ts +0 -48
  150. package/src/tracing/decorators/span.ts +0 -23
  151. package/src/tracing/trace.service.ts +0 -17
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "nestjs-otel",
3
- "version": "3.0.2",
3
+ "version": "4.0.0",
4
4
  "description": "NestJS OpenTelemetry Library",
5
5
  "main": "lib/index.js",
6
6
  "typings": "lib/index",
@@ -36,41 +36,42 @@
36
36
  },
37
37
  "homepage": "https://github.com/pragmaticivan/nestjs-otel#readme",
38
38
  "dependencies": {
39
- "@opentelemetry/host-metrics": "^0.27.0",
40
- "@opentelemetry/api": "^1.0.4",
41
- "@opentelemetry/api-metrics": "^0.27.0",
42
- "opentelemetry-node-metrics": "^1.1.0",
39
+ "@opentelemetry/api": "^1.1.0",
40
+ "@opentelemetry/api-metrics": "^0.32.0",
41
+ "@opentelemetry/host-metrics": "^0.29.0",
43
42
  "response-time": "^2.3.2"
44
43
  },
45
44
  "devDependencies": {
46
- "@commitlint/cli": "^16.0.1",
47
- "@commitlint/config-conventional": "^16.0.0",
48
- "@nestjs/common": "^8.2.3",
49
- "@nestjs/core": "^8.2.3",
50
- "@nestjs/platform-express": "^8.2.4",
51
- "@nestjs/platform-fastify": "^8.2.4",
52
- "@nestjs/testing": "^8.2.4",
53
- "@opentelemetry/exporter-prometheus": "^0.27.0",
54
- "@opentelemetry/sdk-node": "^0.27.0",
55
- "@types/jest": "^27.0.3",
56
- "@types/node": "^17.0.5",
57
- "@types/supertest": "^2.0.11",
58
- "@typescript-eslint/eslint-plugin": "5.8.1",
59
- "@typescript-eslint/parser": "5.8.1",
60
- "eslint": "^8.5.0",
45
+ "@commitlint/cli": "^17.1.1",
46
+ "@commitlint/config-conventional": "^17.1.0",
47
+ "@nestjs/common": "^9.0.11",
48
+ "@nestjs/core": "^9.0.11",
49
+ "@nestjs/platform-express": "^9.0.11",
50
+ "@nestjs/platform-fastify": "^9.0.11",
51
+ "@nestjs/testing": "^9.0.11",
52
+ "@opentelemetry/exporter-prometheus": "^0.31.0",
53
+ "@opentelemetry/sdk-metrics-base": "^0.31.0",
54
+ "@opentelemetry/sdk-node": "^0.31.0",
55
+ "@opentelemetry/sdk-trace-node": "^1.5.0",
56
+ "@types/jest": "^28.1.8",
57
+ "@types/node": "^18.7.13",
58
+ "@types/supertest": "^2.0.12",
59
+ "@typescript-eslint/eslint-plugin": "5.35.1",
60
+ "@typescript-eslint/parser": "5.35.1",
61
+ "ansi-regex": "",
62
+ "eslint": "^8.23.0",
61
63
  "eslint-config-airbnb-base": "^15.0.0",
62
- "eslint-config-airbnb-typescript": "^16.1.0",
63
- "eslint-plugin-import": "^2.25.3",
64
- "husky": "^7.0.4",
65
- "jest": "^27.4.5",
66
- "lint-staged": "^12.1.4",
64
+ "eslint-config-airbnb-typescript": "^17.0.0",
65
+ "eslint-plugin-import": "^2.26.0",
66
+ "husky": "^8.0.1",
67
+ "jest": "^28.1.3",
68
+ "lint-staged": "^13.0.3",
67
69
  "reflect-metadata": "^0.1.13",
68
70
  "rimraf": "^3.0.2",
69
- "rxjs": "^7.5.1",
70
- "supertest": "^6.1.6",
71
- "ts-jest": "^27.1.2",
72
- "typescript": "4.5.4",
73
- "ansi-regex": ""
71
+ "rxjs": "^7.5.6",
72
+ "supertest": "^6.2.4",
73
+ "ts-jest": "^28.0.8",
74
+ "typescript": "4.8.2"
74
75
  },
75
76
  "peerDependencies": {
76
77
  "@nestjs/common": "^7.0.0 || ^8.0.0",
package/tsconfig.json ADDED
@@ -0,0 +1,16 @@
1
+ {
2
+ "compilerOptions": {
3
+ "module": "commonjs",
4
+ "declaration": true,
5
+ "removeComments": true,
6
+ "emitDecoratorMetadata": true,
7
+ "experimentalDecorators": true,
8
+ "allowSyntheticDefaultImports": true,
9
+ "target": "es2020",
10
+ "sourceMap": true,
11
+ "outDir": "./lib",
12
+ "baseUrl": "./",
13
+ "incremental": true
14
+ },
15
+ "exclude": ["node_modules", "lib", "tests", "examples"]
16
+ }
package/.editorconfig DELETED
@@ -1,21 +0,0 @@
1
- root = true
2
-
3
- [*]
4
- charset = utf-8
5
- end_of_line = lf
6
- indent_size = 2
7
- indent_style = space
8
- insert_final_newline = true
9
- trim_trailing_whitespace = true
10
- quote_type = double
11
-
12
- # editorconfig-tools is unable to ignore longs strings or urls
13
- max_line_length = null
14
-
15
- [*.js, *.jsx, *.tsx, *.ts]
16
- quote_type = single
17
- indent_style = space
18
- indent_size = 2
19
-
20
- [*.{json,yaml,yml}]
21
- indent_size = 2
package/.husky/commit-msg DELETED
@@ -1,4 +0,0 @@
1
- #!/bin/sh
2
- . "$(dirname "$0")/_/husky.sh"
3
-
4
- npx --no-install commitlint --edit "$1"
package/.husky/pre-commit DELETED
@@ -1,5 +0,0 @@
1
- #!/bin/sh
2
- . "$(dirname "$0")/_/husky.sh"
3
-
4
- npm test
5
- npx --no-install lint-staged
package/.prettierrc.js DELETED
@@ -1,47 +0,0 @@
1
- module.exports = {
2
- $schema: 'http://json.schemastore.org/prettierrc',
3
-
4
- // defaults
5
- arrowParens: 'avoid',
6
- bracketSpacing: true,
7
- embeddedLanguageFormatting: 'auto',
8
- jsxBracketSameLine: false,
9
- htmlWhitespaceSensitivity: 'css',
10
- requirePragma: false,
11
- insertPragma: false,
12
- proseWrap: 'preserve',
13
- semi: true,
14
- useTabs: false,
15
-
16
- // customized
17
- endOfLine: 'lf',
18
- printWidth: 100,
19
- singleQuote: true,
20
- tabWidth: 2,
21
- trailingComma: 'es5',
22
- quoteProps: 'consistent',
23
-
24
- overrides: [
25
- // explicitly keep output consistent with npm
26
- {
27
- files: [
28
- '.eslintrc.json',
29
- 'lerna.json',
30
- 'package.json',
31
- 'package-lock.json',
32
- 'npm-shrinkwrap.json',
33
- ],
34
- options: {
35
- parser: 'json-stringify',
36
- tabWidth: 2,
37
- trailingComma: 'none',
38
- },
39
- },
40
- {
41
- files: ['*.yaml', '*.yml'],
42
- options: {
43
- tabWidth: 2,
44
- },
45
- },
46
- ],
47
- };
@@ -1,8 +0,0 @@
1
- {
2
- "editor.codeActionsOnSave": {
3
- "source.fixAll": true
4
- },
5
- "typescript.preferences.importModuleSpecifier": "relative",
6
- "typescript.preferences.quoteStyle": "single",
7
- "typescript.tsdk": "node_modules/typescript/lib"
8
- }
package/REFERENCE.md DELETED
@@ -1,5 +0,0 @@
1
- * https://github.com/MetinSeylan/Nestjs-OpenTelemetry
2
- * https://github.com/digikare/nestjs-prom
3
- * https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html#actuator.metrics
4
- * https://github.com/prometheus/haproxy_exporter/blob/master/haproxy_exporter.go
5
- * https://github.com/mnadeem/nodejs-opentelemetry-tempo
@@ -1,7 +0,0 @@
1
- module.exports = {
2
- extends: ['@commitlint/config-conventional'],
3
- rules: {
4
- 'scope-case': [2, 'always', ['sentence-case', 'start-case', 'pascal-case', 'upper-case']],
5
- 'subject-case': [2, 'never', ['start-case', 'pascal-case']],
6
- },
7
- };
@@ -1,5 +0,0 @@
1
- # npm
2
- node_modules
3
-
4
- # npm run build
5
- dist
@@ -1,17 +0,0 @@
1
- FROM node:14.15.5-alpine3.13
2
- EXPOSE 5555
3
-
4
- RUN mkdir /app && chown -R node:node /app
5
-
6
- USER node
7
-
8
- COPY package.json package-lock.json /app/
9
- RUN cd /app && npm install
10
-
11
- WORKDIR /app
12
-
13
- COPY --chown=node:node . /app
14
-
15
- RUN npm run build
16
-
17
- CMD [ "npm", "run" ,"start" ]
@@ -1,5 +0,0 @@
1
- # Prometheus + Grafana + Tempo + Loki Observability Stack example
2
-
3
- ### Running
4
-
5
- `docker-compose up --build`