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

feat: support API and SDK 1.0 #706

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ The OpenTelemetry Resource is an immutable representation of the entity producin

[This document][resource-semantic_conventions] defines standard attributes for resources.

Supports OpenTelemetry JS SDK 1.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to be different from others. Is it intentional?


## Installation

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

Resource detector for Amazon Web Services.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

Resource detector for Google Cloud Platform.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

The GCP resource detector requires Node.JS 10+ due to a dependency on [`gcp-metadata`][] which uses features only available in Node.JS 10+.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ This is useful for collecting telemetry in GitHub Actions-powered CI/CD workflow

The OpenTelemetry Resource is an immutable representation of the entity producing telemetry. For example, a process producing telemetry that is running in a container on Kubernetes has a Pod name, it is in a namespace and possibly is part of a Deployment which also has a name. All three of these attributes can be included in the `Resource`.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This browser extension allows you to inject [OpenTelemetry](https://opentelemetry.io/) instrumentation in any web page. It uses the [Web SDK](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-web) and can export data to Zipkin or an OpenTelemetry Collector.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

![This animated image shows the process of activating the extension and seeing console output in the developer toolbar](./images/inject-opentelemetry.gif)

## Supported Environments
Expand Down
2 changes: 2 additions & 0 deletions packages/opentelemetry-host-metrics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ This module provides automatic collection of Host Metrics which includes metrics
* Memory
* Network

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
2 changes: 2 additions & 0 deletions packages/opentelemetry-id-generator-aws-xray/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ trace followed by a unique identifier consisting of 12 bytes of randomly generat
extension point which allows the usage of this custom IdGenerator as opposed to the out-of-the-box random IdGenerator,
enabling compatibility with AWS X-Ray.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

### Installation

`
Expand Down
2 changes: 2 additions & 0 deletions packages/opentelemetry-test-utils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
This is a internal utils package used across the contrib packages.
No guarantees are given to uses outside of [open-telemetry/opentelemetry-js-contrib](https://github.com/open-telemetry/opentelemetry-js-contrib/) repository.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Instrumentation Testing
This package exports a mocha [root hook plugin](https://mochajs.org/#root-hook-plugins), which implements common boilerplate code a developer probably needs for writing instrumentation unit tests in node.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ This module provides automatic instrumentation for [`AWS Lambda`](https://docs.a

This module is currently under active development and not ready for general use.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
2 changes: 2 additions & 0 deletions plugins/node/opentelemetry-instrumentation-bunyan/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

This module provides automatic instrumentation for injection of trace context to [`bunyan`](https://www.npmjs.com/package/bunyan).

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

This module provides automatic instrumentation for injection of trace context to [`cassandra-driver`](https://www.npmjs.com/package/cassandra-driver).

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`connect`](https://github.co
For automatic instrumentation see the
[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

This instrumentation relies on HTTP calls to also be instrumented. Make sure you install and enable both, otherwise you will have spans that are not connected to each other.
Expand Down
2 changes: 2 additions & 0 deletions plugins/node/opentelemetry-instrumentation-dns/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`dns`](http://nodejs.org/dis
For automatic instrumentation see the
[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`express`](https://github.co
For automatic instrumentation see the
[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

This instrumentation relies on HTTP calls to also be instrumented. Make sure you install and enable both, otherwise you will not see any spans being exported from the instrumentation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ This module provides basic automatic instrumentation for [`generic-pool`](https:
For automatic instrumentation see the
[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ This module provides *automated instrumentation and tracing* for GraphQL in Node

Minimum required graphql version is `v14`

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```shell script
Expand Down
2 changes: 2 additions & 0 deletions plugins/node/opentelemetry-instrumentation-hapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`Hapi`](https://hapi.dev).
For automatic instrumentation see the
[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`ioredis`](https://github.co
For automatic instrumentation see the
[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```sh
Expand Down
2 changes: 2 additions & 0 deletions plugins/node/opentelemetry-instrumentation-knex/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`knex`](https://github.com/k
For automatic instrumentation see the
[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
2 changes: 2 additions & 0 deletions plugins/node/opentelemetry-instrumentation-koa/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`Koa`](https://github.com/ko
For automatic instrumentation see the
[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`memcached@>=2.2.0`][repo-ur
For automatic instrumentation see the
[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`mongodb`](https://github.co
For automatic instrumentation see the
[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
2 changes: 2 additions & 0 deletions plugins/node/opentelemetry-instrumentation-mysql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`mysql`](https://www.npmjs.c
For automatic instrumentation see the
[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
2 changes: 2 additions & 0 deletions plugins/node/opentelemetry-instrumentation-mysql2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`mysql2`](https://github.com
For automatic instrumentation see the
[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

This module provides automatic tracing instrumentation for [Nest framework][pkg-web-url].

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
2 changes: 2 additions & 0 deletions plugins/node/opentelemetry-instrumentation-net/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
This module provides instrumentation of outgoing connections for [`net`](http://nodejs.org/dist/latest/docs/api/net.html).
Supports both TCP and IPC connections.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
2 changes: 2 additions & 0 deletions plugins/node/opentelemetry-instrumentation-pg/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`pg and pg-pool`](https://gi
For automatic instrumentation see the
[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
2 changes: 2 additions & 0 deletions plugins/node/opentelemetry-instrumentation-pino/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

This module provides automatic instrumentation for injection of trace context to [`pino`](https://www.npmjs.com/package/pino).

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
2 changes: 2 additions & 0 deletions plugins/node/opentelemetry-instrumentation-redis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`redis@^2.6.0`](https://gith
For automatic instrumentation see the
[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`restify`](https://github.co
For automatic instrumentation see the
[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
2 changes: 2 additions & 0 deletions plugins/node/opentelemetry-instrumentation-router/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ This module provides automatic instrumentation for [`router`](https://github.com
For automatic instrumentation see the
[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

This module provides automatic instrumentation for injection of trace context to [`winston`](https://www.npmjs.com/package/winston).

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

This module provides *automated instrumentation for document load* for Web applications.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ With [zone-js] and ZoneContextManager it will fully support the async operations
If you use Angular you already have the [zone-js]. It will be the same if you use [@opentelemetry/context-zone].
Without [zone-js] it will still work but with limited support.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
2 changes: 2 additions & 0 deletions plugins/web/opentelemetry-plugin-react-load/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

This module provides *automated instrumentation for React lifecycles* for Web applications.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

## Installation

```bash
Expand Down
2 changes: 2 additions & 0 deletions propagators/opentelemetry-propagator-aws-xray/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ The OpenTelemetry Propagator for AWS X-Ray provides HTTP header propagation for
This propagator translates the OpenTelemetry SpanContext into the equivalent AWS header format, for use with the OpenTelemetry JS SDK.
`TraceState` is currently not propagated.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

### Installation

```
Expand Down