Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove unused semconv packages and document #2182

Merged
4 changes: 4 additions & 0 deletions incubator/opentelemetry-sampler-aws-xray/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@ For more details on setting up the global tracer provider to send traces to AWS

Please note that AWS Lambda does not support X-Ray remote sampling.

## Semantic Conventions

This package does not currently generate any attributes from semantic conventions.

## Useful links

- [More information on OpenTelemetry](https://opentelemetry.io/)
Expand Down
9 changes: 4 additions & 5 deletions incubator/opentelemetry-sampler-aws-xray/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@
"dependencies": {
"@opentelemetry/core": "^1.8.0",
"@opentelemetry/sdk-trace-base": "^1.8.0",
"@opentelemetry/semantic-conventions": "^1.0.0",
"axios": "^1.3.5"
},
"devDependencies": {
Expand All @@ -55,16 +54,16 @@
"@types/mocha": "8.2.3",
"@types/node": "18.6.5",
"@types/sinon": "10.0.18",
"@typescript-eslint/eslint-plugin": "5.8.1",
"@typescript-eslint/parser": "5.8.1",
"eslint": "8.7.0",
"expect": "29.2.0",
"mocha": "7.2.0",
"nock": "13.3.3",
"nyc": "15.1.0",
"sinon": "15.2.0",
"ts-mocha": "10.0.0",
"nyc": "15.1.0",
"typescript": "4.4.4",
"@typescript-eslint/eslint-plugin": "5.8.1",
"@typescript-eslint/parser": "5.8.1"
"typescript": "4.4.4"
},
"engines": {
"node": ">=14"
Expand Down
8 changes: 1 addition & 7 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 6 additions & 2 deletions plugins/node/instrumentation-lru-memoizer/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# OpenTelemetry lru-memorizer Instrumentation for Node.js
# OpenTelemetry lru-memoizer Instrumentation for Node.js

[![NPM Published Version][npm-img]][npm-url]
[![Apache License][license-image]][license-image]

This module provides automatic instrumentation for the [`lru-memorizer`](https://github.com/jfromaniello/lru-memoizer) module, which may be loaded using the [`@opentelemetry/sdk-trace-node`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node) package and is included in the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle.
This module provides automatic instrumentation for the [`lru-memoizer`](https://github.com/jfromaniello/lru-memoizer) module, which may be loaded using the [`@opentelemetry/sdk-trace-node`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node) package and is included in the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle.

If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`https://www.npmjs.com/package/@opentelemetry/sdk-node`) for the most seamless instrumentation experience.

Expand Down Expand Up @@ -40,6 +40,10 @@ registerInstrumentations({
})
```

## Semantic Conventions

This package does not currently generate any attributes from semantic conventions.

## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
Expand Down
4 changes: 4 additions & 0 deletions plugins/node/opentelemetry-instrumentation-bunyan/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,10 @@ const logger = bunyan.createLogger({
});
```

## Semantic Conventions

This package does not currently generate any attributes from semantic conventions.

## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
Expand Down
4 changes: 4 additions & 0 deletions plugins/node/opentelemetry-instrumentation-dns/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ DNS instrumentation has currently one option. You can set the following:
| ------- | ---- | ----------- |
| [`ignoreHostnames`](https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/plugins/node/opentelemetry-instrumentation-dns/src/types.ts#L99) | `IgnoreMatcher | IgnoreMatcher[]` | DNS instrumentation will not trace all requests that match hostnames |

## Semantic Conventions

This package does not currently generate any attributes from semantic conventions.

## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@
},
"dependencies": {
"@opentelemetry/instrumentation": "^0.51.0",
"@opentelemetry/semantic-conventions": "^1.0.0",
"semver": "^7.5.4"
},
"homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-dns#readme"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ registerInstrumentations({
});
```

## Semantic Conventions

This package does not currently generate any attributes from semantic conventions.

## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,7 @@
"typescript": "4.4.4"
},
"dependencies": {
"@opentelemetry/instrumentation": "^0.51.0",
"@opentelemetry/semantic-conventions": "^1.0.0"
"@opentelemetry/instrumentation": "^0.51.0"
},
"homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-generic-pool#readme"
}
4 changes: 4 additions & 0 deletions plugins/node/opentelemetry-instrumentation-pino/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ When no span context is active or the span context is invalid, injection is skip

`>=5.14.0 <10`

## Semantic Conventions

This package does not currently generate any attributes from semantic conventions.

## Useful links

* For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ npm install --save @opentelemetry/winston-transport
### Log correlation

Winston logger calls in the context of a tracing span will have fields
indentifying the span added to the log record. This allows
identifying the span added to the log record. This allows
[correlating](https://opentelemetry.io/docs/specs/otel/logs/#log-correlation)
log records with tracing data. The added fields are
([spec](https://opentelemetry.io/docs/specs/otel/compatibility/logging_trace_context/)):
Expand All @@ -106,6 +106,10 @@ Log sending

`3.x`

## Semantic Conventions

This package does not currently generate any attributes from semantic conventions.

## Useful links

* For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
Expand Down
4 changes: 4 additions & 0 deletions plugins/web/opentelemetry-plugin-react-load/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ export class Component1 extends BaseOpenTelemetryComponent { ... }

See [/examples/react-load](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/examples/react-load) for a short example.

## Semantic Conventions

This package does not currently generate any attributes from semantic conventions.

## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
Expand Down
3 changes: 1 addition & 2 deletions plugins/web/opentelemetry-plugin-react-load/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
},
"devDependencies": {
"@babel/core": "7.22.17",
"@jsdevtools/coverage-istanbul-loader": "3.0.5",
"@opentelemetry/api": "^1.0.0",
"@opentelemetry/propagator-b3": "^1.3.1",
"@types/mocha": "7.0.2",
Expand All @@ -60,7 +61,6 @@
"@types/sinon": "10.0.18",
"@types/webpack-env": "1.16.2",
"babel-loader": "8.2.2",
"@jsdevtools/coverage-istanbul-loader": "3.0.5",
"karma": "6.3.16",
"karma-chrome-launcher": "^3.1.1",
"karma-coverage-istanbul-reporter": "3.0.3",
Expand Down Expand Up @@ -89,7 +89,6 @@
"@opentelemetry/core": "^1.0.0",
"@opentelemetry/sdk-trace-base": "^1.0.0",
"@opentelemetry/sdk-trace-web": "^1.0.0",
"@opentelemetry/semantic-conventions": "^1.0.0",
"shimmer": "^1.2.1"
},
"homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/web/opentelemetry-plugin-react-load#readme"
Expand Down
Loading