Skip to content

Commit

Permalink
Merge branch 'main' into event-target-this
Browse files Browse the repository at this point in the history
  • Loading branch information
dyladan committed Aug 31, 2021
2 parents 0c21d38 + 8584432 commit f684015
Show file tree
Hide file tree
Showing 41 changed files with 462 additions and 76 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Expand Up @@ -33,6 +33,6 @@ jobs:
if: steps.cache.outputs.cache-hit != 'true'
run: |
npm install --only=dev --ignore-scripts
npx lerna bootstrap --no-ci --ignore-scripts -- --only=dev
npx lerna bootstrap --no-ci --hoist --nohoist='zone.js' --nohoist='gts' --ignore-scripts -- --only=dev
- name: Lint
run: npm run lint
56 changes: 50 additions & 6 deletions README.md
Expand Up @@ -50,18 +50,32 @@ OpenTelemetry can collect tracing data automatically using instrumentations. Ven

### Node Instrumentations

- [@opentelemetry/instrumentation-aws-lambda][otel-contrib-instrumentation-aws-lambda]
- [@opentelemetry/instrumentation-bunyan][otel-contrib-instrumentation-bunyan]
- [@opentelemetry/instrumentation-cassandra-driver][otel-contrib-instrumentation-cassandra]
- [@opentelemetry/instrumentation-connect][otel-contrib-instrumentation-connect]
- [@opentelemetry/instrumentation-dns][otel-contrib-instrumentation-dns]
- [@opentelemetry/instrumentation-express][otel-contrib-instrumentation-express]
- [@opentelemetry/instrumentation-generic-pool][otel-contrib-instrumentation-generic-pool]
- [@opentelemetry/instrumentation-graphql][otel-contrib-instrumentation-graphql]
- [@opentelemetry/instrumentation-grpc][otel-instrumentation-grpc]
- [@opentelemetry/instrumentation-hapi][otel-contrib-instrumentation-hapi]
- [@opentelemetry/instrumentation-http][otel-instrumentation-http]
- [@opentelemetry/instrumentation-ioredis][otel-contrib-instrumentation-ioredis]
- [@opentelemetry/instrumentation-knex][otel-contrib-instrumentation-knex]
- [@opentelemetry/instrumentation-koa][otel-contrib-instrumentation-koa]
- [@opentelemetry/instrumentation-memcached][otel-contrib-instrumentation-memcached]
- [@opentelemetry/instrumentation-mongodb][otel-contrib-instrumentation-mongodb]
- [@opentelemetry/instrumentation-mysql][otel-contrib-instrumentation-mysql]
- [@opentelemetry/instrumentation-mysql2][otel-contrib-instrumentation-mysql2]
- [@opentelemetry/instrumentation-nestjs-core][otel-contrib-instrumentation-nestjs-core]
- [@opentelemetry/instrumentation-net][otel-contrib-instrumentation-net]
- [@opentelemetry/instrumentation-pg][otel-contrib-instrumentation-pg]
- [@opentelemetry/instrumentation-pino][otel-contrib-instrumentation-pino]
- [@opentelemetry/instrumentation-redis][otel-contrib-instrumentation-redis]
- [@opentelemetry/instrumentation-ioredis][otel-contrib-instrumentation-ioredis]
- [@opentelemetry/instrumentation-express][otel-contrib-instrumentation-express]
- [@opentelemetry/instrumentation-dns][otel-contrib-instrumentation-dns]
- [@opentelemetry/instrumentation-hapi][otel-contrib-instrumentation-hapi]
- [@opentelemetry/instrumentation-koa][otel-contrib-instrumentation-koa]
- [@opentelemetry/instrumentation-graphql][otel-contrib-instrumentation-graphql]
- [@opentelemetry/instrumentation-restify][otel-contrib-instrumentation-restify]
- [@opentelemetry/instrumentation-router][otel-contrib-instrumentation-router]
- [@opentelemetry/instrumentation-winston][otel-contrib-instrumentation-winston]

### Web Instrumentations

Expand All @@ -78,6 +92,17 @@ Multiple instrumentations may be leveraged via metapackages.
- [@opentelemetry/auto-instrumentations-node][otel-contrib-auto-instr-node] - Metapackage which bundles opentelemetry node core and contrib instrumentations
- [@opentelemetry/auto-instrumentations-web][otel-contrib-auto-instr-web] - Metapackage which bundles opentelemetry web core and contrib instrumentations

## Resource Detectors

