Moved resource semconv directly under the resource directory (#165)
This commit is contained in:
parent
ded7a09e07
commit
902376ef67
|
|
@ -61,5 +61,5 @@ groups:
|
|||
type: string
|
||||
brief: >
|
||||
The version string of the operating system as defined in
|
||||
[Version Attributes](../../resource/semantic_conventions/README.md#version-attributes).
|
||||
[Version Attributes](/specification/resource/README.md#version-attributes).
|
||||
examples: ['14.2.1', '18.04.1']
|
||||
|
|
|
|||
|
|
@ -170,7 +170,7 @@ groups:
|
|||
- id: service
|
||||
type: string
|
||||
brief: >
|
||||
The [`service.name`](/specification/resource/semantic_conventions/README.md#service)
|
||||
The [`service.name`](/specification/resource/README.md#service)
|
||||
of the remote service. SHOULD be equal to the actual `service.name`
|
||||
resource attribute of the remote service if any.
|
||||
examples: "AuthTokenCache"
|
||||
|
|
|
|||
|
|
@ -24,5 +24,5 @@ Semantic Conventions by signals:
|
|||
* [Events](general/events-general.md): Semantic Conventions for event data.
|
||||
* [Logs](general/logs-general.md): Semantic Conventions for logs data.
|
||||
* [Metrics](general/metrics-general.md): Semantic Conventions for metrics.
|
||||
* [Resource](resource/semantic_conventions/README.md): Semantic Conventions for resources.
|
||||
* [Resource](resource/README.md): Semantic Conventions for resources.
|
||||
* [Trace](general/trace-general.md): Semantic Conventions for traces and spans.
|
||||
|
|
|
|||
|
|
@ -102,7 +102,7 @@ grained information from a stacktrace, if necessary.
|
|||
[ruby-full-message]: https://ruby-doc.org/core-2.7.1/Exception.html#method-i-full_message
|
||||
[csharp-stacktrace]: https://docs.microsoft.com/en-us/dotnet/api/system.exception.tostring
|
||||
[go-stacktrace]: https://pkg.go.dev/runtime/debug#Stack
|
||||
[telemetry-sdk-resource]: ../resource/semantic_conventions/README.md#telemetry-sdk
|
||||
[telemetry-sdk-resource]: ../resource/README.md#telemetry-sdk
|
||||
[erlang-stacktrace]: https://www.erlang.org/doc/man/erl_error.html#format_exception-3
|
||||
[elixir-stacktrace]: https://hexdocs.pm/elixir/1.14.3/Exception.html#format/3
|
||||
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md
|
||||
|
|
|
|||
|
|
@ -51,8 +51,8 @@ and the [cloud resource conventions][cloud]. The following AWS Lambda-specific a
|
|||
<!-- endsemconv -->
|
||||
|
||||
[faas]: faas-spans.md (FaaS trace conventions)
|
||||
[faasres]: /specification/resource/semantic_conventions/faas.md (FaaS resource conventions)
|
||||
[cloud]: /specification/resource/semantic_conventions/cloud.md (Cloud resource conventions)
|
||||
[faasres]: /specification/resource/faas.md (FaaS resource conventions)
|
||||
[cloud]: /specification/resource/cloud.md (Cloud resource conventions)
|
||||
|
||||
### AWS X-Ray Environment Span Link
|
||||
|
||||
|
|
|
|||
|
|
@ -65,7 +65,7 @@ Below is a table of the attributes to be included on FaaS metric events.
|
|||
| `faas.invoked_region` | Required | Cloud provider region of invoked function. Corresponds to resource `cloud.region`. Example: `us-east-1` |
|
||||
|
||||
More details on these attributes, the function name and the difference compared to the faas.invoked_name can be found at the related [FaaS tracing specification](faas-spans.md).
|
||||
For incoming FaaS invocations, the function for which metrics are reported is already described by its [FaaS resource attributes](../resource/semantic_conventions/faas.md).
|
||||
For incoming FaaS invocations, the function for which metrics are reported is already described by its [FaaS resource attributes](../resource/faas.md).
|
||||
Outgoing FaaS invocations are identified using the `faas.invoked_*` attributes above.
|
||||
`faas.trigger` SHOULD be included in all metric events while `faas.invoked_*` attributes apply on outgoing FaaS invocation events only.
|
||||
|
||||
|
|
|
|||
|
|
@ -32,14 +32,14 @@ See also the [additional instructions for instrumenting AWS Lambda](aws-lambda.m
|
|||
|
||||
Span `name` should be set to the function name being executed. Depending on the value of the `faas.trigger` attribute, additional attributes MUST be set. For example, an `http` trigger SHOULD follow the [HTTP Server semantic conventions](/specification/http/http-spans.md#http-server-semantic-conventions). For more information, refer to the [Function Trigger Type](#function-trigger-type) section.
|
||||
|
||||
If Spans following this convention are produced, a Resource of type `faas` MUST exist following the [Resource semantic convention](../resource/semantic_conventions/faas.md#function-as-a-service).
|
||||
If Spans following this convention are produced, a Resource of type `faas` MUST exist following the [Resource semantic convention](../resource/faas.md#function-as-a-service).
|
||||
|
||||
<!-- semconv faas_span -->
|
||||
| Attribute | Type | Description | Examples | Requirement Level |
|
||||
|---|---|---|---|---|
|
||||
| `faas.trigger` | string | Type of the trigger which caused this function invocation. [1] | `datasource` | Recommended |
|
||||
| `faas.invocation_id` | string | The invocation ID of the current function invocation. | `af9d5aa4-a685-4c5f-a22b-444f80b3cc28` | Recommended |
|
||||
| [`cloud.resource_id`](../resource/semantic_conventions/cloud.md) | string | Cloud provider-specific native identifier of the monitored cloud resource (e.g. an [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) on AWS, a [fully qualified resource ID](https://learn.microsoft.com/en-us/rest/api/resources/resources/get-by-id) on Azure, a [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) on GCP) [2] | `arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function`; `//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID`; `/subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>` | Recommended |
|
||||
| [`cloud.resource_id`](../resource/cloud.md) | string | Cloud provider-specific native identifier of the monitored cloud resource (e.g. an [ARN](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) on AWS, a [fully qualified resource ID](https://learn.microsoft.com/en-us/rest/api/resources/resources/get-by-id) on Azure, a [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) on GCP) [2] | `arn:aws:lambda:REGION:ACCOUNT_ID:function:my-function`; `//run.googleapis.com/projects/PROJECT_ID/locations/LOCATION_ID/services/SERVICE_ID`; `/subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>` | Recommended |
|
||||
|
||||
**[1]:** For the server/consumer span on the incoming side,
|
||||
`faas.trigger` MUST be set.
|
||||
|
|
@ -83,7 +83,7 @@ The following well-known definitions MUST be used if you set this attribute and
|
|||
### Function Name
|
||||
|
||||
There are 2 locations where the function's name can be recorded: the span name and the
|
||||
[`faas.name` Resource attribute](../resource/semantic_conventions/faas.md#function-as-a-service).
|
||||
[`faas.name` Resource attribute](../resource/faas.md#function-as-a-service).
|
||||
|
||||
It is guaranteed that if `faas.name` attribute is present it will contain the
|
||||
function name, since it is defined in the semantic convention strictly for that
|
||||
|
|
@ -134,7 +134,7 @@ call to invoke the lambda, which is often HTTP).
|
|||
|
||||
### Resource attributes as incoming FaaS span attributes
|
||||
|
||||
In addition to the attributes listed above, any [FaaS](../resource/semantic_conventions/faas.md) or [cloud](../resource/semantic_conventions/cloud.md) resource attributes MAY
|
||||
In addition to the attributes listed above, any [FaaS](../resource/faas.md) or [cloud](../resource/cloud.md) resource attributes MAY
|
||||
instead be set as span attributes on incoming FaaS invocation spans: In some
|
||||
FaaS environments some of the information required for resource
|
||||
attributes is only readily available in the context of an invocation (e.g. as part of a "request context" argument)
|
||||
|
|
@ -180,8 +180,8 @@ which the invoked FaaS instance reports about itself, if it's instrumented.
|
|||
| `tencent_cloud` | Tencent Cloud |
|
||||
<!-- endsemconv -->
|
||||
|
||||
[FaaS resource attributes]: ../resource/semantic_conventions/faas.md
|
||||
[Cloud resource attributes]: ../resource/semantic_conventions/cloud.md
|
||||
[FaaS resource attributes]: ../resource/faas.md
|
||||
[Cloud resource attributes]: ../resource/cloud.md
|
||||
|
||||
## Function Trigger Type
|
||||
|
||||
|
|
|
|||
|
|
@ -282,7 +282,7 @@ Instrumentations SHOULD provide a way for users to configure this name.
|
|||
<!-- semconv peer -->
|
||||
| Attribute | Type | Description | Examples | Requirement Level |
|
||||
|---|---|---|---|---|
|
||||
| `peer.service` | string | The [`service.name`](/specification/resource/semantic_conventions/README.md#service) of the remote service. SHOULD be equal to the actual `service.name` resource attribute of the remote service if any. | `AuthTokenCache` | Recommended |
|
||||
| `peer.service` | string | The [`service.name`](/specification/resource/README.md#service) of the remote service. SHOULD be equal to the actual `service.name` resource attribute of the remote service if any. | `AuthTokenCache` | Recommended |
|
||||
<!-- endsemconv -->
|
||||
|
||||
Examples of `peer.service` that users may specify:
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ The following semantic conventions for logs are defined:
|
|||
|
||||
Apart from semantic conventions for logs, [events](events-general.md), [traces](trace-general.md), and [metrics](metrics-general.md),
|
||||
OpenTelemetry also defines the concept of overarching [Resources](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.21.0/specification/resource/sdk.md) with their own
|
||||
[Resource Semantic Conventions](/specification/resource/semantic_conventions/README.md).
|
||||
[Resource Semantic Conventions](/specification/resource/README.md).
|
||||
|
||||
## General log identification attributes
|
||||
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ The following semantic conventions surrounding metrics are defined:
|
|||
|
||||
Apart from semantic conventions for metrics, [traces](trace-general.md), [logs](logs-general.md), and [events](events-general.md), OpenTelemetry also
|
||||
defines the concept of overarching [Resources](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.21.0/specification/resource/sdk.md) with
|
||||
their own [Resource Semantic Conventions](/specification/resource/semantic_conventions/README.md).
|
||||
their own [Resource Semantic Conventions](/specification/resource/README.md).
|
||||
|
||||
## General Guidelines
|
||||
|
||||
|
|
|
|||
|
|
@ -30,4 +30,4 @@ The following semantic conventions for spans are defined:
|
|||
|
||||
Apart from semantic conventions for traces, [metrics](metrics-general.md), [logs](logs-general.md), and [events](events-general.md),
|
||||
OpenTelemetry also defines the concept of overarching [Resources](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.21.0/specification/resource/sdk.md) with their own
|
||||
[Resource Semantic Conventions](/specification/resource/semantic_conventions/README.md).
|
||||
[Resource Semantic Conventions](/specification/resource/README.md).
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ In case of virtualized environments, this is the operating system as it is obser
|
|||
| `os.type` | string | The operating system type. | `windows` | Required |
|
||||
| `os.description` | string | Human readable (not intended to be parsed) OS version information, like e.g. reported by `ver` or `lsb_release -a` commands. | `Microsoft Windows [Version 10.0.18363.778]`; `Ubuntu 18.04.1 LTS` | Recommended |
|
||||
| `os.name` | string | Human readable operating system name. | `iOS`; `Android`; `Ubuntu` | Recommended |
|
||||
| `os.version` | string | The version string of the operating system as defined in [Version Attributes](../../resource/semantic_conventions/README.md#version-attributes). | `14.2.1`; `18.04.1` | Recommended |
|
||||
| `os.version` | string | The version string of the operating system as defined in [Version Attributes](/specification/resource/README.md#version-attributes). | `14.2.1`; `18.04.1` | Recommended |
|
||||
|
||||
`os.type` 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.
|
||||
|
||||
|
|
@ -138,7 +138,7 @@ For server-side spans `server.port` is optional (it describes the port the clien
|
|||
On the server process receiving and handling the remote procedure call, the service name provided in `rpc.service` does not necessarily have to match the [`service.name`][] resource attribute.
|
||||
One process can expose multiple RPC endpoints and thus have multiple RPC service names. From a deployment perspective, as expressed by the `service.*` resource attributes, it will be treated as one deployed service with one `service.name`.
|
||||
|
||||
[`service.name`]: /specification/resource/semantic_conventions/README.md#service
|
||||
[`service.name`]: /specification/resource/README.md#service
|
||||
|
||||
## Semantic Conventions for specific RPC technologies
|
||||
|
||||
|
|
|
|||
|
|
@ -128,7 +128,7 @@ In this example, spans representing client request should have their `peer.servi
|
|||
Generally, a user SHOULD NOT set `peer.service` to a fully qualified RPC service name.
|
||||
|
||||
[network attributes]: /specification/general/general-attributes.md#server-and-client-attributes
|
||||
[`service.name`]: /specification/resource/semantic_conventions/README.md#service
|
||||
[`service.name`]: /specification/resource/README.md#service
|
||||
[`peer.service`]: /specification/general/general-attributes.md#general-remote-service-attributes
|
||||
|
||||
### Client attributes
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ when creating instruments not explicitly defined in the specification.
|
|||
|
||||
## Common hardware attributes
|
||||
|
||||
All metrics in `hw.` instruments should be attached to a [Host Resource](/specification/resource/semantic_conventions/host.md)
|
||||
All metrics in `hw.` instruments should be attached to a [Host Resource](/specification/resource/host.md)
|
||||
and therefore inherit its attributes, like `host.id` and `host.name`.
|
||||
|
||||
Additionally, all metrics in `hw.` instruments have the following attributes:
|
||||
|
|
|
|||
|
|
@ -46,6 +46,6 @@ Below is a table of Process metric instruments.
|
|||
|
||||
## Attributes
|
||||
|
||||
Process metrics SHOULD be associated with a [`process`](/specification/resource/semantic_conventions/process.md#process) resource whose attributes provide additional context about the process.
|
||||
Process metrics SHOULD be associated with a [`process`](/specification/resource/process.md#process) resource whose attributes provide additional context about the process.
|
||||
|
||||
[DocumentStatus]: https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/document-status.md
|
||||
|
|
|
|||
|
|
@ -71,7 +71,7 @@ consider, for example pthreads vs green thread implementations.
|
|||
|
||||
## Attributes
|
||||
|
||||
[`process.runtime`](/specification/resource/semantic_conventions/process.md#process-runtimes) resource attributes SHOULD be included on runtime metric events as appropriate.
|
||||
[`process.runtime`](/specification/resource/process.md#process-runtimes) resource attributes SHOULD be included on runtime metric events as appropriate.
|
||||
|
||||
## JVM Metrics
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue