[SemanticConvention] Bump to v1.28.0 (open-telemetry#2189)

Co-authored-by: Cijo Thomas <[email protected]>

Author: Kielek

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

@@ -25,6 +25,7 @@ public static class AndroidAttributes
     /// <remarks>
     /// The Android lifecycle states are defined in <a href="https://developer.android.com/guide/components/activities/activity-lifecycle#lc">Activity lifecycle callbacks</a>, and from which the <c>OS identifiers</c> are derived.
     /// </remarks>
+    [Obsolete("Replaced by <c>device.app.lifecycle</c>.")]
     public const string AttributeAndroidState = "android.state";
 
     /// <summary>
@@ -35,16 +36,19 @@ public static class AndroidStateValues
         /// <summary>
         /// Any time before Activity.onResume() or, if the app has no Activity, Context.startService() has been called in the app for the first time.
         /// </summary>
+        [Obsolete("Replaced by <c>device.app.lifecycle</c>.")]
         public const string Created = "created";
 
         /// <summary>
         /// 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.
         /// </summary>
+        [Obsolete("Replaced by <c>device.app.lifecycle</c>.")]
         public const string Background = "background";
 
         /// <summary>
         /// 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.
         /// </summary>
+        [Obsolete("Replaced by <c>device.app.lifecycle</c>.")]
         public const string Foreground = "foreground";
     }
 }

src/OpenTelemetry.SemanticConventions/Attributes/AndroidAttributes.cs

