[SemanticConvention] Bump to 1.38.0 (#3365)

Co-authored-by: Martin Costello <[email protected]>

Author: Kielek

src/OpenTelemetry.SemanticConventions/.publicApi/PublicAPI.Unshipped.txt

@@ -72,6 +72,22 @@ public static class AppAttributes
     /// </summary>
     public const string AttributeAppScreenCoordinateY = "app.screen.coordinate.y";
 
+    /// <summary>
+    /// An identifier that uniquely differentiates this screen from other screens in the same application.
+    /// </summary>
+    /// <remarks>
+    /// A screen represents only the part of the device display drawn by the app. It typically contains multiple widgets or UI components and is larger in scope than individual widgets. Multiple screens can coexist on the same display simultaneously (e.g., split view on tablets).
+    /// </remarks>
+    public const string AttributeAppScreenId = "app.screen.id";
+
+    /// <summary>
+    /// The name of an application screen.
+    /// </summary>
+    /// <remarks>
+    /// A screen represents only the part of the device display drawn by the app. It typically contains multiple widgets or UI components and is larger in scope than individual widgets. Multiple screens can coexist on the same display simultaneously (e.g., split view on tablets).
+    /// </remarks>
+    public const string AttributeAppScreenName = "app.screen.name";
+
     /// <summary>
     /// An identifier that uniquely differentiates this widget from other widgets in the same application.
     /// </summary>

src/OpenTelemetry.SemanticConventions/Attributes/AppAttributes.cs

@@ -33,7 +33,7 @@ public static class AzureAttributes
     /// List of regions contacted during operation in the order that they were contacted. If there is more than one region listed, it indicates that the operation was performed on multiple regions i.e. cross-regional call.
     /// </summary>
     /// <remarks>
-    /// Region name matches the format of <c>displayName</c> in <a href="https://learn.microsoft.com/rest/api/subscription/subscriptions/list-locations?view=rest-subscription-2021-10-01&tabs=HTTP#location">Azure Location API</a>.
+    /// Region name matches the format of <c>displayName</c> in <a href="https://learn.microsoft.com/rest/api/resources/subscriptions/list-locations">Azure Location API</a>.
     /// </remarks>
     public const string AttributeAzureCosmosdbOperationContactedRegions = "azure.cosmosdb.operation.contacted_regions";
 

src/OpenTelemetry.SemanticConventions/Attributes/AzureAttributes.cs

@@ -63,7 +63,7 @@ public static class ContainerAttributes
     /// Runtime specific image identifier. Usually a hash algorithm followed by a UUID.
     /// </summary>
     /// <remarks>
-    /// Docker defines a sha256 of the image id; <c>container.image.id</c> corresponds to the <c>Image</c> field from the Docker container inspect <a href="https://docs.docker.com/engine/api/v1.43/#tag/Container/operation/ContainerInspect">API</a> endpoint.
+    /// Docker defines a sha256 of the image id; <c>container.image.id</c> corresponds to the <c>Image</c> field from the Docker container inspect <a href="https://docs.docker.com/reference/api/engine/version/v1.43/#tag/Container/operation/ContainerInspect">API</a> endpoint.
     /// K8s defines a link to the container registry repository with digest <c>"imageID": "registry.azurecr.io /namespace/service/dockerfile@sha256:bdeabd40c3a8a492eaf9e8e44d0ebbb84bac7ee25ac0cf8a7159d25f62555625"</c>.
     /// The ID is assigned by the container runtime and can vary in different environments. Consider using <c>oci.manifest.digest</c> if it is important to identify the same image in different environments/runtimes.
     /// </remarks>
@@ -78,12 +78,12 @@ public static class ContainerAttributes
     /// Repo digests of the container image as provided by the container runtime.
     /// </summary>
     /// <remarks>
-    /// <a href="https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect">Docker</a> and <a href="https://github.com/kubernetes/cri-api/blob/c75ef5b473bbe2d0a4fc92f82235efd665ea8e9f/pkg/apis/runtime/v1/api.proto#L1237-L1238">CRI</a> report those under the <c>RepoDigests</c> field.
+    /// <a href="https://docs.docker.com/reference/api/engine/version/v1.43/#tag/Image/operation/ImageInspect">Docker</a> and <a href="https://github.com/kubernetes/cri-api/blob/c75ef5b473bbe2d0a4fc92f82235efd665ea8e9f/pkg/apis/runtime/v1/api.proto#L1237-L1238">CRI</a> report those under the <c>RepoDigests</c> field.
     /// </remarks>
     public const string AttributeContainerImageRepoDigests = "container.image.repo_digests";
 
     /// <summary>
-    /// Container image tags. An example can be found in <a href="https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect">Docker Image Inspect</a>. Should be only the <c><tag></c> section of the full name for example from <c>registry.example.com/my-org/my-image:<tag></c>.
+    /// Container image tags. An example can be found in <a href="https://docs.docker.com/reference/api/engine/version/v1.43/#tag/Image/operation/ImageInspect">Docker Image Inspect</a>. Should be only the <c><tag></c> section of the full name for example from <c>registry.example.com/my-org/my-image:<tag></c>.
     /// </summary>
     public const string AttributeContainerImageTags = "container.image.tags";
 

src/OpenTelemetry.SemanticConventions/Attributes/ContainerAttributes.cs

@@ -151,7 +151,7 @@ public static class DbAttributes
     /// <summary>
     /// Deprecated, use <c>db.response.status_code</c> instead.
     /// </summary>
-    [Obsolete("Replaced by <c>db.response.status_code</c>.")]
+    [Obsolete("Use <c>db.response.status_code</c> instead.")]
     public const string AttributeDbCosmosdbStatusCode = "db.cosmosdb.status_code";
 
     /// <summary>
@@ -275,14 +275,17 @@ public static class DbAttributes
     /// <c>db.query.parameter.<key></c> SHOULD match
     /// up with the parameterized placeholders present in <c>db.query.text</c>.
     /// <p>
+    /// It is RECOMMENDED to capture the value as provided by the application
+    /// without attempting to do any case normalization.
+    /// <p>
     /// <c>db.query.parameter.<key></c> SHOULD NOT be captured on batch operations.
     /// <p>
     /// Examples:
     /// <ul>
     ///   <li>For a query <c>SELECT * FROM users where username =  %s</c> with the parameter <c>"jdoe"</c>,
     /// the attribute <c>db.query.parameter.0</c> SHOULD be set to <c>"jdoe"</c>.</li>
-    ///   <li>For a query <c>"SELECT * FROM users WHERE username = %(username)s;</c> with parameter
-    /// <c>username = "jdoe"</c>, the attribute <c>db.query.parameter.username</c> SHOULD be set to <c>"jdoe"</c>.</li>
+    ///   <li>For a query <c>"SELECT * FROM users WHERE username = %(userName)s;</c> with parameter
+    /// <c>userName = "jdoe"</c>, the attribute <c>db.query.parameter.userName</c> SHOULD be set to <c>"jdoe"</c>.</li>
     /// </ul>
     /// </remarks>
     public const string AttributeDbQueryParameterTemplate = "db.query.parameter";
@@ -316,7 +319,7 @@ public static class DbAttributes
     /// <summary>
     /// Deprecated, use <c>db.namespace</c> instead.
     /// </summary>
-    [Obsolete("Replaced by <c>db.namespace</c>.")]
+    [Obsolete("Uncategorized.")]
     public const string AttributeDbRedisDatabaseIndex = "db.redis.database_index";
 
     /// <summary>

src/OpenTelemetry.SemanticConventions/Attributes/DbAttributes.cs

@@ -23,7 +23,7 @@ public static class DnsAttributes
     /// The name being queried.
     /// </summary>
     /// <remarks>
-    /// If the name field contains non-printable characters (below 32 or above 126), those characters should be represented as escaped base 10 integers (\DDD). Back slashes and quotes should be escaped. Tabs, carriage returns, and line feeds should be converted to \t, \r, and \n respectively.
+    /// The name represents the queried domain name as it appears in the DNS query without any additional normalization.
     /// </remarks>
     public const string AttributeDnsQuestionName = "dns.question.name";
 }

