open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Render events with bodies (#1464)

This commit is contained in:
Liudmila Molkova 2024-10-18 15:07:22 -07:00 committed by GitHub
parent 25f74191d7
commit ffa4e8e911
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
24 changed files with 294 additions and 204 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
docs/azure/events.md
View File

@ -7,8 +7,6 @@ Resource Log events.
## Azure Resource Log ## Azure Resource Log
### Attributes
<!-- semconv az.resource.log --> <!-- semconv az.resource.log -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 --> <!-- see templates/registry/markdown/snippet.md.j2 -->
@ -16,39 +14,43 @@ Resource Log events.
<!-- markdownlint-capture --> <!-- markdownlint-capture -->
<!-- markdownlint-disable --> <!-- markdownlint-disable -->
**Status:** ![Experimental](https://img.shields.io/badge/-experimental-blue)
The event name MUST be `az.resource.log`. The event name MUST be `az.resource.log`.
Describes Azure Resource Log event, see [Azure Resource Log Top-level Schema](https://learn.microsoft.com/azure/azure-monitor/essentials/resource-logs-schema#top-level-common-schema) for more details.
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | | Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---| |---|---|---|---|---|---|
| [`az.service_request_id`](/docs/attributes-registry/azure.md) | string | The unique identifier of the service request. It's generated by the Azure service and returned with the response. | `00000000-0000-0000-0000-000000000000` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`az.service_request_id`](/docs/attributes-registry/azure.md) | string | The unique identifier of the service request. It's generated by the Azure service and returned with the response. | `00000000-0000-0000-0000-000000000000` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| [`cloud.resource_id`](/docs/attributes-registry/cloud.md) | string | The [Fully Qualified Azure Resource ID](https://docs.microsoft.com/rest/api/resources/resources/get-by-id) the log is emitted for. | `arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function`; `//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID`; `/subscriptions/<SUBSCRIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`cloud.resource_id`](/docs/attributes-registry/cloud.md) | string | The [Fully Qualified Azure Resource ID](https://docs.microsoft.com/rest/api/resources/resources/get-by-id) the log is emitted for. | `arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function`; `//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID`; `/subscriptions/<SUBSCRIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| [`event.name`](/docs/attributes-registry/event.md) | string | Identifies the class / type of event. [1] | `browser.mouse.click`; `device.app.lifecycle` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
**[1]:** Event names are subject to the same rules as [attribute names](/docs/general/attribute-naming.md). Notably, event names are namespaced to avoid collisions and provide a clean separation of semantics for events in separate domains like browser, mobile, and kubernetes. **Body fields:**
| Body Field | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---|
| `category` | string | The Azure category of the log entry. | `AuditEvent`; `GatewayLogs`; `ApplicationGatewayAccessLog` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `correlation.id` | string | The correlation ID of the log entry. | `607964b6-41a5-4e24-a5db-db7aab3b9b34` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `duration` | int | The duration of the operations in milliseconds. | `1000` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `identity` | undefined | "A JSON blob that describes the identity of the user or application that performed the operation." [1] | | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `operation.name` | string | The name of the operation. | `SecretGet`; `Microsoft.ApiManagement/GatewayLogs`; `ApplicationGatewayAccess` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `operation.version` | string | The version of the operation. | `1.0` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `properties` | undefined | The properties provided in the Azure Resource Log. | | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `result.description` | string | The description of the result. | `The operation was successful`; `The operation failed` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `result.signature` | string | The substatus of associated with the logged event. | `OK` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `result.type` | string | The status associated with the logged event. | `Succeeded`; `Failed`; `Started` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `tenant.id` | string | The tenant ID of the Active Directory tenant that this event is tied to. | `00000000-0000-0000-0000-000000000000` | `Conditionally Required` [2] | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
**[1]:** Typically, this field includes the authorization and claims or JWT token from Active Directory.
> [!Warning]
> This field contains sensitive (PII) information.
**[2]:** if the event is tied to an Active Directory tenant.
<!-- markdownlint-restore --> <!-- markdownlint-restore -->
<!-- prettier-ignore-end --> <!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT --> <!-- END AUTOGENERATED TEXT -->
<!-- endsemconv --> <!-- endsemconv -->
### Body Fields
<!-- manually added table until body fields can be autogenerated -->
| Body Field | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---|
| `category` | string | The Azure category of the log entry. | `AuditEvent`, `GatewayLogs`, `ApplicationGatewayAccessLog` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `correlation.id` | string | The correlation ID of the log entry. | `607964b6-41a5-4e24-a5db-db7aab3b9b34` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `duration` | int | The duration of the operations in milliseconds. | `1000` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `identity` | string | A JSON blob that describes the identity of the user or application that performed the operation. | `someone` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `operation.name` | string | The name of the operation. | `SecretGet`, `Microsoft.ApiManagement/GatewayLogs`, `ApplicationGatewayAccess` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `operation.version` | string | The version of the operation. | `1.0` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `properties` | keyvaluelist | The properties provided in the Azure Resource Log. | <code>{<br/>&nbsp;&nbsp;"statusCode": "Created",<br/>&nbsp;&nbsp;"serviceRequestId": "50d5cddb-8ca0-47ad-9b80-6cde2207f97c"<br/>}</code> | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `result.type` | string | The status associated with the logged event. | `Started`, `In Progress`, `Succeeded`, `Failed`, `Active`, `Resolved` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `result.signature` | string | The substatus of associated with the logged event. | `OK` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `result.description` | string | The description of the result. | `The operation was successful`, `The operation failed` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `tenant.id` | string | The tenant ID of the Active Directory tenant that this event is tied to. | `607964b6-41a5-4e24-a5db-db7aab3b9b34` | `Conditionally Required`: if the event is tied to an Active Directory tenant. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
<!-- end of manually added table -->
See [Azure Resource Log definition](/model/azure/logs.yaml) for the details.
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

11
docs/exceptions/exceptions-spans.md
View File

@ -12,7 +12,7 @@ exceptions associated with spans.
<!-- toc --> <!-- toc -->
- [Recording an Exception](#recording-an-exception) - [Recording an Exception](#recording-an-exception)
- [Attributes](#attributes) - [Exception event](#exception-event)
- [Stacktrace Representation](#stacktrace-representation) - [Stacktrace Representation](#stacktrace-representation)
<!-- tocstop --> <!-- tocstop -->
@ -38,10 +38,7 @@ try {
} }
``` ```
## Attributes ## Exception event
The table below indicates which attributes should be added to the `Event` and
their types.
<!-- semconv trace-exception --> <!-- semconv trace-exception -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
@ -50,8 +47,12 @@ their types.
<!-- markdownlint-capture --> <!-- markdownlint-capture -->
<!-- markdownlint-disable --> <!-- markdownlint-disable -->
**Status:** ![Stable](https://img.shields.io/badge/-stable-lightgreen)
The event name MUST be `exception`. The event name MUST be `exception`.
This event describes a single exception.
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | | Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---| |---|---|---|---|---|---|
| [`exception.message`](/docs/attributes-registry/exception.md) | string | The exception message. | `Division by zero`; `Can't convert 'int' object to str implicitly` | `Conditionally Required` [1] | ![Stable](https://img.shields.io/badge/-stable-lightgreen) | | [`exception.message`](/docs/attributes-registry/exception.md) | string | The exception message. | `Division by zero`; `Can't convert 'int' object to str implicitly` | `Conditionally Required` [1] | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |

8
docs/feature-flags/feature-flags-logs.md
View File

@ -21,7 +21,7 @@ section of the trace semantic convention for feature flag evaluations.
<!-- toc --> <!-- toc -->
- [Recording an Evaluation](#recording-an-evaluation) - [Recording an Evaluation](#recording-an-evaluation)
- [Attributes](#attributes) - [Evaluation event](#evaluation-event)
<!-- tocstop --> <!-- tocstop -->
@ -32,7 +32,7 @@ Feature flag evaluations SHOULD be recorded as attributes on the
operations. Evaluations MAY be recorded on "logs" or "events" depending on the operations. Evaluations MAY be recorded on "logs" or "events" depending on the
context. context.
## Attributes ## Evaluation event
The table below indicates which attributes should be added to the The table below indicates which attributes should be added to the
[LogRecord](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.37.0/specification/logs/data-model.md#log-and-event-record-definition) and their types. [LogRecord](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.37.0/specification/logs/data-model.md#log-and-event-record-definition) and their types.
@ -44,8 +44,12 @@ The table below indicates which attributes should be added to the
<!-- markdownlint-capture --> <!-- markdownlint-capture -->
<!-- markdownlint-disable --> <!-- markdownlint-disable -->
**Status:** ![Experimental](https://img.shields.io/badge/-experimental-blue)
The event name MUST be `feature_flag`. The event name MUST be `feature_flag`.
This event describes feature flag evaluation representation on a Log Record.
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | | Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---| |---|---|---|---|---|---|
| [`feature_flag.key`](/docs/attributes-registry/feature-flag.md) | string | The unique identifier of the feature flag. | `logo-color` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`feature_flag.key`](/docs/attributes-registry/feature-flag.md) | string | The unique identifier of the feature flag. | `logo-color` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

7
docs/feature-flags/feature-flags-spans.md
View File

@ -18,6 +18,7 @@ To record an evaluation outside of a transaction context, consider
- [Motivation](#motivation) - [Motivation](#motivation)
- [Overview](#overview) - [Overview](#overview)
- [Convention](#convention) - [Convention](#convention)
- [Evaluation event](#evaluation-event)
<!-- tocstop --> <!-- tocstop -->
@ -41,6 +42,8 @@ It's intended to be vendor neutral and provide flexibility for current and futur
A flag evaluation SHOULD be recorded as an Event on the span during which it occurred. A flag evaluation SHOULD be recorded as an Event on the span during which it occurred.
### Evaluation event
<!-- semconv feature_flag --> <!-- semconv feature_flag -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/snippet.md.j2 --> <!-- see templates/registry/markdown/snippet.md.j2 -->
@ -48,8 +51,12 @@ A flag evaluation SHOULD be recorded as an Event on the span during which it occ
<!-- markdownlint-capture --> <!-- markdownlint-capture -->
<!-- markdownlint-disable --> <!-- markdownlint-disable -->
**Status:** ![Experimental](https://img.shields.io/badge/-experimental-blue)
The event name MUST be `feature_flag`. The event name MUST be `feature_flag`.
This event describes feature flag evaluation.
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | | Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---| |---|---|---|---|---|---|
| [`feature_flag.key`](/docs/attributes-registry/feature-flag.md) | string | The unique identifier of the feature flag. | `logo-color` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`feature_flag.key`](/docs/attributes-registry/feature-flag.md) | string | The unique identifier of the feature flag. | `logo-color` | `Required` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

86
docs/mobile/events.md
View File

@ -9,25 +9,16 @@ events on mobile platforms. All mobile events MUST use a namespace of
<!-- toc --> <!-- toc -->
- [Lifecycle instrumentation](#lifecycle-instrumentation) - [Lifecycle instrumentation](#lifecycle-instrumentation)
- [Event details](#event-details) - [Device app lifecycle event](#device-app-lifecycle-event)
<!-- tocstop --> <!-- tocstop -->
## Lifecycle instrumentation ## Lifecycle instrumentation
This section defines how to apply semantic conventions when instrumenting This section defines how to apply semantic conventions when instrumenting
application lifecycle. This event is meant to be used in conjunction with application lifecycle.
`os.name` [resource semantic convention](/docs/resource/os.md) to identify the
mobile operating system (e.g. Android, iOS).
The following table describes the payload fields that MUST ### Device app lifecycle event
be used to describe the state of the application at the time of the event.
The `android.state` and `ios.state` fields are mutually exclusive and MUST
NOT be used together, each field MUST be used with its corresponding
`os.name` [resource semantic convention](/docs/resource/os.md) value.
### Event details
<!-- semconv device.app.lifecycle --> <!-- semconv device.app.lifecycle -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
@ -36,45 +27,48 @@ NOT be used together, each field MUST be used with its corresponding
<!-- markdownlint-capture --> <!-- markdownlint-capture -->
<!-- markdownlint-disable --> <!-- markdownlint-disable -->
**Status:** ![Experimental](https://img.shields.io/badge/-experimental-blue)
The event name MUST be `device.app.lifecycle`. The event name MUST be `device.app.lifecycle`.
This event represents an occurrence of a lifecycle transition on Android or iOS platform.
The event body fields MUST be used to describe the state of the application at the time of the event.
This event is meant to be used in conjunction with `os.name` [resource semantic convention](/docs/resource/os.md) to identify the mobile operating system (e.g. Android, iOS).
The `android.state` and `ios.state` fields are mutually exclusive and MUST NOT be used together, each field MUST be used with its corresponding `os.name` value.
**Body fields:**
| Body Field | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---|
| `android.state` | enum | This attribute represents the state the application has transitioned into at the occurrence of the event. [1] | `created` | `Conditionally Required` if and only if `os.name` is `android` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `ios.state` | enum | This attribute represents the state the application has transitioned into at the occurrence of the event. [2] | `active` | `Conditionally Required` if and only if `os.name` is `ios` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
**[1]:** The Android lifecycle states are defined in [Activity lifecycle callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lc), and from which the `OS identifiers` are derived.
**[2]:** The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate#1656902), and from which the `OS terminology` column values are derived.
`android.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
| Value | Description | Stability |
|---|---|---|
| `background` | Any time after Activity.onPause() or, if the app has no Activity, Context.stopService() has been called when the app was in the foreground state. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `created` | Any time before Activity.onResume() or, if the app has no Activity, Context.startService() has been called in the app for the first time. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `foreground` | Any time after Activity.onResume() or, if the app has no Activity, Context.startService() has been called when the app was in either the created or background states. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
`ios.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
| Value | Description | Stability |
|---|---|---|
| `active` | The app has become `active`. Associated with UIKit notification `applicationDidBecomeActive`. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `background` | The app is now in the background. This value is associated with UIKit notification `applicationDidEnterBackground`. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `foreground` | The app is now in the foreground. This value is associated with UIKit notification `applicationWillEnterForeground`. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `inactive` | The app is now `inactive`. Associated with UIKit notification `applicationWillResignActive`. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `terminate` | The app is about to terminate. Associated with UIKit notification `applicationWillTerminate`. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
<!-- markdownlint-restore --> <!-- markdownlint-restore -->
<!-- prettier-ignore-end --> <!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT --> <!-- END AUTOGENERATED TEXT -->
<!-- endsemconv --> <!-- endsemconv -->
<!-- Manually adding the markdown table until the body definition is available in the build tools -->
| Body Field | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---|
| `android.state` | string | This attribute represents the state the application has transitioned into at the occurrence of the event. [1] | `created` | `Conditionally Required`: if and only if `os.name` is `android` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `ios.state` | string | This attribute represents the state the application has transitioned into at the occurrence of the event. [2] | `active` | `Conditionally Required`: if and only if `os.name` is `ios` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
**[1]:** The Android lifecycle states are defined in [Activity lifecycle callbacks](https://developer.android.com/guide/components/activities/activity-lifecycle#lc), and from which the `OS identifiers` are derived.
**[2]:** The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate#1656902), and from which the `OS terminology` column values are derived.
**Additional attribute requirements:** At least one of the following sets of attributes is required:
* `ios.state`
* `android.state`
`android.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
| Value | Description | Stability |
|---|---|---|
| `created` | Any time before Activity.onResume() or, if the app has no Activity, Context.startService() has been called in the app for the first time. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `background` | Any time after Activity.onPause() or, if the app has no Activity, Context.stopService() has been called when the app was in the foreground state. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `foreground` | Any time after Activity.onResume() or, if the app has no Activity, Context.startService() has been called when the app was in either the created or background states. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
`ios.state` MUST be one of the following:
| Value | Description | Stability |
|---|---|---|
| `active` | The app has become `active`. Associated with UIKit notification `applicationDidBecomeActive`. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `inactive` | The app is now `inactive`. Associated with UIKit notification `applicationWillResignActive`. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `background` | The app is now in the background. This value is associated with UIKit notification `applicationDidEnterBackground`. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `foreground` | The app is now in the foreground. This value is associated with UIKit notification `applicationWillEnterForeground`. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `terminate` | The app is about to terminate. Associated with UIKit notification `applicationWillTerminate`. | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
<!-- end of manually added table -->
[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status

11
docs/rpc/rpc-spans.md
View File

@ -19,6 +19,7 @@ This document defines how to describe remote procedure calls
- [Client attributes](#client-attributes) - [Client attributes](#client-attributes)
- [Server attributes](#server-attributes) - [Server attributes](#server-attributes)
- [Events](#events) - [Events](#events)
- [Message event](#message-event)
- [Distinction from HTTP spans](#distinction-from-http-spans) - [Distinction from HTTP spans](#distinction-from-http-spans)
- [Semantic Conventions for specific RPC technologies](#semantic-conventions-for-specific-rpc-technologies) - [Semantic Conventions for specific RPC technologies](#semantic-conventions-for-specific-rpc-technologies)
@ -242,9 +243,7 @@ different processes could be listening on TCP port 12345 and UDP port 12345.
### Events ### Events
In the lifetime of an RPC stream, an event for each message sent/received on #### Message event
client and server spans SHOULD be created. In case of unary calls only one sent
and one received message will be recorded for both client and server spans.
<!-- semconv rpc.message --> <!-- semconv rpc.message -->
<!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
@ -253,8 +252,14 @@ and one received message will be recorded for both client and server spans.
<!-- markdownlint-capture --> <!-- markdownlint-capture -->
<!-- markdownlint-disable --> <!-- markdownlint-disable -->
**Status:** ![Experimental](https://img.shields.io/badge/-experimental-blue)
The event name MUST be `rpc.message`. The event name MUST be `rpc.message`.
Describes a message sent or received within the context of an RPC call.
In the lifetime of an RPC stream, an event for each message sent/received on client and server spans SHOULD be created. In case of unary calls only one sent and one received message will be recorded for both client and server spans.
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | | Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---| |---|---|---|---|---|---|
| [`rpc.message.compressed_size`](/docs/attributes-registry/rpc.md) | int | Compressed size of the message in bytes. | | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | [`rpc.message.compressed_size`](/docs/attributes-registry/rpc.md) | int | Compressed size of the message in bytes. | | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

164
model/azure/logs.yaml
View File

@ -12,91 +12,79 @@ groups:
- ref: cloud.resource_id - ref: cloud.resource_id
brief: The [Fully Qualified Azure Resource ID](https://docs.microsoft.com/rest/api/resources/resources/get-by-id) the log is emitted for. brief: The [Fully Qualified Azure Resource ID](https://docs.microsoft.com/rest/api/resources/resources/get-by-id) the log is emitted for.
note: "" note: ""
- ref: event.name body:
# Future Note: When the build tools support this definition please uncomment and validate the details id: az.resource.log
# included here and what has been added to the manual markdown table requirement_level: recommended
# body: type: map
# fields: fields:
# - id: category - id: category
# type: string type: string
# stability: experimental stability: experimental
# brief: "The Azure category of the log entry." brief: "The Azure category of the log entry."
# examples: requirement_level: recommended
# - AuditEvent examples: ["AuditEvent", "GatewayLogs", "ApplicationGatewayAccessLog"]
# - GatewayLogs - id: correlation.id
# - ApplicationGatewayAccessLog type: string
# - id: correlation.id requirement_level: recommended
# type: string stability: experimental
# stability: experimental brief: "The correlation ID of the log entry."
# brief: "The correlation ID of the log entry." examples: ["607964b6-41a5-4e24-a5db-db7aab3b9b34"]
# examples: - id: duration
# - 607964b6-41a5-4e24-a5db-db7aab3b9b34 type: int
# - id: duration stability: experimental
# type: int requirement_level: recommended
# stability: experimental brief: "The duration of the operations in milliseconds."
# brief: "The duration of the operations in milliseconds." examples: [1000]
# examples: - id: identity
# - 1000 type: undefined
# - id: identity stability: experimental
# type: string brief: >
# stability: experimental "A JSON blob that describes the identity of the user or application that performed the operation."
# brief: > note: |
# "A JSON blob that describes the identity of the user or application that performed the operation." Typically, this field includes the authorization and claims or JWT token from Active Directory.
# note: >
# Typically, this field includes the authorization and claims or JWT token from Active Directory. > [!Warning]
# > Warning: > This field contains sensitive (PII) information.
# > this field contains sensitive (PII) information." requirement_level: opt_in
# requirement_level: opt-in - id: operation.name
# examples: type: string
# - "someone" stability: experimental
# - id: operation.name requirement_level: recommended
# type: string brief: "The name of the operation."
# stability: experimental examples: ["SecretGet", "Microsoft.ApiManagement/GatewayLogs", "ApplicationGatewayAccess"]
# brief: "The name of the operation." - id: operation.version
# examples: type: string
# - SecretGet stability: experimental
# - Microsoft.ApiManagement/GatewayLogs requirement_level: recommended
# - ApplicationGatewayAccess brief: "The version of the operation."
# - id: operation.version examples: ["1.0"]
# type: string - id: properties
# stability: experimental type: undefined
# brief: "The version of the operation." requirement_level: recommended
# examples: stability: experimental
# - "1.0" brief: The properties provided in the Azure Resource Log.
# - id: properties - id: result.type
# type: KeyValueList # note: this is not a supported type in the current build tools type: string
# stability: experimental stability: experimental
# brief: "The properties provided in the Azure Resource Log." requirement_level: recommended
# examples: <code>{<br/>&nbsp;&nbsp;"statusCode": "Created",<br/>&nbsp;&nbsp;"serviceRequestId": "50d5cddb-8ca0-47ad-9b80-6cde2207f97c"<br/>}</code> brief: The status associated with the logged event.
# - id: result.type examples: ["Succeeded", "Failed", "Started"]
# type: string - id: result.signature
# stability: experimental type: string
# brief: "The status associated with the logged event." stability: experimental
# examples: requirement_level: recommended
# - "Started" brief: The substatus of associated with the logged event.
# - "In Progress" examples: ["OK"]
# - "Succeeded" - id: result.description
# - "Failed" type: string
# - "Active" stability: experimental
# - "Resolved" requirement_level: recommended
# - id: result.signature brief: "The description of the result."
# type: string examples: ["The operation was successful", "The operation failed"]
# stability: experimental - id: tenant.id
# brief: "The substatus of associated with the logged event. " type: string
# examples: stability: experimental
# - "OK" brief: "The tenant ID of the Active Directory tenant that this event is tied to."
# - id: result.description requirement_level:
# type: string conditionally_required: "if the event is tied to an Active Directory tenant."
# stability: experimental examples: ["00000000-0000-0000-0000-000000000000"]
# brief: "The description of the result."
# examples:
# - "The operation was successful"
# - "The operation failed"
# - id: tenant.id
# type: string
# stability: experimental
# brief: "The tenant ID of the Active Directory tenant that this event is tied to."
# requirement_level:
# conditionally_required: "if the event is tied to an Active Directory tenant."
# examples:
# - "00000000-0000-0000-0000-000000000000"

13
model/device/events.yaml
View File

@ -6,9 +6,16 @@ groups:
brief: > brief: >
This event represents an occurrence of a lifecycle transition on Android or iOS platform. This event represents an occurrence of a lifecycle transition on Android or iOS platform.
note: > note: >
This event identifies the fields that are common to all lifecycle events for android and iOS using The event body fields MUST be used to describe the state of the application
the `android.state` and `ios.state` fields. The `android.state` and `ios.state` attributes are at the time of the event.
mutually exclusive.
This event is meant to be used in conjunction with `os.name`
[resource semantic convention](/docs/resource/os.md) to identify the
mobile operating system (e.g. Android, iOS).
The `android.state` and `ios.state` fields are mutually exclusive and MUST
NOT be used together, each field MUST be used with its corresponding
`os.name` value.
body: body:
id: device_lifecycle_state id: device_lifecycle_state
type: map type: map

1
model/event/common.yaml
View File

@ -1,6 +1,7 @@
groups: groups:
- id: event - id: event
type: attribute_group type: attribute_group
stability: experimental
brief: > brief: >
This document defines attributes for Events represented using Log Records. This document defines attributes for Events represented using Log Records.
attributes: attributes:

4
model/exceptions/events.yaml
View File

@ -1,10 +1,10 @@
groups: groups:
- id: trace-exception - id: trace-exception
name: exception name: exception
stability: stable
type: event type: event
brief: > brief: >
This document defines the attributes used to This event describes a single exception.
report a single exception associated with a span.
attributes: attributes:
- ref: exception.type - ref: exception.type
requirement_level: requirement_level:

4
model/feature-flag/events.yaml
View File

@ -1,10 +1,10 @@
groups: groups:
- id: feature_flag - id: feature_flag
type: event type: event
stability: experimental
name: feature_flag name: feature_flag
brief: > brief: >
This semantic convention defines the attributes used to represent a This event describes feature flag evaluation.
feature flag evaluation as an event.
attributes: attributes:
- ref: feature_flag.key - ref: feature_flag.key
requirement_level: required requirement_level: required

4
model/feature-flag/logs.yaml
View File

@ -1,10 +1,10 @@
groups: groups:
- id: log-feature_flag - id: log-feature_flag
type: event type: event
stability: experimental
name: feature_flag name: feature_flag
brief: > brief: >
This document defines attributes for feature flag evaluations This event describes feature flag evaluation representation on a Log Record.
represented using Log Records.
attributes: attributes:
- ref: feature_flag.key - ref: feature_flag.key
- ref: feature_flag.provider_name - ref: feature_flag.provider_name

1
model/feature-flag/registry.yaml
View File

@ -1,6 +1,7 @@
groups: groups:
- id: registry.feature_flag - id: registry.feature_flag
type: attribute_group type: attribute_group
stability: experimental
display_name: Feature Flag Attributes display_name: Feature Flag Attributes
brief: > brief: >
This document defines attributes for Feature Flags. This document defines attributes for Feature Flags.

7
model/rpc/spans.yaml
View File

@ -100,8 +100,13 @@ groups:
- id: rpc.message - id: rpc.message
type: event type: event
stability: experimental
name: rpc.message name: rpc.message
brief: "RPC received/sent message." brief: Describes a message sent or received within the context of an RPC call.
note: >
In the lifetime of an RPC stream, an event for each message sent/received on
client and server spans SHOULD be created. In case of unary calls only one sent
and one received message will be recorded for both client and server spans.
attributes: attributes:
- ref: rpc.message.type - ref: rpc.message.type
requirement_level: recommended requirement_level: recommended

12
policies/yaml_schema.rego
View File

@ -48,6 +48,18 @@ deny[yaml_schema_violation(description, group.id, name)] {
description := sprintf("Event name '%s' is invalid. Event name %s'", [name, invalid_name_helper]) description := sprintf("Event name '%s' is invalid. Event name %s'", [name, invalid_name_helper])
} }
# checks event.name is not referenced in event attributes
deny[yaml_schema_violation(description, group.id, name)] {
group := input.groups[_]
group.type == "event"
name := group.name
attr := group.attributes[_]
attr.ref == "event.name"
description := sprintf("Attribute 'event.name' is referenced on event group '%s'. Event name must be provided in 'name' property on the group", [name])
}
# require resources have names # require resources have names
deny[yaml_schema_violation(description, group.id, "")] { deny[yaml_schema_violation(description, group.id, "")] {
group := input.groups[_] group := input.groups[_]

8
policies/yaml_schema_test.rego
View File

@ -24,6 +24,14 @@ test_fails_on_invalid_event_name if {
} }
} }
test_fails_on_referenced_event_name_on_event if {
event := [{ "id": "yaml_schema.test",
"type": "event",
"name": "foo",
"attributes": [{"ref": "event.name"}]}]
count(deny) == 1 with input as {"groups": event}
}
test_fails_on_invalid_resource_name if { test_fails_on_invalid_resource_name if {
every name in invalid_names { every name in invalid_names {
count(deny) >= 1 with input as {"groups": create_resource(name)} count(deny) >= 1 with input as {"groups": create_resource(name)}

17
templates/registry/markdown/attribute_macros.j2
View File

@ -1,3 +1,4 @@
{% import 'examples_macros.j2' as examples %}
{% macro type(attribute) %}{%- if attribute.type is mapping %} {% macro type(attribute) %}{%- if attribute.type is mapping %}
{%- if attribute.type.members[0].value is string %}string{%- endif %} {%- if attribute.type.members[0].value is string %}string{%- endif %}
{%- if attribute.type.members[0].value is int %}int{%- endif %} {%- if attribute.type.members[0].value is int %}int{%- endif %}
@ -19,22 +20,6 @@
{% macro name_with_link(attribute, attribute_registry_base_url, lineage_attributes) %}[{{name(attribute)}}]({{attribute_registry_base_url}}/{{ find_lineage(attribute.name, lineage_attributes) | split_id | list | reject("eq", "registry")| first | kebab_case }}.md){% endmacro %} {% macro name_with_link(attribute, attribute_registry_base_url, lineage_attributes) %}[{{name(attribute)}}]({{attribute_registry_base_url}}/{{ find_lineage(attribute.name, lineage_attributes) | split_id | list | reject("eq", "registry")| first | kebab_case }}.md){% endmacro %}
{% macro print_examples(examples) %}{%- for e in examples %}{%if loop.first == false %}; {% endif %}`{{ e | trim }}`{%- endfor %}{% endmacro %}
{% macro examples(attribute) %}{%- if attribute.examples %}
{%- if "[]" in attribute.type and "template" not in attribute.type %}
{%- if attribute.examples is sequence %}
{%- if attribute.examples | select("sequence") | length == 0 %}`{{ attribute.examples | trim }}`
{%- else %}{{ print_examples(attribute.examples) }}
{%- endif %}
{%- else %}`[{{ attribute.examples | trim }}]`
{%- endif %}
{%- elif attribute.examples is sequence %}{{ print_examples(attribute.examples) }}
{%- else %}`{{ attribute.examples | trim }}`
{%- endif %}{%- elif attribute.type is mapping %}
{%- for e in attribute.type.members %}{% if loop.index0 < 3 %}{% if loop.first == false %}; {% endif %}`{{ e.value | trim }}`{% endif %}{%- endfor %}
{%- endif %}{% endmacro %}
{% macro display_name(group) %} {% macro display_name(group) %}
{%- if 'display_name' in group %}{{ group.display_name }} {%- if 'display_name' in group %}{{ group.display_name }}
{%- else %}{{ group.id | split_id | list | reject("eq", "registry") | join(" ") | title_case | acronym }} Attributes {%- else %}{{ group.id | split_id | list | reject("eq", "registry") | join(" ") | title_case | acronym }} Attributes

5
templates/registry/markdown/attribute_namespace.md.j2
View File

@ -7,6 +7,7 @@
{% import 'notes.j2' as notes %} {% import 'notes.j2' as notes %}
{% import 'enum_macros.j2' as enums %} {% import 'enum_macros.j2' as enums %}
{% import 'attribute_macros.j2' as attrs %} {% import 'attribute_macros.j2' as attrs %}
{% import 'examples_macros.j2' as examples %}
{%- set my_file_name = ctx.id | lower | kebab_case ~ ".md" -%} {%- set my_file_name = ctx.id | lower | kebab_case ~ ".md" -%}
{{- template.set_file_name(my_file_name) -}} {{- template.set_file_name(my_file_name) -}}
{%- set groups = namespace(deprecated=[], non_deprecated=[]) -%} {%- set groups = namespace(deprecated=[], non_deprecated=[]) -%}
@ -38,8 +39,8 @@
| Attribute | Type | Description | Examples | Stability | | Attribute | Type | Description | Examples | Stability |
|---|---|---|---|---| |---|---|---|---|---|
{%- for attribute in group.attributes | sort(attribute="name") %} {%- for attribute in group.attributes | sort(attribute="name") %}{% set attr_anchor = attribute.name | kebab_case %}
| <a id="{{ attribute.name | replace('.', '-') | replace('_', '-') }}" href="#{{ attribute.name | replace('.', '-') | replace('_', '-') }}">{{ attrs.name(attribute) }}</a> | {{ attrs.type(attribute) }} | {{ attribute.brief | trim }}{{ notes.add(attribute.note) }} | {{ attrs.examples(attribute) | trim }} | {{ stability.badge(attribute.stability, attribute.deprecated) | trim }} | | <a id="{{ attr_anchor }}" href="#{{ attr_anchor }}">{{ attrs.name(attribute) }}</a> | {{ attrs.type(attribute) }} | {{ attribute.brief | trim }}{{ notes.add(attribute.note) }} | {{ examples.format(attribute) | trim }} | {{ stability.badge(attribute.stability, attribute.deprecated) | trim }} |
{%- endfor %} {%- endfor %}
{{ notes.render() }} {{ notes.render() }}

3
templates/registry/markdown/attribute_table.j2
View File

@ -4,9 +4,10 @@
{% import 'attribute_macros.j2' as attrs %} {% import 'attribute_macros.j2' as attrs %}
{% import 'enum_macros.j2' as enums %} {% import 'enum_macros.j2' as enums %}
{% import 'sampling_macros.j2' as sampling %} {% import 'sampling_macros.j2' as sampling %}
{% import 'examples_macros.j2' as examples %}
{#- Macro for creating attribute table -#} {#- Macro for creating attribute table -#}
{% macro generate(attributes, tag_filter, attribute_registry_base_url, lineage_attributes) %}{% if (tag_filter | length == 0) %}{% set filtered_attributes = attributes %}{% else %}{% set filtered_attributes = attributes | selectattr("tag", "in", tag_filter) %}{% endif %}{% if filtered_attributes | length > 0 %}| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | {% macro generate(attributes, tag_filter, attribute_registry_base_url, lineage_attributes) %}{% if (tag_filter | length == 0) %}{% set filtered_attributes = attributes %}{% else %}{% set filtered_attributes = attributes | selectattr("tag", "in", tag_filter) %}{% endif %}{% if filtered_attributes | length > 0 %}| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---| |---|---|---|---|---|---|
{% for attribute in filtered_attributes | attribute_sort %}| {{ attrs.name_with_link(attribute, attribute_registry_base_url, lineage_attributes) }} | {{ attrs.type(attribute) }} | {{ attribute.brief | trim }}{{ notes.add(attribute.note) }} | {{ attrs.examples(attribute) | trim }} | {{ requirement.render(attribute.requirement_level, notes) | trim }} | {{ stability.badge(attribute.stability, attribute.deprecated) | trim }} | {% for attribute in filtered_attributes | attribute_sort %}| {{ attrs.name_with_link(attribute, attribute_registry_base_url, lineage_attributes) }} | {{ attrs.type(attribute) }} | {{ attribute.brief | trim }}{{ notes.add(attribute.note) }} | {{ examples.format(attribute) | trim }} | {{ requirement.render(attribute.requirement_level, notes) | trim }} | {{ stability.badge(attribute.stability, attribute.deprecated) | trim }} |
{% endfor %}{{ notes.render() }}{{ sampling.snippet(filtered_attributes, attribute_registry_base_url, lineage_attributes) }}{{ enums.tables(filtered_attributes | selectattr("type", "mapping"), notes) }} {% endfor %}{{ notes.render() }}{{ sampling.snippet(filtered_attributes, attribute_registry_base_url, lineage_attributes) }}{{ enums.tables(filtered_attributes | selectattr("type", "mapping"), notes) }}
{% endif %}{% endmacro %} {% endif %}{% endmacro %}

15
templates/registry/markdown/body_field_table.j2 Normal file
View File

@ -0,0 +1,15 @@
{% import 'requirement.j2' as requirement %}
{% import 'stability.j2' as stability %}
{% import 'notes.j2' as notes %}
{% import 'enum_macros.j2' as enums %}
{% import 'examples_macros.j2' as examples %}
{% macro flatten(fields, ns, depth) %}{% if fields %}{% for f in fields | sort(attribute="id") %}
{% set ns.flat = [ns.flat, [{'field':f,'depth':depth}]] | flatten %}{% if f.fields %}{% set _= flatten(f.fields, ns, depth + 1) %}{% endif %}
{% endfor %}{% endif %}{% endmacro %}
{% macro field_name(field, depth) %}{% set name= "&nbsp;" * 2 * depth ~ '`' ~ field.id ~ '`' %}{% if field.type == "map" %}{{ name ~ ":"}}{% else %}{{ name }}{% endif %}{% endmacro %}
{#- Macro for creating body table -#}
{% macro generate(fields) %}{% if (fields | length > 0) %}{% set ns = namespace(flat=[])%}{% set _ = flatten(fields, ns, 0) %}| Body Field | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|---|---|---|---|---|---|
{% for f in ns.flat %}| {{ field_name(f.field, f.depth) }} | {{ f.field.type }} | {{ f.field.brief | trim }}{{ notes.add(f.field.note) }} | {{ examples.format(f.field) | trim }} | {{ requirement.render(f.field.requirement_level, notes) | trim }} | {{ stability.badge(f.field.stability, f.field.deprecated) | trim }} |
{% endfor %}{{ notes.render() }}{{ enums.field_tables(ns.flat | map(attribute="field") | selectattr("type", "eq", "enum"), notes) -}}
{%- endif %}{% endmacro %}

13
templates/registry/markdown/enum_macros.j2
View File

@ -13,3 +13,16 @@
{% for enum in enums | sort(attribute="name") -%} {% for enum in enums | sort(attribute="name") -%}
{{ table(enum, notes) -}} {{ table(enum, notes) -}}
{% endfor %}{% endmacro %} {% endfor %}{% endmacro %}
{% macro field_table(enum, notes) %}
`{{enum.id}}` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
| Value | Description | Stability |
|---|---|---|
{% for espec in enum.members | sort(attribute='value') %}
{%- if filter(espec) == "True" -%}
| `{{ espec.value }}` | {{ (espec.brief or espec.id) | trim }}{{ notes.add(espec.note) }} | {{ stability.badge(espec.stability, espec.deprecated) }} |
{% endif %}{% endfor %}{{ notes.render() }}{% endmacro %}
{% macro field_tables(enums, notes) -%}
{% for enum in enums | sort(attribute="id") -%}
{{ field_table(enum, notes) -}}
{% endfor %}{% endmacro %}

14
templates/registry/markdown/event_macros.j2
View File

@ -1,4 +1,16 @@
{#- Macros for simplifying creating "Event" documentation. -#} {#- Macros for simplifying creating "Event" documentation. -#}
{% macro header(event) %}{% if event.name %}The event name MUST be `{{ event.name }}`. {% import 'stability.j2' as stability %}
{% import 'body_field_table.j2' as body_table %}
{% macro header(event) %}**Status:** {{ stability.badge(event.stability, event.deprecated) }}
The event name MUST be `{{ event.name }}`.
{{ event.brief | trim }}
{%if event.note %}
{{ event.note | trim }}
{% endif %}
{% endmacro %}
{% macro body(body) %}{% if body %}**Body fields:**
{{ body_table.generate(body.fields) }}
{% endif %}{% endmacro %} {% endif %}{% endmacro %}

17
templates/registry/markdown/examples_macros.j2 Normal file
View File

@ -0,0 +1,17 @@
{% macro print_examples(examples) %}{%- for e in examples %}{%if loop.first == false %}; {% endif %}`{{ e | trim }}`{%- endfor %}{% endmacro %}
{% macro format(item) %}{%- if item.examples %}
{%- if "[]" in item.type and "template" not in item.type %}
{%- if item.examples is sequence %}
{%- if item.examples | select("sequence") | length == 0 %}`{{ item.examples | trim }}`
{%- else %}{{ print_examples(item.examples) }}
{%- endif %}
{%- else %}`[{{ item.examples | trim }}]`
{%- endif %}
{%- elif item.examples is sequence %}{{ print_examples(item.examples) }}
{%- else %}`{{ item.examples | trim }}`
{%- endif %}{%- elif item.type is mapping %}
{%- for e in item.type.members %}{% if loop.index0 < 3 %}{% if loop.first == false %}; {% endif %}`{{ e.value | trim }}`{% endif %}{%- endfor %}
{%- elif item.type == "enum" -%}
{%- for e in item.members %}{% if loop.index0 < 3 %}{% if loop.first == false %}; {% endif %}`{{ e.value | trim }}`{% endif %}{%- endfor %}
{%- endif %}{% endmacro %}

23
templates/registry/markdown/snippet.md.j2
View File

@ -8,14 +8,25 @@
{%- import 'event_macros.j2' as event -%} {%- import 'event_macros.j2' as event -%}
{%- import 'resource_macros.j2' as resource %} {%- import 'resource_macros.j2' as resource %}
{% if group.type == "event" -%} {% macro generate_event(group) -%}
{{ event.header(group) }} {{ event.header(group) }}{{ generate_attributes(group) }}{{ event.body(group.body) }}{% endmacro -%}
{%- elif group.type == "resource" -%} {%- macro generate_resource(group) -%}
{{ resource.header(group) }} {{ resource.header(group) }}{{ generate_attributes(group) }}{% endmacro -%}
{%- elif group.type=="metric" -%} {%- macro generate_metric(group) -%}
{{ mt.generate(group) }} {{ mt.generate(group) }}
{{ generate_attributes(group) }}{% endmacro -%}
{%- macro generate_attributes(group) -%}
{{ at.generate(group.attributes, tag_filter, attribute_registry_base_url, group.lineage.attributes) }}{% endmacro -%}
{% if group.type == "event" -%}
{{ generate_event(group) -}}
{%- elif group.type == "resource" -%}
{{ generate_resource(group) }}
{%- elif group.type == "metric" -%}
{{ generate_metric(group) }}
{%- else -%}
{{ generate_attributes(group) -}}
{% endif -%} {% endif -%}
{{ at.generate(group.attributes, tag_filter, attribute_registry_base_url, group.lineage.attributes) -}}
<!-- markdownlint-restore --> <!-- markdownlint-restore -->
<!-- prettier-ignore-end --> <!-- prettier-ignore-end -->
<!-- END AUTOGENERATED TEXT --> <!-- END AUTOGENERATED TEXT -->