ensure table headers are lintable

thompson-tomo · web-flow · commit db56e2176a79 · 2025-11-20T12:07:51.000+11:00
diff --git a/packages/instrumentation-cassandra-driver/README.md b/packages/instrumentation-cassandra-driver/README.md
@@ -44,7 +44,7 @@ await client.execute('select * from foo');
 ### Instrumentation options
 
 | Option                      | Type                                             | Default     | Description                                                                                                                                                                                                                    |
-|-----------------------------|--------------------------------------------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| --------------------------- | ------------------------------------------------ | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `enhancedDatabaseReporting` | `boolean`                                        | `false`     | Whether to include database queries with spans. These can contain sensitive information when using unescaped parameters - i.e. `insert into persons (name) values ('Bob')` instead of `insert into persons (name) values (?)`. |
 | `responseHook`              | `CassandraDriverResponseCustomAttributeFunction` | `undefined` | Hook for adding custom attributes before response is handled                                                                                                                                                                   |
 | `maxQueryLength`            | `number`                                         | `65536`     | If `enhancedDatabaseReporting` is enabled, limits the attached query strings to this length.                                                                                                                                   |
diff --git a/packages/instrumentation-document-load/README.md b/packages/instrumentation-document-load/README.md
@@ -118,7 +118,7 @@ See [examples/tracer-web](https://github.com/open-telemetry/opentelemetry-js/tre
 The document load instrumentation plugin has few options available to choose from. You can set the following:
 
 | Options | Type | Description |
-|---------|------|-------------|
+| ------- | ---- | ----------- |
 | `applyCustomAttributesOnSpan.documentLoad`| `DocumentLoadCustomAttributeFunction` | Function for adding custom attributes to `documentLoad` spans.                                                  |
 | `applyCustomAttributesOnSpan.documentFetch`                      | `DocumentLoadCustomAttributeFunction`                     | Function for adding custom attributes to `documentFetch` spans.  |
 | `applyCustomAttributesOnSpan.resourceFetch`                      | `ResourceFetchCustomAttributeFunction`                     | Function for adding custom attributes to `resourceFetch` spans  |
diff --git a/packages/instrumentation-ioredis/README.md b/packages/instrumentation-ioredis/README.md
@@ -47,7 +47,7 @@ registerInstrumentations({
 IORedis instrumentation has few options available to choose from. You can set the following:
 
 | Options                 | Type                                              | Description                                                                                                       |
-|-------------------------|---------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|
+| ----------------------- | ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
 | `dbStatementSerializer` | `DbStatementSerializer`                           | IORedis instrumentation will serialize db.statement using the specified function.                                 |
 | `requestHook`           | `RedisRequestCustomAttributeFunction` (function)  | Function for adding custom attributes on db request. Receives params: `span, { moduleVersion, cmdName, cmdArgs }` |
 | `responseHook`          | `RedisResponseCustomAttributeFunction` (function) | Function for adding custom attributes on db response                                                              |
@@ -105,7 +105,7 @@ This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which i
 Attributes collected:
 
 | Attribute              | Short Description                                                           |
-|------------------------|-----------------------------------------------------------------------------|
+| ---------------------- | --------------------------------------------------------------------------- |
 | `db.connection_string` | The connection string used to connect to the database.                      |
 | `db.statement`         | The database statement being executed.                                      |
 | `db.system`            | An identifier for the database management system (DBMS) product being used. |
diff --git a/packages/instrumentation-knex/README.md b/packages/instrumentation-knex/README.md
@@ -76,7 +76,7 @@ This will cause both the old and new semantic conventions to be emitted during t
 Attributes collected:
 
 | v1.7.0 semconv  | v1.23.0 semconv      | Short Description                                                           |
-|-----------------|----------------------|-----------------------------------------------------------------------------|
+| --------------- | -------------------- | --------------------------------------------------------------------------- |
 | `db.name`       | `db.namespace`       | This attribute is used to report the name of the database being accessed.   |
 | `db.operation`  | `db.operation.name`  | The name of the operation being executed.                                   |
 | `db.sql.table`  | `db.collection.name` | The name of the primary table that the operation is acting upon.            |
diff --git a/packages/instrumentation-mysql/README.md b/packages/instrumentation-mysql/README.md
@@ -45,7 +45,7 @@ See [examples/mysql](https://github.com/open-telemetry/opentelemetry-js-contrib/
 ### MySQL instrumentation Options
 
 | 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 |
 
 
diff --git a/packages/instrumentation-nestjs-core/README.md b/packages/instrumentation-nestjs-core/README.md
@@ -55,7 +55,7 @@ This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which i
 Attributes collected:
 
 | Attribute           | Short Description                                  |
-|---------------------|----------------------------------------------------|
+| ------------------- | -------------------------------------------------- |
 | `component`*        | "@nestjs/core"                                     |
 | `nestjs.version`*   | Version of instrumented `@nestjs/core` package     |
 | `nestjs.type`*      | See [NestType](./src/enums/NestType.ts)            |
diff --git a/packages/instrumentation-net/README.md b/packages/instrumentation-net/README.md
@@ -46,7 +46,7 @@ This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which i
 Attributes added to `connect` spans:
 
 | Attribute                 | Short Description                                                        |
-|---------------------------|--------------------------------------------------------------------------|
+| ------------------------- | ------------------------------------------------------------------------ |
 | `net.transport`           | `IP.TCP`, `pipe` or `Unix`                                               |
 | `net.peer.name`           | Host name or the IPC file path                                           |
 | `net.peer.ip` (for TCP)   | Remote address of the peer (dotted decimal for IPv4 or RFC5952 for IPv6) |
diff --git a/packages/instrumentation-oracledb/README.md b/packages/instrumentation-oracledb/README.md
@@ -49,7 +49,7 @@ Caveats with  ``oracledb`` Thick mode:
 ### Oracle Instrumentation Options
 
 | Options | Type | Default | Description |
-| ------- | ---- | --------| ----------- |
+| ------- | ---- | ------- | ----------- |
 | `enhancedDatabaseReporting` | `boolean` | `false` | If true, details about the sql statement's bind values (being set on parameters ``db.operation.parameter.<key>``) and the sql string (being set on parameter ``db.query.text``) will be attached to the spans generated |
 | `dbStatementDump` | `boolean` | `false` | If true, ``db.query.text`` will contain the sql string in the spans generated |
 | `requestHook` | `OracleInstrumentationExecutionRequestHook` (function) | | Function for adding custom span attributes using information about the data for the sql statement being executed |
diff --git a/packages/instrumentation-redis/README.md b/packages/instrumentation-redis/README.md
@@ -86,7 +86,7 @@ Attributes collected:
 ### Old Semantic Conventions (default)
 
 | Attribute              | Short Description                                            |
-|------------------------|--------------------------------------------------------------|
+| ---------------------- | ------------------------------------------------------------ |
 | `db.connection_string` | URL to Redis server address, of the form `redis://host:port` |
 | `db.statement`         | Executed Redis statement                                     |
 | `db.system`            | Database identifier; always `redis`                          |
@@ -96,7 +96,7 @@ Attributes collected:
 ### Stable Semantic Conventions (v1.33.0)
 
 | Attribute              | Short Description                                            |
-|------------------------|--------------------------------------------------------------|
+| ---------------------- | ------------------------------------------------------------ |
 | `db.operation.name` | Redis command name |
 | `db.operation.batch.size` | Number of commands in a Redis `MULTI/EXEC` transaction |
 | `db.query.text`         | The database query being executed                                     |
diff --git a/packages/instrumentation-runtime-node/README.md b/packages/instrumentation-runtime-node/README.md
@@ -61,7 +61,7 @@ nodejs_performance_event_loop_utilization 0.010140079547955264
 `RuntimeNodeInstrumentation`'s constructor accepts the following options:
 
 | name | type | unit | default | description |
-|---|---|---|---------|---|
+| --- | --- | --- | ------- | --- |
 | [`monitoringPrecision`](./src/types.ts#L25) | `int` | millisecond | `10`    | The approximate number of milliseconds for which to calculate event loop utilization averages. A larger value will result in more accurate averages at the expense of less granular data. Should be set to below the scrape interval of your metrics collector to avoid duplicated data points. |
 
 ## Useful links
diff --git a/packages/instrumentation-sequelize/README.md b/packages/instrumentation-sequelize/README.md
@@ -66,7 +66,7 @@ You can set the following:
 ## Semantic Conventions
 
 | Attribute            | Short Description                                                           |
-| ---------------------| --------------------------------------------------------------------------- |
+| -------------------- | --------------------------------------------------------------------------- |
 | `db.namespace`       | The name of the database being accessed.                                    |
 | `db.operation.name`  | The name of the operation being executed (e.g. the SQL keyword).            |
 | `db.collection.name` | The name of the table being accessed.                                       |
diff --git a/packages/instrumentation-typeorm/README.md b/packages/instrumentation-typeorm/README.md
@@ -43,7 +43,7 @@ registerInstrumentations({
 You can set the following:
 
 | Options                      | Type                                   | Description                                                                   |
-| ---------------------------- | -------------------------------------- | ------------------------------------------------------------------------------|
+| ---------------------------- | -------------------------------------- | ----------------------------------------------------------------------------- |
 | `responseHook` | `TypeormResponseCustomAttributesFunction` | Hook called before response is returned, which allows to add custom attributes to span.  |
 | `suppressInternalInstrumentation` | boolean | Typeorm uses mongodb/postgres/mysql/mariadb/etc. under the hood. If, for example, postgres instrumentation is enabled, a postgres operation will also create a postgres span describing the communication. Setting the `suppressInternalInstrumentation` config value to `true` will cause the instrumentation to suppress instrumentation of underlying operations. |
 | `enableInternalInstrumentation` | boolean |  Some methods such as `getManyAndCount` can generate internally multiple spans. To instrument those set this to `true` |
@@ -54,7 +54,7 @@ You can set the following:
 Attributes collected:
 
 | Attribute            | Short Description                                                           |
-| ---------------------| --------------------------------------------------------------------------- |
+| -------------------- | --------------------------------------------------------------------------- |
 | `db.namespace`       | The name of the database being accessed.                                    |
 | `db.operation.name`  | The name of the operation being executed (e.g. the SQL keyword).            |
 | `db.collection.name` | The name of the table being accessed.                                       |
diff --git a/packages/resource-detector-alibaba-cloud/README.md b/packages/resource-detector-alibaba-cloud/README.md
@@ -35,7 +35,7 @@ This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which i
 Populates `cloud` and `host` for processes running on [Alibaba Cloud ECS](https://www.alibabacloud.com/product/ecs). More info about Alibaba Instance Identities can be found [here](https://www.alibabacloud.com/help/en/ecs/user-guide/use-instance-identities).
 
 | Resource Attribute      |  Description                                                    |
-|-------------------------|-----------------------------------------------------------------|
+| ----------------------- | --------------------------------------------------------------- |
 | cloud.account.id        | Value of `owner-account-id` on Alibaba Cloud                    |
 | cloud.availability_zone | Value of `zone-id` on Alibaba Cloud                             |
 | cloud.platform          | In this context, it's always `alibaba_cloud_ecs`                |
diff --git a/packages/resource-detector-aws/README.md b/packages/resource-detector-aws/README.md
@@ -40,7 +40,7 @@ This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which i
 Populates `service` for processes running on [AWS Elastic Beanstalk](https://aws.amazon.com/elasticbeanstalk/)
 
 | Resource Attribute  | Description                                                              |
-|---------------------|--------------------------------------------------------------------------|
+| ------------------- | ------------------------------------------------------------------------ |
 | cloud.platform      | The cloud platform. In this context, it's always "aws_elastic_beanstalk" |
 | cloud.provider      | The cloud provider. In this context, it's always "aws"                   |
 | service.instance.id | Value of `deployment_id` from config file `environment.conf`             |
@@ -53,7 +53,7 @@ Populates `service` for processes running on [AWS Elastic Beanstalk](https://aws
 Populates `cloud` and `host` for processes running on [Amazon EC2](https://aws.amazon.com/ec2/), including abstractions such as ECS on EC2. Notably, it does not populate anything on AWS Fargate.
 
 | Resource Attribute      | Description                                                                           |
-|-------------------------|---------------------------------------------------------------------------------------|
+| ----------------------- | ------------------------------------------------------------------------------------- |
 | cloud.account.id        | Value of `accountId` from `/latest/dynamic/instance-identity/document` request        |
 | cloud.availability_zone | Value of `availabilityZone` from `/latest/dynamic/instance-identity/document` request |
 | cloud.platform          | The cloud platform. In this context, it's always "aws_ec2"                            |
@@ -68,7 +68,7 @@ Populates `cloud` and `host` for processes running on [Amazon EC2](https://aws.a
 Populates `container` for containers running on [Amazon ECS](https://aws.amazon.com/ecs/).
 
 | Resource Attribute      | Description                                                                            |
-|-------------------------|----------------------------------------------------------------------------------------|
+| ----------------------- | -------------------------------------------------------------------------------------- |
 | aws.ecs.container.arn   | Value of `ContainerARN` from the request to the metadata Uri. The Metadata Uri is stored on the Environment Variable `ECS_CONTAINER_METADATA_URI_V4`  |
 | aws.ecs.cluster.arn     | Value in the format `${baseArn}:cluster/${cluster}`, with `baseArn` and `cluster` from a `ECS_CONTAINER_METADATA_URI_V4/task` request, with values from `TaskARN` and `Cluster` respectively |
 | aws.ecs.launchtype      | Value of `LaunchType` from `ECS_CONTAINER_METADATA_URI_V4/task` request                |
@@ -94,7 +94,7 @@ Populates `container` and `k8s.cluster_name` for containers running on [Amazon E
 `k8s.cluster_name` is not always available depending on the configuration of CloudWatch monitoring for the EKS cluster.
 
 | Resource Attribute | Description                                                                                         |
-|--------------------|-----------------------------------------------------------------------------------------------------|
+| ------------------ | --------------------------------------------------------------------------------------------------- |
 | cloud.platform     | The cloud platform. In this context, it's always "aws_eks"                                          |
 | cloud.provider     | The cloud provider. In this context, it's always "aws"                                              |
 | container.id       | Value from config file `/proc/self/cgroup`                                                          |
@@ -106,7 +106,7 @@ Populates `faas` and `cloud` for functions running on [AWS Lambda](https://aws.a
 `faas.id` is currently not populated as it is not provided by the runtime at startup.
 
 | Resource Attribute | Description                                                         |
-|--------------------|---------------------------------------------------------------------|
+| ------------------ | ------------------------------------------------------------------- |
 | cloud.platform     | The cloud platform. In this context, it's always "aws_lambda"       |
 | cloud.provider     | The cloud provider. In this context, it's always "aws"              |
 | cloud.region       | Value of Process Environment Variable `AWS_REGION`                  |
diff --git a/packages/resource-detector-azure/README.md b/packages/resource-detector-azure/README.md
diff --git a/packages/resource-detector-container/README.md b/packages/resource-detector-container/README.md
diff --git a/packages/resource-detector-gcp/README.md b/packages/resource-detector-gcp/README.md
diff --git a/packages/resource-detector-github/README.md b/packages/resource-detector-github/README.md
diff --git a/packages/resource-detector-instana/README.md b/packages/resource-detector-instana/README.md