src/OpenTelemetry.SemanticConventions/Attributes/DnsAttributes.cs

@@ -39,7 +39,7 @@ public static class EnduserAttributes
     /// <summary>
     /// Deprecated, use <c>user.roles</c> instead.
     /// </summary>
-    [Obsolete("Replaced by <c>user.roles</c>.")]
+    [Obsolete("Use <c>user.roles</c> instead.")]
     public const string AttributeEnduserRole = "enduser.role";
 
     /// <summary>

src/OpenTelemetry.SemanticConventions/Attributes/EnduserAttributes.cs

@@ -17,6 +17,6 @@ public static class EventAttributes
     /// <summary>
     /// Identifies the class / type of event.
     /// </summary>
-    [Obsolete("Replaced by EventName top-level field on the LogRecord.")]
+    [Obsolete("The value of this attribute MUST now be set as the value of the EventName field on the LogRecord to indicate that the LogRecord represents an Event.")]
     public const string AttributeEventName = "event.name";
 }

src/OpenTelemetry.SemanticConventions/Attributes/EventAttributes.cs

@@ -136,7 +136,7 @@ public static class FaasAttributes
     ///   <li><strong>Google Cloud Run (Services):</strong> The <a href="https://cloud.google.com/run/docs/managing/revisions">revision</a>
     /// (i.e., the function name plus the revision suffix).</li>
     ///   <li><strong>Google Cloud Functions:</strong> The value of the
