From 1d35785814571e1a59856025386d504100f8e54f Mon Sep 17 00:00:00 2001 From: Trent Mick Date: Wed, 22 May 2024 17:29:17 -0700 Subject: [PATCH] manually work through markdown lint errors --- CONTRIBUTING.md | 2 +- .../CHANGELOG.md | 2 +- .../opentelemetry-resource-detector-azure/README.md | 10 ++++++++++ .../README.md | 2 ++ .../opentelemetry-id-generator-aws-xray/README.md | 11 ++++++----- plugins/node/instrumentation-amqplib/README.md | 2 +- .../opentelemetry-instrumentation-aws-sdk/README.md | 2 +- .../node/opentelemetry-instrumentation-dns/README.md | 2 +- .../opentelemetry-instrumentation-graphql/README.md | 12 ++++++------ .../opentelemetry-instrumentation-mysql/README.md | 2 +- .../README.md | 10 +++++----- 11 files changed, 35 insertions(+), 22 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f05cf8e937..6e014f3ee1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -150,7 +150,7 @@ With the exception of the stable status, it is up to each individual [component A component may only be marked stable with the approval of a member of @open-telemetry/javascript-maintainers; see the definition of stable below for more details. A Pull Request modifying components in any stage of the lifecycle is subject to the -[Pull Request Merge Requirements](#pull-request-merge-requirements). +[Pull Request Merge Guidelines](#pull-request-merge-guidelines). ### Unreleased diff --git a/detectors/node/opentelemetry-resource-detector-azure/CHANGELOG.md b/detectors/node/opentelemetry-resource-detector-azure/CHANGELOG.md index bc3b8cc98b..9e09232989 100644 --- a/detectors/node/opentelemetry-resource-detector-azure/CHANGELOG.md +++ b/detectors/node/opentelemetry-resource-detector-azure/CHANGELOG.md @@ -72,7 +72,7 @@ * devDependencies * @opentelemetry/contrib-test-utils bumped from ^0.34.1 to ^0.34.3 -## [0.1.0]() () +## 0.1.0 ### Features diff --git a/detectors/node/opentelemetry-resource-detector-azure/README.md b/detectors/node/opentelemetry-resource-detector-azure/README.md index c900a48663..4b7ff90938 100644 --- a/detectors/node/opentelemetry-resource-detector-azure/README.md +++ b/detectors/node/opentelemetry-resource-detector-azure/README.md @@ -75,3 +75,13 @@ This package implements Semantic Convention [Version 1.19.0](https://github.com/ - For more information on OpenTelemetry, visit: - For more about OpenTelemetry JavaScript: - For help or feedback on this project, join us in [GitHub Discussions][discussions-url] + +## License + +Apache 2.0 - See [LICENSE][license-url] for more information. + +[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions +[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE +[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[npm-url]: https://www.npmjs.com/package/@opentelemetry/resource-detector-azure +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fresource-detector-azure.svg diff --git a/detectors/node/opentelemetry-resource-detector-container/README.md b/detectors/node/opentelemetry-resource-detector-container/README.md index f798241a28..fd452420fe 100644 --- a/detectors/node/opentelemetry-resource-detector-container/README.md +++ b/detectors/node/opentelemetry-resource-detector-container/README.md @@ -51,3 +51,5 @@ Apache 2.0 - See [LICENSE][license-url] for more information. [discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions [license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[npm-url]: https://www.npmjs.com/package/@opentelemetry/resource-detector-container +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fresource-detector-container.svg diff --git a/packages/opentelemetry-id-generator-aws-xray/README.md b/packages/opentelemetry-id-generator-aws-xray/README.md index 707cddadbb..8c7d77604d 100644 --- a/packages/opentelemetry-id-generator-aws-xray/README.md +++ b/packages/opentelemetry-id-generator-aws-xray/README.md @@ -53,8 +53,9 @@ A trace ID consists of two parts: ## License Apache 2.0 - See [LICENSE][license-url] for more information. -[discussions-url]: -[license-url]: -[license-image]: -[npm-url]: -[npm-img]: + +[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions +[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE +[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[npm-url]: https://www.npmjs.com/package/@opentelemetry/id-generator-aws-xray +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fid-generator-aws-xray.svg diff --git a/plugins/node/instrumentation-amqplib/README.md b/plugins/node/instrumentation-amqplib/README.md index 5d4933db7e..1fce886b89 100644 --- a/plugins/node/instrumentation-amqplib/README.md +++ b/plugins/node/instrumentation-amqplib/README.md @@ -55,7 +55,7 @@ amqplib instrumentation has few options available to choose from. You can set th | `publishConfirmHook` | `AmqplibPublishConfirmCustomAttributeFunction` | hook for adding custom attributes after publish message is confirmed by the broker. | | `consumeHook` | `AmqplibConsumeCustomAttributeFunction` | hook for adding custom attributes before consumer message is processed. | | `consumeEndHook` | `AmqplibConsumeEndCustomAttributeFunction` | hook for adding custom attributes after consumer message is acked to server. | -| `consumeTimeoutMs` | `number` | read [Consume Timeout](#ConsumeTimeout) below | +| `consumeTimeoutMs` | `number` | read [Consume Timeout](#consume-timeout) below | ### Consume Timeout diff --git a/plugins/node/opentelemetry-instrumentation-aws-sdk/README.md b/plugins/node/opentelemetry-instrumentation-aws-sdk/README.md index dc362c6a29..52017e7497 100644 --- a/plugins/node/opentelemetry-instrumentation-aws-sdk/README.md +++ b/plugins/node/opentelemetry-instrumentation-aws-sdk/README.md @@ -56,7 +56,7 @@ aws-sdk instrumentation has few options available to choose from. You can set th Both V2 and V3 instrumentations are collecting the following attributes: | Attribute Name | Type | Description | Example | | -------------- | ---- | ----------- | ------- | -| `rpc.system` | string | Always equals "aws-api" | +| `rpc.system` | string | Always equals "aws-api" | | | `rpc.method` | string | he name of the operation corresponding to the request, as returned by the AWS SDK. If the SDK does not provide a way to retrieve a name, the name of the command SHOULD be used, removing the suffix `Command` if present, resulting in a PascalCase name with no spaces. | `PutObject` | | `rpc.service` | string | The name of the service to which a request is made, as returned by the AWS SDK. If the SDK does not provide a away to retrieve a name, the name of the SDK's client interface for a service SHOULD be used, removing the suffix `Client` if present, resulting in a PascalCase name with no spaces. | `S3`, `DynamoDB`, `Route53` | | `aws.region` | string | Region name for the request | "eu-west-1" | diff --git a/plugins/node/opentelemetry-instrumentation-dns/README.md b/plugins/node/opentelemetry-instrumentation-dns/README.md index 74d7e2a7bd..d394584264 100644 --- a/plugins/node/opentelemetry-instrumentation-dns/README.md +++ b/plugins/node/opentelemetry-instrumentation-dns/README.md @@ -44,7 +44,7 @@ DNS instrumentation has currently one option. You can set the following: | Options | Type | Description | | ------- | ---- | ----------- | -| [`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 | +| [`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 diff --git a/plugins/node/opentelemetry-instrumentation-graphql/README.md b/plugins/node/opentelemetry-instrumentation-graphql/README.md index 9344e8ed19..5a23f47660 100644 --- a/plugins/node/opentelemetry-instrumentation-graphql/README.md +++ b/plugins/node/opentelemetry-instrumentation-graphql/README.md @@ -52,14 +52,14 @@ registerInstrumentations({ ## Optional Parameters -| Param | type | Default Value | Description | | -|:-----------:|:-------:|:-------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------:|:-:| -| mergeItems | boolean | false | Whether to merge list items into a single element. example: `users.*.name` instead of `users.0.name`, `users.1.name` | | -| depth | number | -1 | The maximum depth of fields/resolvers to instrument. When set to 0 it will not instrument fields and resolvers. When set to -1 it will instrument all fields and resolvers. | | -| allowValues | boolean | false | When set to true it will not remove attributes values from schema source. By default all values that can be sensitive are removed and replaced with "*" | | +| Param | type | Default Value | Description | +|:-----------:|:-------:|:-------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------:| +| mergeItems | boolean | false | Whether to merge list items into a single element. example: `users.*.name` instead of `users.0.name`, `users.1.name` | +| depth | number | -1 | The maximum depth of fields/resolvers to instrument. When set to 0 it will not instrument fields and resolvers. When set to -1 it will instrument all fields and resolvers. | +| allowValues | boolean | false | When set to true it will not remove attributes values from schema source. By default all values that can be sensitive are removed and replaced with "*" | | ignoreTrivialResolveSpans | boolean | false | Don't create spans for the execution of the default resolver on object properties. | | ignoreResolveSpans | boolean | false | Don't create spans for resolvers, regardless if they are trivial or not. | -| responseHook | GraphQLInstrumentationExecutionResponseHook | undefined | Hook that allows adding custom span attributes based on the data returned from "execute" GraphQL action. | | +| responseHook | GraphQLInstrumentationExecutionResponseHook | undefined | Hook that allows adding custom span attributes based on the data returned from "execute" GraphQL action. | ## Verbosity diff --git a/plugins/node/opentelemetry-instrumentation-mysql/README.md b/plugins/node/opentelemetry-instrumentation-mysql/README.md index e632521fb6..971fc5351a 100644 --- a/plugins/node/opentelemetry-instrumentation-mysql/README.md +++ b/plugins/node/opentelemetry-instrumentation-mysql/README.md @@ -47,7 +47,7 @@ See [examples/mysql](https://github.com/open-telemetry/opentelemetry-js-contrib/ | Options | Type | Default | Description | | ------- | ---- | --------| ----------- | | [`enhancedDatabaseReporting`](./src/types.ts#L24) | `boolean` | `false` | If true, an attribute containing the query's parameters will be attached the spans generated to represent the query | -| + ## Semantic Conventions diff --git a/plugins/node/opentelemetry-instrumentation-nestjs-core/README.md b/plugins/node/opentelemetry-instrumentation-nestjs-core/README.md index ba54f30230..1c1f0cd347 100644 --- a/plugins/node/opentelemetry-instrumentation-nestjs-core/README.md +++ b/plugins/node/opentelemetry-instrumentation-nestjs-core/README.md @@ -42,11 +42,11 @@ registerInstrumentations({ ## Emitted Spans -| Name | `nestjs.type` | Description | Included attributes -| ---- | ---- | ---- | ---- -`Create Nest App` | `app_creation` | Traces the bootup for the Nest App. The `NestFactory(Static).create` call. | `nestjs.module` -`.` | `request_context` | Traces the whole request context. | `http.*`, `nestjs.callback` -`` | `handler` | Traces the work of a specific controller member function. | `nestjs.callback` +| Name | `nestjs.type` | Description | Included attributes | +| ---- | ---- | ---- | ---- | +| `Create Nest App` | `app_creation` | Traces the bootup for the Nest App. The `NestFactory(Static).create` call. | `nestjs.module` | +| `.` | `request_context` | Traces the whole request context. | `http.*`, `nestjs.callback` | +| `` | `handler` | Traces the work of a specific controller member function. | `nestjs.callback` | ## Semantic Conventions