@@ -14,6 +14,11 @@ namespace OpenTelemetry.SemanticConventions;
 /// </summary>
 public static class AzAttributes
 {
+    /// <summary>
+    /// <a href="https://learn.microsoft.com/azure/azure-resource-manager/management/azure-services-resource-providers">Azure Resource Provider Namespace</a> as recognized by the client.
+    /// </summary>
+    public const string AttributeAzNamespace = "az.namespace";
+
     /// <summary>
     /// The unique identifier of the service request. It's generated by the Azure service and returned with the response.
     /// </summary>

src/OpenTelemetry.SemanticConventions/Attributes/AzAttributes.cs

@@ -67,7 +67,7 @@ public static class CloudAttributes
     ///   <li><strong>GCP:</strong> The <a href="https://cloud.google.com/iam/docs/full-resource-names">URI of the resource</a></li>
     ///   <li><strong>Azure:</strong> The <a href="https://docs.microsoft.com/rest/api/resources/resources/get-by-id">Fully Qualified Resource ID</a> of the invoked function,
     /// <em>not</em> the function app, having the form
-    /// <c>/subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC></c>.
+    /// <c>/subscriptions/<SUBSCRIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC></c>.
     /// This means that a span attribute MUST be used, as an Azure function app can host multiple functions that would usually share
     /// a TracerProvider.</li>
     /// </ul>

src/OpenTelemetry.SemanticConventions/Attributes/CloudAttributes.cs

@@ -0,0 +1,141 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+// <auto-generated>This file has been auto generated from 'src\OpenTelemetry.SemanticConventions\scripts\templates\registry\SemanticConventionsAttributes.cs.j2' </auto-generated>
+
+#nullable enable
+
+#pragma warning disable CS1570 // XML comment has badly formed XML
+
+namespace OpenTelemetry.SemanticConventions;
+
+/// <summary>
+/// Constants for semantic attribute names outlined by the OpenTelemetry specifications.
+/// </summary>
+public static class CloudfoundryAttributes
+{
+    /// <summary>
+    /// The guid of the application.
+    /// </summary>
+    /// <remarks>
+    /// Application instrumentation should use the value from environment
+    /// variable <c>VCAP_APPLICATION.application_id</c>. This is the same value as
+    /// reported by <c>cf app <app-name> --guid</c>.
+    /// </remarks>
+    public const string AttributeCloudfoundryAppId = "cloudfoundry.app.id";
+
+    /// <summary>
+    /// The index of the application instance. 0 when just one instance is active.
+    /// </summary>
+    /// <remarks>
+    /// CloudFoundry defines the <c>instance_id</c> in the <a href="https://github.com/cloudfoundry/loggregator-api#v2-envelope">Loggegator v2 envelope</a>.
+    /// It is used for logs and metrics emitted by CloudFoundry. It is
+    /// supposed to contain the application instance index for applications
+    /// deployed on the runtime.
+    /// <p>
+    /// Application instrumentation should use the value from environment
+    /// variable <c>CF_INSTANCE_INDEX</c>.
+    /// </remarks>
+    public const string AttributeCloudfoundryAppInstanceId = "cloudfoundry.app.instance.id";
+
+    /// <summary>
+    /// The name of the application.
+    /// </summary>
+    /// <remarks>
+    /// Application instrumentation should use the value from environment
+    /// variable <c>VCAP_APPLICATION.application_name</c>. This is the same value
+    /// as reported by <c>cf apps</c>.
+    /// </remarks>
+    public const string AttributeCloudfoundryAppName = "cloudfoundry.app.name";
+
+    /// <summary>
+    /// The guid of the CloudFoundry org the application is running in.
+    /// </summary>
+    /// <remarks>
+    /// Application instrumentation should use the value from environment
+    /// variable <c>VCAP_APPLICATION.org_id</c>. This is the same value as
+    /// reported by <c>cf org <org-name> --guid</c>.
+    /// </remarks>
+    public const string AttributeCloudfoundryOrgId = "cloudfoundry.org.id";
+
+    /// <summary>
+    /// The name of the CloudFoundry organization the app is running in.
+    /// </summary>
+    /// <remarks>
+    /// Application instrumentation should use the value from environment
+    /// variable <c>VCAP_APPLICATION.org_name</c>. This is the same value as
+    /// reported by <c>cf orgs</c>.
+    /// </remarks>
+    public const string AttributeCloudfoundryOrgName = "cloudfoundry.org.name";
+
+    /// <summary>
+    /// The UID identifying the process.
+    /// </summary>
+    /// <remarks>
+    /// Application instrumentation should use the value from environment
+    /// variable <c>VCAP_APPLICATION.process_id</c>. It is supposed to be equal to
+    /// <c>VCAP_APPLICATION.app_id</c> for applications deployed to the runtime.
+    /// For system components, this could be the actual PID.
+    /// </remarks>
+    public const string AttributeCloudfoundryProcessId = "cloudfoundry.process.id";
+
+    /// <summary>
+    /// The type of process.
+    /// </summary>
+    /// <remarks>
+    /// CloudFoundry applications can consist of multiple jobs. Usually the
+    /// main process will be of type <c>web</c>. There can be additional background
+    /// tasks or side-cars with different process types.
+    /// </remarks>
+    public const string AttributeCloudfoundryProcessType = "cloudfoundry.process.type";
+
+    /// <summary>
+    /// The guid of the CloudFoundry space the application is running in.
+    /// </summary>
+    /// <remarks>
+    /// Application instrumentation should use the value from environment
+    /// variable <c>VCAP_APPLICATION.space_id</c>. This is the same value as
+    /// reported by <c>cf space <space-name> --guid</c>.
+    /// </remarks>
+    public const string AttributeCloudfoundrySpaceId = "cloudfoundry.space.id";
+
+    /// <summary>
+    /// The name of the CloudFoundry space the application is running in.
+    /// </summary>
+    /// <remarks>
+    /// Application instrumentation should use the value from environment
+    /// variable <c>VCAP_APPLICATION.space_name</c>. This is the same value as
+    /// reported by <c>cf spaces</c>.
+    /// </remarks>
+    public const string AttributeCloudfoundrySpaceName = "cloudfoundry.space.name";
+
+    /// <summary>
+    /// A guid or another name describing the event source.
+    /// </summary>
+    /// <remarks>
+    /// CloudFoundry defines the <c>source_id</c> in the <a href="https://github.com/cloudfoundry/loggregator-api#v2-envelope">Loggregator v2 envelope</a>.
+    /// It is used for logs and metrics emitted by CloudFoundry. It is
+    /// supposed to contain the component name, e.g. "gorouter", for
+    /// CloudFoundry components.
+    /// <p>
+    /// When system components are instrumented, values from the
+    /// <a href="https://bosh.io/docs/jobs/#properties-spec">Bosh spec</a>
+    /// should be used. The <c>system.id</c> should be set to
+    /// <c>spec.deployment/spec.name</c>.
+    /// </remarks>
+    public const string AttributeCloudfoundrySystemId = "cloudfoundry.system.id";
+
+    /// <summary>
+    /// A guid describing the concrete instance of the event source.
+    /// </summary>
+    /// <remarks>
+    /// CloudFoundry defines the <c>instance_id</c> in the <a href="https://github.com/cloudfoundry/loggregator-api#v2-envelope">Loggregator v2 envelope</a>.
+    /// It is used for logs and metrics emitted by CloudFoundry. It is
+    /// supposed to contain the vm id for CloudFoundry components.
+    /// <p>
+    /// When system components are instrumented, values from the
+    /// <a href="https://bosh.io/docs/jobs/#properties-spec">Bosh spec</a>
+    /// should be used. The <c>system.instance.id</c> should be set to <c>spec.id</c>.
+    /// </remarks>
+    public const string AttributeCloudfoundrySystemInstanceId = "cloudfoundry.system.instance.id";
+}

src/OpenTelemetry.SemanticConventions/Attributes/CloudfoundryAttributes.cs

@@ -23,12 +23,12 @@ public static class ContainerAttributes
     public const string AttributeContainerCommand = "container.command";
 
     /// <summary>
-    /// All the command arguments (including the command/executable itself) run by the container. [2].
+    /// All the command arguments (including the command/executable itself) run by the container.
     /// </summary>
     public const string AttributeContainerCommandArgs = "container.command_args";
 
     /// <summary>
-    /// The full command run by the container as a single string representing the full command. [2].
+    /// The full command run by the container as a single string representing the full command.
     /// </summary>
     public const string AttributeContainerCommandLine = "container.command_line";
 
@@ -39,7 +39,23 @@ public static class ContainerAttributes
     public const string AttributeContainerCpuState = "container.cpu.state";
 
     /// <summary>
-    /// Container ID. Usually a UUID, as for example used to <a href="https://docs.docker.com/engine/reference/run/#container-identification">identify Docker containers</a>. The UUID might be abbreviated.
+    /// The name of the CSI (<a href="https://github.com/container-storage-interface/spec">Container Storage Interface</a>) plugin used by the volume.
+    /// </summary>
+    /// <remarks>
+    /// This can sometimes be referred to as a "driver" in CSI implementations. This should represent the <c>name</c> field of the GetPluginInfo RPC.
+    /// </remarks>
+    public const string AttributeContainerCsiPluginName = "container.csi.plugin.name";
+
+    /// <summary>
+    /// The unique volume ID returned by the CSI (<a href="https://github.com/container-storage-interface/spec">Container Storage Interface</a>) plugin.
+    /// </summary>
+    /// <remarks>
+    /// This can sometimes be referred to as a "volume handle" in CSI implementations. This should represent the <c>Volume.volume_id</c> field in CSI spec.
+    /// </remarks>
+    public const string AttributeContainerCsiVolumeId = "container.csi.volume.id";
+
+    /// <summary>
+    /// Container ID. Usually a UUID, as for example used to <a href="https://docs.docker.com/engine/containers/run/#container-identification">identify Docker containers</a>. The UUID might be abbreviated.
     /// </summary>
     public const string AttributeContainerId = "container.id";