-    /// <a href="https://cloud.google.com/functions/docs/env-var#runtime_environment_variables_set_automatically"><c>K_REVISION</c> environment variable</a>.</li>
+    /// <a href="https://cloud.google.com/run/docs/container-contract#services-env-vars"><c>K_REVISION</c> environment variable</a>.</li>
     ///   <li><strong>Azure Functions:</strong> Not applicable. Do not set this attribute.</li>
     /// </ul>
     /// </remarks>

src/OpenTelemetry.SemanticConventions/Attributes/FaasAttributes.cs

@@ -71,6 +71,51 @@ public static class GcpAttributes
     /// </summary>
     public const string AttributeGcpApphubWorkloadId = "gcp.apphub.workload.id";
 
+    /// <summary>
+    /// The container within GCP where the AppHub destination application is defined.
+    /// </summary>
+    public const string AttributeGcpApphubDestinationApplicationContainer = "gcp.apphub_destination.application.container";
+
+    /// <summary>
+    /// The name of the destination application as configured in AppHub.
+    /// </summary>
+    public const string AttributeGcpApphubDestinationApplicationId = "gcp.apphub_destination.application.id";
+
+    /// <summary>
+    /// The GCP zone or region where the destination application is defined.
+    /// </summary>
+    public const string AttributeGcpApphubDestinationApplicationLocation = "gcp.apphub_destination.application.location";
+
+    /// <summary>
+    /// Criticality of a destination workload indicates its importance to the business as specified in <a href="https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type">AppHub type enum</a>.
+    /// </summary>
+    public const string AttributeGcpApphubDestinationServiceCriticalityType = "gcp.apphub_destination.service.criticality_type";
+
+    /// <summary>
+    /// Software lifecycle stage of a destination service as defined <a href="https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1">AppHub environment type</a>.
+    /// </summary>
+    public const string AttributeGcpApphubDestinationServiceEnvironmentType = "gcp.apphub_destination.service.environment_type";
+
+    /// <summary>
+    /// The name of the destination service as configured in AppHub.
+    /// </summary>
+    public const string AttributeGcpApphubDestinationServiceId = "gcp.apphub_destination.service.id";
+
+    /// <summary>
+    /// Criticality of a destination workload indicates its importance to the business as specified in <a href="https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type">AppHub type enum</a>.
+    /// </summary>
+    public const string AttributeGcpApphubDestinationWorkloadCriticalityType = "gcp.apphub_destination.workload.criticality_type";
+
+    /// <summary>
+    /// Environment of a destination workload is the stage of a software lifecycle as provided in the <a href="https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1">AppHub environment type</a>.
+    /// </summary>
+    public const string AttributeGcpApphubDestinationWorkloadEnvironmentType = "gcp.apphub_destination.workload.environment_type";
+
+    /// <summary>
+    /// The name of the destination workload as configured in AppHub.
+    /// </summary>
+    public const string AttributeGcpApphubDestinationWorkloadId = "gcp.apphub_destination.workload.id";
+
     /// <summary>
     /// Identifies the Google Cloud service for which the official client library is intended.
     /// </summary>
