Skip to content

Commit e293373

Browse files
committed
chore: apply markdownlint rules
1 parent 7173557 commit e293373

File tree

32 files changed

+279
-279
lines changed

32 files changed

+279
-279
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ about: Create a report to help us improve
44
labels: bug
55
---
66

7-
<!--
7+
<!--
88
Please answer these questions before submitting a bug report.
99
-->
1010

@@ -15,7 +15,7 @@ Please answer these questions before submitting a bug report.
1515

1616

1717
### What did you do?
18-
<!--
18+
<!--
1919
If possible, provide a recipe for reproducing the error.
2020
-->
2121

@@ -27,8 +27,8 @@ If possible, provide a recipe for reproducing the error.
2727

2828

2929
### Additional context
30-
<!--
30+
<!--
3131
Add any other context about the problem here.
3232
-->
3333

34-
<sub>**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. Learn more [here](https://opentelemetry.io/community/end-user/issue-participation/).</sub>
34+
<sub>**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. [Learn more here](https://opentelemetry.io/community/end-user/issue-participation/).</sub>

.github/ISSUE_TEMPLATE/discussion.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ labels: discussion
1111
- [ ] This only affects the JavaScript OpenTelemetry library
1212
- [ ] This may affect other libraries, but I would like to get opinions here first
1313

14-
<sub>**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. Learn more [here](https://opentelemetry.io/community/end-user/issue-participation/).</sub>
14+
<sub>**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. [Learn more here](https://opentelemetry.io/community/end-user/issue-participation/).</sub>
1515

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,21 @@ A clear and concise description of what the problem is. Ex. I'm always frustrate
1515

1616

1717
### Describe the solution you'd like to see
18-
<!--
18+
<!--
1919
A clear and concise description of what you want to happen.
2020
-->
2121

2222

2323
### Describe alternatives you've considered
24-
<!--
24+
<!--
2525
A clear and concise description of any alternative solutions or features you've considered.
2626
-->
2727

2828

2929
### Additional context
30-
<!--
30+
<!--
3131
Add any other context or screenshots about the feature request here.
3232
-->
3333

34-
<sub>**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. Learn more [here](https://opentelemetry.io/community/end-user/issue-participation/).</sub>
34+
<sub>**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. [Learn more here](https://opentelemetry.io/community/end-user/issue-participation/).</sub>
3535

.github/ISSUE_TEMPLATE/instrumentation_request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ Any code-owners listed MUST fulfill all criteria laid out in the checklist below
3535
Add any other context or screenshots about the instrumentation request here. Is there a reference you could point for the well-defined lifecycle methods?
3636
-->
3737

38-
<sub>**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. Learn more [here](https://opentelemetry.io/community/end-user/issue-participation/).</sub>
38+
<sub>**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. [Learn more here](https://opentelemetry.io/community/end-user/issue-participation/).</sub>

.github/ISSUE_TEMPLATE/ownership_request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@ Examples:
3939
Add any other context that does not fit any of the above sections
4040
-->
4141

42-
<sub>**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. Learn more [here](https://opentelemetry.io/community/end-user/issue-participation/).</sub>
42+
<sub>**Tip**: [React](https://github.blog/news-insights/product-news/add-reactions-to-pull-requests-issues-and-comments/) with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding `+1` or `me too`, to help us triage it. [Learn more here](https://opentelemetry.io/community/end-user/issue-participation/).</sub>

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ for general practices for OpenTelemetry project.
6161

6262
#### Conventional commit
6363

64-
The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages. You can see examples [here](https://www.conventionalcommits.org/en/v1.0.0/#examples).
64+
The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages. You can see examples [in the conventional commits specification](https://www.conventionalcommits.org/en/v1.0.0/#examples).
6565

6666
We use [the "pr-title" CI workflow](./.github/workflows/pr-title.yml) to ensure PR titles, and hence the commit message from those PRs, follow the Conventional Commits spec.
6767

@@ -352,7 +352,7 @@ Review the guidelines for [Becoming a Component Owner](#becoming-a-component-own
352352

353353
Regardless of where instrumentation is hosted, it needs to be discoverable.
354354
The [OpenTelemetry registry](https://opentelemetry.io/registry/) exists to ensure that instrumentation is discoverable.
355-
You can find out how to add instrumentation to the registry [here](https://github.com/open-telemetry/opentelemetry.io#adding-a-project-to-the-opentelemetry-registry).
355+
You can find out how to add instrumentation to the registry [over at opentelemetry.io](https://github.com/open-telemetry/opentelemetry.io#adding-a-project-to-the-opentelemetry-registry).
356356

357357
## Contributing Vendor Components
358358

packages/auto-instrumentations-node/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ registerInstrumentations({
173173
- [@opentelemetry/instrumentation-express](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-express)
174174
- [@opentelemetry/instrumentation-fastify](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-fastify) (deprecated, default disabled)
175175
- This component is **deprecated** in favor of the official instrumentation package [`@fastify/otel`](https://www.npmjs.com/package/@fastify/otel), maintained by the Fastify authors.
176-
- Please see [here](https://github.com/fastify/otel?tab=readme-ov-file#usage) for instructions on how to use `@fastify/otel`.
176+
- Please see [the offical plugin's README.md](https://github.com/fastify/otel?tab=readme-ov-file#usage) for instructions on how to use `@fastify/otel`.
177177
- This component will be removed on June 30, 2025
178178
- [@opentelemetry/instrumentation-fs](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-fs) (default disabled)
179179
- [@opentelemetry/instrumentation-generic-pool](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/instrumentation-generic-pool)

packages/host-metrics/README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ hostMetrics.start();
4242

4343
## Configuration
4444

45-
| Option | Type | Description |
46-
| -------------- | ---------- | ----------- |
45+
| Option | Type | Description |
46+
|----------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
4747
| `metricGroups` | `string[]` | Optionally specify zero or more groups of metrics to collect. This package can collect many metrics. They are grouped by metric name prefix (see the "Semantic Conventions" section below). If this option is specified, only metrics from the named groups will be collected. For example, `metricGroups: ['process.cpu', 'process.memory']` will limit collection to just those 3 metrics. |
4848

4949
## Semantic Conventions
@@ -54,30 +54,30 @@ Ref: [opentelemetry-js/issues/4235](https://github.com/open-telemetry/openteleme
5454

5555
Metrics collected:
5656

57-
| Metric | Short Description |
58-
| ----------------------------- | --------------------------------------------------------- |
59-
| **Group `system.cpu`** | |
60-
| `system.cpu.time` | Seconds each logical CPU spent on each mode |
61-
| `system.cpu.utilization` | CPU usage time (0-1) |
62-
| **Group `system.memory`** | |
63-
| `system.memory.usage` | Reports memory in use by state |
64-
| `system.memory.utilization` | Memory usage (0-1) |
65-
| **Group `system.network`** | |
66-
| `system.network.dropped` | Count of packets that are dropped |
67-
| `system.network.errors` | Count of network errors detected |
68-
| `system.network.io` | Network flow direction |
69-
| **Group `process.cpu`** | |
70-
| `process.cpu.time` | Total CPU seconds |
71-
| `process.cpu.utilization` | Difference in process.cpu.time since the last measurement |
72-
| **Group `process.memory`** | |
73-
| `process.memory.usage` | The amount of physical memory in use |
57+
| Metric | Short Description |
58+
|-----------------------------|-----------------------------------------------------------|
59+
| **Group `system.cpu`** | |
60+
| `system.cpu.time` | Seconds each logical CPU spent on each mode |
61+
| `system.cpu.utilization` | CPU usage time (0-1) |
62+
| **Group `system.memory`** | |
63+
| `system.memory.usage` | Reports memory in use by state |
64+
| `system.memory.utilization` | Memory usage (0-1) |
65+
| **Group `system.network`** | |
66+
| `system.network.dropped` | Count of packets that are dropped |
67+
| `system.network.errors` | Count of network errors detected |
68+
| `system.network.io` | Network flow direction |
69+
| **Group `process.cpu`** | |
70+
| `process.cpu.time` | Total CPU seconds |
71+
| `process.cpu.utilization` | Difference in process.cpu.time since the last measurement |
72+
| **Group `process.memory`** | |
73+
| `process.memory.usage` | The amount of physical memory in use |
7474

7575
Note: the "Group" names are groupings used by the `metricGroups` configuration option.
7676

7777
Attributes collected:
7878

7979
| Metric | Short Description |
80-
| --------------------------- | ---------------------------------- |
80+
|-----------------------------|------------------------------------|
8181
| `system.cpu.logical_number` | The logical CPU number |
8282
| `system.cpu.state` | The state of the CPU |
8383
| `system.memory.state` | The memory state |

packages/instrumentation-aws-lambda/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,12 @@ In your Lambda function configuration, add or update the `NODE_OPTIONS` environm
5050

5151
## AWS Lambda Instrumentation Options
5252

53-
| Options | Type | Description |
54-
| --- | --- | --- |
55-
| `requestHook` | `RequestHook` (function) | Hook for adding custom attributes before lambda starts handling the request. Receives params: `span, { event, context }` |
56-
| `responseHook` | `ResponseHook` (function) | Hook for adding custom attributes before lambda returns the response. Receives params: `span, { err?, res? }` |
57-
| `eventContextExtractor` | `EventContextExtractor` (function) | Function for providing custom context extractor in order to support different event types that are handled by AWS Lambda (e.g., SQS, CloudWatch, Kinesis, API Gateway). |
58-
| `lambdaHandler` | `string` | By default, this instrumentation automatically determines the Lambda handler function to instrument. This option is used to override that behavior by explicitly specifying the Lambda handler to instrument. See [Specifying the Lambda Handler](#specifying-the-lambda-handler) for additional information. |
53+
| Options | Type | Description |
54+
|-------------------------|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
55+
| `requestHook` | `RequestHook` (function) | Hook for adding custom attributes before lambda starts handling the request. Receives params: `span, { event, context }` |
56+
| `responseHook` | `ResponseHook` (function) | Hook for adding custom attributes before lambda returns the response. Receives params: `span, { err?, res? }` |
57+
| `eventContextExtractor` | `EventContextExtractor` (function) | Function for providing custom context extractor in order to support different event types that are handled by AWS Lambda (e.g., SQS, CloudWatch, Kinesis, API Gateway). |
58+
| `lambdaHandler` | `string` | By default, this instrumentation automatically determines the Lambda handler function to instrument. This option is used to override that behavior by explicitly specifying the Lambda handler to instrument. See [Specifying the Lambda Handler](#specifying-the-lambda-handler) for additional information. |
5959

6060
### Hooks Usage Example
6161

@@ -148,7 +148,7 @@ This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which i
148148
Attributes collected:
149149

150150
| Attribute | Short Description |
151-
| ------------------ | ------------------------------------------------------------------------- |
151+
|--------------------|---------------------------------------------------------------------------|
152152
| `cloud.account.id` | The cloud account ID the resource is assigned to. |
153153
| `faas.execution` | The execution ID of the current function execution. |
154154
| `faas.id` | The unique ID of the single function that this runtime instance executes. |

0 commit comments

Comments
 (0)