Skip to content

Commit ffd4358

Browse files
thompson-tomothompson-tomo
authored
[chore] Tweak jinja templates to improve linting (#3132)
1 parent 6836ec1 commit ffd4358

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+321
-319
lines changed

‎docs/azure/azure-events.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ semantic convention tooling supports complex attributes
4040
| `category` | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The Azure category of the log entry. | `AuditEvent`; `GatewayLogs`; `ApplicationGatewayAccessLog` |
4141
| `correlation.id` | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The correlation ID of the log entry. | `607964b6-41a5-4e24-a5db-db7aab3b9b34` |
4242
| `duration` | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | int | The duration of the operations in milliseconds. | `1000` |
43-
| `identity` | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | undefined | "A JSON blob that describes the identity of the user or application that performed the operation." [1] | |
43+
| `identity` | ![Development](https://img.shields.io/badge/-development-blue) | `Opt-In` | undefined | "A JSON blob that describes the identity of the user or application that performed the operation." [1] | |
4444
| `operation.name` | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The name of the operation. | `SecretGet`; `Microsoft.ApiManagement/GatewayLogs`; `ApplicationGatewayAccess` |
4545
| `operation.version` | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The version of the operation. | `1.0` |
46-
| `properties` | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | undefined | The properties provided in the Azure Resource Log. | |
46+
| `properties` | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | undefined | The properties provided in the Azure Resource Log. | |
4747
| `result.description` | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The description of the result. | `The operation was successful`; `The operation failed` |
4848
| `result.signature` | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The substatus of associated with the logged event. | `OK` |
4949
| `result.type` | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The status associated with the logged event. | `Succeeded`; `Failed`; `Started` |

‎docs/cicd/cicd-metrics.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ This metric is [recommended][MetricRecommended].
178178

179179
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
180180
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
181-
| `cicd.worker.count` | UpDownCounter | `{count}` | The number of workers on the CICD system by state. | ![Development](https://img.shields.io/badge/-development-blue) | |
181+
| `cicd.worker.count` | UpDownCounter | `{count}` | The number of workers on the CICD system by state. | ![Development](https://img.shields.io/badge/-development-blue) | |
182182

183183
**Attributes:**
184184

@@ -268,7 +268,7 @@ This metric is [recommended][MetricRecommended].
268268

269269
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
270270
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
271-
| `cicd.system.errors` | Counter | `{error}` | The number of errors in a component of the CICD system (eg. controller, scheduler, agent). [1] | ![Development](https://img.shields.io/badge/-development-blue) | |
271+
| `cicd.system.errors` | Counter | `{error}` | The number of errors in a component of the CICD system (eg. controller, scheduler, agent). [1] | ![Development](https://img.shields.io/badge/-development-blue) | |
272272

273273
**[1]:** Errors in pipeline run execution are explicitly excluded. Ie a test failure is not counted in this metric.
274274

@@ -607,7 +607,7 @@ This metric is [recommended][MetricRecommended].
607607

608608
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
609609
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
610-
| `vcs.repository.count` | UpDownCounter | `{repository}` | The number of repositories in an organization. | ![Development](https://img.shields.io/badge/-development-blue) | |
610+
| `vcs.repository.count` | UpDownCounter | `{repository}` | The number of repositories in an organization. | ![Development](https://img.shields.io/badge/-development-blue) | |
611611

612612
**Attributes:**
613613

‎docs/db/cassandra.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Spans representing calls to a Cassandra database adhere to the general [Semantic
4949
| [`cassandra.coordinator.dc`](/docs/registry/attributes/cassandra.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The data center of the coordinating node for a query. | `us-west-2` |
5050
| [`cassandra.coordinator.id`](/docs/registry/attributes/cassandra.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The ID of the coordinating node for a query. | `be13faa2-8574-4d71-926d-27f16cf8a7af` |
5151
| [`cassandra.page.size`](/docs/registry/attributes/cassandra.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | int | The fetch size used for paging, i.e. how many rows will be returned at once. | `5000` |
52-
| [`cassandra.query.idempotent`](/docs/registry/attributes/cassandra.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | boolean | Whether or not the query is idempotent. | |
52+
| [`cassandra.query.idempotent`](/docs/registry/attributes/cassandra.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | boolean | Whether or not the query is idempotent. | |
5353
| [`cassandra.speculative_execution.count`](/docs/registry/attributes/cassandra.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | int | The number of times a query was speculatively executed. Not set or `0` if the query was not executed speculatively. | `0`; `2` |
5454
| [`db.operation.batch.size`](/docs/registry/attributes/db.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | int | The number of queries included in a batch operation. [11] | `2`; `3`; `4` |
5555
| [`db.query.summary`](/docs/registry/attributes/db.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` [12] | string | Low cardinality summary of a database query. [13] | `SELECT wuser_table`; `INSERT shipping_details SELECT orders`; `get user by id` |

‎docs/db/cosmosdb.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Semantic conventions described in this document apply to the call-level spans on
6161
| [`error.type`](/docs/registry/attributes/error.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Conditionally Required` If and only if the operation failed. | string | Describes a class of error the operation ended with. [6] | `timeout`; `java.net.UnknownHostException`; `server_certificate_invalid`; `500` |
6262
| [`server.port`](/docs/registry/attributes/server.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Conditionally Required` If not default (443). | int | Server port number. [7] | `80`; `8080`; `443` |
6363
| [`azure.client.id`](/docs/registry/attributes/azure.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The unique identifier of the client instance. | `3ba4827d-4422-483f-b59f-85b74211c11d`; `storage-client-1` |
64-
| [`azure.cosmosdb.request.body.size`](/docs/registry/attributes/azure.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | int | Request payload size in bytes. | |
64+
| [`azure.cosmosdb.request.body.size`](/docs/registry/attributes/azure.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | int | Request payload size in bytes. | |
6565
| [`azure.resource_provider.namespace`](/docs/registry/attributes/azure.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | [Azure Resource Provider Namespace](https://learn.microsoft.com/azure/azure-resource-manager/management/azure-services-resource-providers) as recognized by the client. [8] | `Microsoft.DocumentDB` |
6666
| [`db.operation.batch.size`](/docs/registry/attributes/db.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | int | The number of queries included in a batch operation. [9] | `2`; `3`; `4` |
6767
| [`db.query.text`](/docs/registry/attributes/db.md) | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | `Recommended` | string | The database query being executed. [10] | `SELECT * FROM wuser_table where username = ?`; `SET mykey ?` |
@@ -353,7 +353,7 @@ Explaining bucket configuration:
353353

354354
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
355355
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
356-
| `azure.cosmosdb.client.operation.request_charge` | Histogram | `{request_unit}` | [Request units](https://learn.microsoft.com/azure/cosmos-db/request-units) consumed by the operation. | ![Development](https://img.shields.io/badge/-development-blue) | |
356+
| `azure.cosmosdb.client.operation.request_charge` | Histogram | `{request_unit}` | [Request units](https://learn.microsoft.com/azure/cosmos-db/request-units) consumed by the operation. | ![Development](https://img.shields.io/badge/-development-blue) | |
357357

358358
**Attributes:**
359359

@@ -441,7 +441,7 @@ It captures the number of active instances at any given time. Best practices dic
441441

442442
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
443443
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
444-
| `azure.cosmosdb.client.active_instance.count` | UpDownCounter | `{instance}` | Number of active client instances. | ![Development](https://img.shields.io/badge/-development-blue) | |
444+
| `azure.cosmosdb.client.active_instance.count` | UpDownCounter | `{instance}` | Number of active client instances. | ![Development](https://img.shields.io/badge/-development-blue) | |
445445

446446
**Attributes:**
447447

‎docs/db/database-metrics.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ of `[ 0.001, 0.005, 0.01, 0.05, 0.1, 0.5, 1, 5, 10 ]`.
7474

7575
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
7676
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
77-
| `db.client.operation.duration` | Histogram | `s` | Duration of database client operations. [1] | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | |
77+
| `db.client.operation.duration` | Histogram | `s` | Duration of database client operations. [1] | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | |
7878

7979
**[1]:** Batch operations SHOULD be recorded as a single operation.
8080

@@ -263,7 +263,7 @@ Explaining bucket configuration:
263263

264264
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
265265
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
266-
| `db.client.response.returned_rows` | Histogram | `{row}` | The actual number of records returned by the database operation. | ![Development](https://img.shields.io/badge/-development-blue) | |
266+
| `db.client.response.returned_rows` | Histogram | `{row}` | The actual number of records returned by the database operation. | ![Development](https://img.shields.io/badge/-development-blue) | |
267267

268268
**Attributes:**
269269

@@ -426,7 +426,7 @@ This metric is [required][MetricRequired].
426426

427427
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
428428
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
429-
| `db.client.connection.count` | UpDownCounter | `{connection}` | The number of connections that are currently in state described by the `state` attribute. | ![Development](https://img.shields.io/badge/-development-blue) | |
429+
| `db.client.connection.count` | UpDownCounter | `{connection}` | The number of connections that are currently in state described by the `state` attribute. | ![Development](https://img.shields.io/badge/-development-blue) | |
430430

431431
**Attributes:**
432432

@@ -459,7 +459,7 @@ This metric is [recommended][MetricRecommended].
459459

460460
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
461461
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
462-
| `db.client.connection.idle.max` | UpDownCounter | `{connection}` | The maximum number of idle open connections allowed. | ![Development](https://img.shields.io/badge/-development-blue) | |
462+
| `db.client.connection.idle.max` | UpDownCounter | `{connection}` | The maximum number of idle open connections allowed. | ![Development](https://img.shields.io/badge/-development-blue) | |
463463

464464
**Attributes:**
465465

@@ -482,7 +482,7 @@ This metric is [recommended][MetricRecommended].
482482

483483
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
484484
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
485-
| `db.client.connection.idle.min` | UpDownCounter | `{connection}` | The minimum number of idle open connections allowed. | ![Development](https://img.shields.io/badge/-development-blue) | |
485+
| `db.client.connection.idle.min` | UpDownCounter | `{connection}` | The minimum number of idle open connections allowed. | ![Development](https://img.shields.io/badge/-development-blue) | |
486486

487487
**Attributes:**
488488

@@ -505,7 +505,7 @@ This metric is [recommended][MetricRecommended].
505505

506506
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
507507
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
508-
| `db.client.connection.max` | UpDownCounter | `{connection}` | The maximum number of open connections allowed. | ![Development](https://img.shields.io/badge/-development-blue) | |
508+
| `db.client.connection.max` | UpDownCounter | `{connection}` | The maximum number of open connections allowed. | ![Development](https://img.shields.io/badge/-development-blue) | |
509509

510510
**Attributes:**
511511

@@ -528,7 +528,7 @@ This metric is [recommended][MetricRecommended].
528528

529529
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
530530
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
531-
| `db.client.connection.pending_requests` | UpDownCounter | `{request}` | The number of current pending requests for an open connection. | ![Development](https://img.shields.io/badge/-development-blue) | |
531+
| `db.client.connection.pending_requests` | UpDownCounter | `{request}` | The number of current pending requests for an open connection. | ![Development](https://img.shields.io/badge/-development-blue) | |
532532

533533
**Attributes:**
534534

@@ -551,7 +551,7 @@ This metric is [recommended][MetricRecommended].
551551

552552
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
553553
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
554-
| `db.client.connection.timeouts` | Counter | `{timeout}` | The number of connection timeouts that have occurred trying to obtain a connection from the pool. | ![Development](https://img.shields.io/badge/-development-blue) | |
554+
| `db.client.connection.timeouts` | Counter | `{timeout}` | The number of connection timeouts that have occurred trying to obtain a connection from the pool. | ![Development](https://img.shields.io/badge/-development-blue) | |
555555

556556
**Attributes:**
557557

@@ -574,7 +574,7 @@ This metric is [recommended][MetricRecommended].
574574

575575
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
576576
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
577-
| `db.client.connection.create_time` | Histogram | `s` | The time it took to create a new connection. | ![Development](https://img.shields.io/badge/-development-blue) | |
577+
| `db.client.connection.create_time` | Histogram | `s` | The time it took to create a new connection. | ![Development](https://img.shields.io/badge/-development-blue) | |
578578

579579
**Attributes:**
580580

@@ -597,7 +597,7 @@ This metric is [recommended][MetricRecommended].
597597

598598
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
599599
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
600-
| `db.client.connection.wait_time` | Histogram | `s` | The time it took to obtain an open connection from the pool. | ![Development](https://img.shields.io/badge/-development-blue) | |
600+
| `db.client.connection.wait_time` | Histogram | `s` | The time it took to obtain an open connection from the pool. | ![Development](https://img.shields.io/badge/-development-blue) | |
601601

602602
**Attributes:**
603603

@@ -620,7 +620,7 @@ This metric is [recommended][MetricRecommended].
620620

621621
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
622622
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
623-
| `db.client.connection.use_time` | Histogram | `s` | The time between borrowing a connection and returning it to the pool. | ![Development](https://img.shields.io/badge/-development-blue) | |
623+
| `db.client.connection.use_time` | Histogram | `s` | The time between borrowing a connection and returning it to the pool. | ![Development](https://img.shields.io/badge/-development-blue) | |
624624

625625
**Attributes:**
626626

0 commit comments

Comments
 (0)