@@ -202,4 +247,108 @@ public static class GcpApphubWorkloadEnvironmentTypeValues
         /// </summary>
         public const string Development = "DEVELOPMENT";
     }
+
+    /// <summary>
+    /// Criticality of a destination workload indicates its importance to the business as specified in <a href="https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type">AppHub type enum</a>.
+    /// </summary>
+    public static class GcpApphubDestinationServiceCriticalityTypeValues
+    {
+        /// <summary>
+        /// Mission critical service.
+        /// </summary>
+        public const string MissionCritical = "MISSION_CRITICAL";
+
+        /// <summary>
+        /// High impact.
+        /// </summary>
+        public const string High = "HIGH";
+
+        /// <summary>
+        /// Medium impact.
+        /// </summary>
+        public const string Medium = "MEDIUM";
+
+        /// <summary>
+        /// Low impact.
+        /// </summary>
+        public const string Low = "LOW";
+    }
+
+    /// <summary>
+    /// Software lifecycle stage of a destination service as defined <a href="https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1">AppHub environment type</a>.
+    /// </summary>
+    public static class GcpApphubDestinationServiceEnvironmentTypeValues
+    {
+        /// <summary>
+        /// Production environment.
+        /// </summary>
+        public const string Production = "PRODUCTION";
+
+        /// <summary>
+        /// Staging environment.
+        /// </summary>
+        public const string Staging = "STAGING";
+
+        /// <summary>
+        /// Test environment.
+        /// </summary>
+        public const string Test = "TEST";
+
+        /// <summary>
+        /// Development environment.
+        /// </summary>
+        public const string Development = "DEVELOPMENT";
+    }
+
+    /// <summary>
+    /// Criticality of a destination workload indicates its importance to the business as specified in <a href="https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type">AppHub type enum</a>.
+    /// </summary>
+    public static class GcpApphubDestinationWorkloadCriticalityTypeValues
+    {
+        /// <summary>
+        /// Mission critical service.
+        /// </summary>
+        public const string MissionCritical = "MISSION_CRITICAL";
+
+        /// <summary>
+        /// High impact.
+        /// </summary>
+        public const string High = "HIGH";
+
+        /// <summary>
+        /// Medium impact.
+        /// </summary>
+        public const string Medium = "MEDIUM";
+
+        /// <summary>
+        /// Low impact.
+        /// </summary>
+        public const string Low = "LOW";
+    }
+
+    /// <summary>
+    /// Environment of a destination workload is the stage of a software lifecycle as provided in the <a href="https://cloud.google.com/app-hub/docs/reference/rest/v1/Attributes#type_1">AppHub environment type</a>.
+    /// </summary>
+    public static class GcpApphubDestinationWorkloadEnvironmentTypeValues
+    {
+        /// <summary>
+        /// Production environment.
+        /// </summary>
+        public const string Production = "PRODUCTION";
+
+        /// <summary>
+        /// Staging environment.
+        /// </summary>
+        public const string Staging = "STAGING";
+
+        /// <summary>
+        /// Test environment.
+        /// </summary>
+        public const string Test = "TEST";
+
+        /// <summary>
+        /// Development environment.
+        /// </summary>
+        public const string Development = "DEVELOPMENT";
+    }
 }