diff --git a/semantic_conventions/resource/os.yaml b/semantic_conventions/resource/os.yaml index ffccef3281..c1b8c7ef9d 100644 --- a/semantic_conventions/resource/os.yaml +++ b/semantic_conventions/resource/os.yaml @@ -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'] diff --git a/semantic_conventions/trace/general.yaml b/semantic_conventions/trace/general.yaml index b53576a5db..fd1e3136d1 100644 --- a/semantic_conventions/trace/general.yaml +++ b/semantic_conventions/trace/general.yaml @@ -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" diff --git a/specification/README.md b/specification/README.md index 448a6a9153..fe9c908ff0 100644 --- a/specification/README.md +++ b/specification/README.md @@ -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. diff --git a/specification/exceptions/exceptions-spans.md b/specification/exceptions/exceptions-spans.md index 999c975f2b..91476ab9d4 100644 --- a/specification/exceptions/exceptions-spans.md +++ b/specification/exceptions/exceptions-spans.md @@ -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 diff --git a/specification/faas/aws-lambda.md b/specification/faas/aws-lambda.md index 34e6a2b0e6..e74d8830dc 100644 --- a/specification/faas/aws-lambda.md +++ b/specification/faas/aws-lambda.md @@ -51,8 +51,8 @@ and the [cloud resource conventions][cloud]. The following AWS Lambda-specific a [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 diff --git a/specification/faas/faas-metrics.md b/specification/faas/faas-metrics.md index 631be8236c..4f63072b1d 100644 --- a/specification/faas/faas-metrics.md +++ b/specification/faas/faas-metrics.md @@ -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. diff --git a/specification/faas/faas-spans.md b/specification/faas/faas-spans.md index f561665e2b..32f60878e8 100644 --- a/specification/faas/faas-spans.md +++ b/specification/faas/faas-spans.md @@ -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). | 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//resourceGroups//providers/Microsoft.Web/sites//functions/` | 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//resourceGroups//providers/Microsoft.Web/sites//functions/` | 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 | -[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 diff --git a/specification/general/general-attributes.md b/specification/general/general-attributes.md index 470f54ffd7..8878f97ea1 100644 --- a/specification/general/general-attributes.md +++ b/specification/general/general-attributes.md @@ -282,7 +282,7 @@ Instrumentations SHOULD provide a way for users to configure this name. | 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 | Examples of `peer.service` that users may specify: diff --git a/specification/general/logs-general.md b/specification/general/logs-general.md index 1df2c582af..507c6ef4f4 100644 --- a/specification/general/logs-general.md +++ b/specification/general/logs-general.md @@ -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 diff --git a/specification/general/metrics-general.md b/specification/general/metrics-general.md index 9fa2cf7b41..3967fec947 100644 --- a/specification/general/metrics-general.md +++ b/specification/general/metrics-general.md @@ -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 diff --git a/specification/general/trace-general.md b/specification/general/trace-general.md index b477e8fd41..a54c737704 100644 --- a/specification/general/trace-general.md +++ b/specification/general/trace-general.md @@ -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). diff --git a/specification/resource/semantic_conventions/README.md b/specification/resource/README.md similarity index 99% rename from specification/resource/semantic_conventions/README.md rename to specification/resource/README.md index 4be3ec3868..5fa0b29287 100644 --- a/specification/resource/semantic_conventions/README.md +++ b/specification/resource/README.md @@ -63,7 +63,7 @@ These are the attributes which MUST be provided by the SDK as specified in the [Resource SDK specification](https://github.com/open-telemetry/opentelemetry-specification/tree/v1.21.0/specification/resource/sdk.md#sdk-provided-resource-attributes): - [`service.name`](#service) -- [`telemetry.sdk` group](#telemetry-sdk) +- [`telemetry.sdk`group](#telemetry-sdk) ## Service diff --git a/specification/resource/semantic_conventions/browser.md b/specification/resource/browser.md similarity index 100% rename from specification/resource/semantic_conventions/browser.md rename to specification/resource/browser.md diff --git a/specification/resource/semantic_conventions/cloud.md b/specification/resource/cloud.md similarity index 100% rename from specification/resource/semantic_conventions/cloud.md rename to specification/resource/cloud.md diff --git a/specification/resource/semantic_conventions/cloud_provider/aws/README.md b/specification/resource/cloud_provider/aws/README.md similarity index 100% rename from specification/resource/semantic_conventions/cloud_provider/aws/README.md rename to specification/resource/cloud_provider/aws/README.md diff --git a/specification/resource/semantic_conventions/cloud_provider/aws/ecs.md b/specification/resource/cloud_provider/aws/ecs.md similarity index 100% rename from specification/resource/semantic_conventions/cloud_provider/aws/ecs.md rename to specification/resource/cloud_provider/aws/ecs.md diff --git a/specification/resource/semantic_conventions/cloud_provider/aws/eks.md b/specification/resource/cloud_provider/aws/eks.md similarity index 100% rename from specification/resource/semantic_conventions/cloud_provider/aws/eks.md rename to specification/resource/cloud_provider/aws/eks.md diff --git a/specification/resource/semantic_conventions/cloud_provider/aws/logs.md b/specification/resource/cloud_provider/aws/logs.md similarity index 100% rename from specification/resource/semantic_conventions/cloud_provider/aws/logs.md rename to specification/resource/cloud_provider/aws/logs.md diff --git a/specification/resource/semantic_conventions/cloud_provider/gcp/README.md b/specification/resource/cloud_provider/gcp/README.md similarity index 100% rename from specification/resource/semantic_conventions/cloud_provider/gcp/README.md rename to specification/resource/cloud_provider/gcp/README.md diff --git a/specification/resource/semantic_conventions/cloud_provider/gcp/cloud_run.md b/specification/resource/cloud_provider/gcp/cloud_run.md similarity index 100% rename from specification/resource/semantic_conventions/cloud_provider/gcp/cloud_run.md rename to specification/resource/cloud_provider/gcp/cloud_run.md diff --git a/specification/resource/semantic_conventions/cloud_provider/gcp/gce.md b/specification/resource/cloud_provider/gcp/gce.md similarity index 100% rename from specification/resource/semantic_conventions/cloud_provider/gcp/gce.md rename to specification/resource/cloud_provider/gcp/gce.md diff --git a/specification/resource/semantic_conventions/cloud_provider/heroku.md b/specification/resource/cloud_provider/heroku.md similarity index 100% rename from specification/resource/semantic_conventions/cloud_provider/heroku.md rename to specification/resource/cloud_provider/heroku.md diff --git a/specification/resource/semantic_conventions/container.md b/specification/resource/container.md similarity index 100% rename from specification/resource/semantic_conventions/container.md rename to specification/resource/container.md diff --git a/specification/resource/semantic_conventions/deployment_environment.md b/specification/resource/deployment_environment.md similarity index 100% rename from specification/resource/semantic_conventions/deployment_environment.md rename to specification/resource/deployment_environment.md diff --git a/specification/resource/semantic_conventions/device.md b/specification/resource/device.md similarity index 100% rename from specification/resource/semantic_conventions/device.md rename to specification/resource/device.md diff --git a/specification/resource/semantic_conventions/faas.md b/specification/resource/faas.md similarity index 100% rename from specification/resource/semantic_conventions/faas.md rename to specification/resource/faas.md diff --git a/specification/resource/semantic_conventions/host.md b/specification/resource/host.md similarity index 100% rename from specification/resource/semantic_conventions/host.md rename to specification/resource/host.md diff --git a/specification/resource/semantic_conventions/k8s.md b/specification/resource/k8s.md similarity index 100% rename from specification/resource/semantic_conventions/k8s.md rename to specification/resource/k8s.md diff --git a/specification/resource/semantic_conventions/os.md b/specification/resource/os.md similarity index 91% rename from specification/resource/semantic_conventions/os.md rename to specification/resource/os.md index 9344e5ea1c..16798bdfeb 100644 --- a/specification/resource/semantic_conventions/os.md +++ b/specification/resource/os.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. diff --git a/specification/resource/semantic_conventions/process.md b/specification/resource/process.md similarity index 100% rename from specification/resource/semantic_conventions/process.md rename to specification/resource/process.md diff --git a/specification/resource/semantic_conventions/webengine.md b/specification/resource/webengine.md similarity index 100% rename from specification/resource/semantic_conventions/webengine.md rename to specification/resource/webengine.md diff --git a/specification/rpc/rpc-metrics.md b/specification/rpc/rpc-metrics.md index a6eac6d456..3f85cc82f5 100644 --- a/specification/rpc/rpc-metrics.md +++ b/specification/rpc/rpc-metrics.md @@ -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 diff --git a/specification/rpc/rpc-spans.md b/specification/rpc/rpc-spans.md index af32daeb54..b7bb3c0226 100644 --- a/specification/rpc/rpc-spans.md +++ b/specification/rpc/rpc-spans.md @@ -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 diff --git a/specification/system/hardware-metrics.md b/specification/system/hardware-metrics.md index 440597af9d..b202f5d695 100644 --- a/specification/system/hardware-metrics.md +++ b/specification/system/hardware-metrics.md @@ -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: diff --git a/specification/system/process-metrics.md b/specification/system/process-metrics.md index ebf612f1e1..5a5994e43b 100644 --- a/specification/system/process-metrics.md +++ b/specification/system/process-metrics.md @@ -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 diff --git a/specification/system/runtime-environment-metrics.md b/specification/system/runtime-environment-metrics.md index d5cbebdc1b..114c5b4b06 100644 --- a/specification/system/runtime-environment-metrics.md +++ b/specification/system/runtime-environment-metrics.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