OpenTelemetry can collect resource attributes of the entity that 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`.

Currently, OpenTelemetry supports automatic collection for following environments:

- [@opentelemetry/resource-detector-alibaba-cloud][otel-contrib-resource-detector-alibaba-cloud]
- [@opentelemetry/resource-detector-aws][otel-contrib-resource-detector-aws]
- [@opentelemetry/resource-detector-gcp][otel-contrib-resource-detector-gcp]
- [@opentelemetry/resource-detector-github][otel-contrib-resource-detector-github]

## Supported Runtimes

Platform Version | Supported
Expand Down Expand Up @@ -122,19 +147,38 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
[otel-instrumentation-http]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-instrumentation-http
[otel-instrumentation-xml-http-request]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-instrumentation-xml-http-request

[otel-contrib-instrumentation-aws-lambda]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-aws-lambda
[otel-contrib-instrumentation-bunyan]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-bunyan
[otel-contrib-instrumentation-cassandra]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-cassandra
[otel-contrib-instrumentation-connect]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-connect
[otel-contrib-instrumentation-dns]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-dns
[otel-contrib-instrumentation-document-load]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/web/opentelemetry-instrumentation-document-load
[otel-contrib-instrumentation-express]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-express
[otel-contrib-instrumentation-generic-pool]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-generic-pool
[otel-contrib-instrumentation-graphql]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-graphql
[otel-contrib-instrumentation-hapi]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-hapi
[otel-contrib-instrumentation-ioredis]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-ioredis
[otel-contrib-instrumentation-knex]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-knex
[otel-contrib-instrumentation-koa]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-koa
[otel-contrib-instrumentation-memcached]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-memcached
[otel-contrib-instrumentation-mongodb]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-mongodb
[otel-contrib-instrumentation-mysql]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-mysql
[otel-contrib-instrumentation-mysql2]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-mysql2
[otel-contrib-instrumentation-nestjs-core]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-nestjs-core
[otel-contrib-instrumentation-net]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-net
[otel-contrib-instrumentation-pg]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-pg
[otel-contrib-instrumentation-pino]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-pino
[otel-contrib-instrumentation-redis]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-redis
[otel-contrib-instrumentation-restify]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-restify
[otel-contrib-instrumentation-router]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-router
[otel-contrib-instrumentation-winston]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-winston
[otel-contrib-instrumentation-user-interaction]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/web/opentelemetry-instrumentation-user-interaction
[otel-contrib-plugin-react-load]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/web/opentelemetry-plugin-react-load

[otel-contrib-auto-instr-node]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/metapackages/auto-instrumentations-node
[otel-contrib-auto-instr-web]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/metapackages/auto-instrumentations-web

[otel-contrib-resource-detector-alibaba-cloud]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/detectors/node/opentelemetry-resource-detector-alibaba-cloud
[otel-contrib-resource-detector-aws]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/detectors/node/opentelemetry-resource-detector-aws
[otel-contrib-resource-detector-gcp]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/detectors/node/opentelemetry-resource-detector-gcp
[otel-contrib-resource-detector-github]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/detectors/node/opentelemetry-resource-detector-github
Expand Up @@ -44,7 +44,7 @@
},
"devDependencies": {
"@opentelemetry/api": "1.0.2",
"@opentelemetry/test-utils": "^0.24.0",
"@opentelemetry/contrib-test-utils": "^0.24.0",
"@types/mocha": "8.2.3",
"@types/node": "14.17.9",
"@types/sinon": "10.0.2",
Expand Down
Expand Up @@ -21,7 +21,7 @@ import { alibabaCloudEcsDetector } from '../../src';
import {
assertCloudResource,
assertHostResource,
} from '@opentelemetry/test-utils';
} from '@opentelemetry/contrib-test-utils';

const ALIYUN_HOST =
'http://' + alibabaCloudEcsDetector.ALIBABA_CLOUD_IDMS_ENDPOINT;
Expand Down
Expand Up @@ -43,7 +43,7 @@
},
"devDependencies": {
"@opentelemetry/api": "1.0.2",
"@opentelemetry/test-utils": "^0.24.0",
"@opentelemetry/contrib-test-utils": "^0.24.0",
"@types/mocha": "8.2.3",
"@types/node": "14.17.9",
"@types/sinon": "10.0.2",
Expand Down
Expand Up @@ -20,7 +20,7 @@ import { awsBeanstalkDetector, AwsBeanstalkDetector } from '../../src';
import {
assertEmptyResource,
assertServiceResource,
} from '@opentelemetry/test-utils';
} from '@opentelemetry/contrib-test-utils';
import { CloudPlatformValues } from '@opentelemetry/semantic-conventions';

describe('BeanstalkResourceDetector', () => {
Expand Down
Expand Up @@ -21,7 +21,7 @@ import { awsEc2Detector } from '../../src';
import {
assertCloudResource,
assertHostResource,
} from '@opentelemetry/test-utils';
} from '@opentelemetry/contrib-test-utils';

const AWS_HOST = 'http://' + awsEc2Detector.AWS_IDMS_ENDPOINT;
const AWS_TOKEN_PATH = awsEc2Detector.AWS_INSTANCE_TOKEN_DOCUMENT_PATH;
Expand Down
Expand Up @@ -23,7 +23,7 @@ import {
import {
assertEmptyResource,
assertContainerResource,
} from '@opentelemetry/test-utils';
} from '@opentelemetry/contrib-test-utils';
import * as os from 'os';

describe('BeanstalkResourceDetector', () => {
Expand Down
Expand Up @@ -23,7 +23,7 @@ import {
assertK8sResource,
assertContainerResource,
assertEmptyResource,
} from '@opentelemetry/test-utils';
} from '@opentelemetry/contrib-test-utils';

const K8S_SVC_URL = awsEksDetector.K8S_SVC_URL;
const AUTH_CONFIGMAP_PATH = awsEksDetector.AUTH_CONFIGMAP_PATH;
Expand Down
Expand Up @@ -18,7 +18,7 @@ import * as assert from 'assert';
import {
assertCloudResource,
assertEmptyResource,
} from '@opentelemetry/test-utils';
} from '@opentelemetry/contrib-test-utils';

import { awsLambdaDetector } from '../../src';

Expand Down
Expand Up @@ -44,7 +44,7 @@
"devDependencies": {
"@opentelemetry/api": "1.0.2",
"@opentelemetry/core": "0.25.0",
"@opentelemetry/test-utils": "0.24.0",
"@opentelemetry/contrib-test-utils": "0.24.0",
"@types/mocha": "8.2.3",
"@types/node": "14.17.9",
"@types/semver": "7.3.8",
Expand Down
Expand Up @@ -31,7 +31,7 @@ import {
assertK8sResource,
assertContainerResource,
assertEmptyResource,
} from '@opentelemetry/test-utils';
} from '@opentelemetry/contrib-test-utils';
import { Resource } from '@opentelemetry/resources';

const HEADERS = {
Expand Down

0 comments on commit f684015

Please sign in to comment.