Skip to content

Commit 88de33c

Browse files
authored
[SemanticConvention] Bump to v1.27.0 (open-telemetry#2069)
1 parent 0bcf991 commit 88de33c

30 files changed

+1152
-160
lines changed

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

Lines changed: 130 additions & 2 deletions
Large diffs are not rendered by default.
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
// Copyright The OpenTelemetry Authors
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
// <auto-generated>This file has been auto generated from 'src\OpenTelemetry.SemanticConventions\scripts\templates\registry\SemanticConventionsAttributes.cs.j2' </auto-generated>
5+
6+
#nullable enable
7+
8+
#pragma warning disable CS1570 // XML comment has badly formed XML
9+
10+
namespace OpenTelemetry.SemanticConventions;
11+
12+
/// <summary>
13+
/// Constants for semantic attribute names outlined by the OpenTelemetry specifications.
14+
/// </summary>
15+
public static class ArtifactAttributes
16+
{
17+
/// <summary>
18+
/// The provenance filename of the built attestation which directly relates to the build artifact filename. This filename SHOULD accompany the artifact at publish time. See the <a href="https://slsa.dev/spec/v1.0/distributing-provenance#relationship-between-artifacts-and-attestations">SLSA Relationship</a> specification for more information
19+
/// </summary>
20+
public const string AttributeArtifactAttestationFilename = "artifact.attestation.filename";
21+
22+
/// <summary>
23+
/// The full <a href="https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-5.pdf">hash value (see glossary)</a>, of the built attestation. Some envelopes in the software attestation space also refer to this as the <a href="https://github.com/in-toto/attestation/blob/main/spec/README.md#in-toto-attestation-framework-spec">digest</a>
24+
/// </summary>
25+
public const string AttributeArtifactAttestationHash = "artifact.attestation.hash";
26+
27+
/// <summary>
28+
/// The id of the build <a href="https://slsa.dev/attestation-model">software attestation</a>
29+
/// </summary>
30+
public const string AttributeArtifactAttestationId = "artifact.attestation.id";
31+
32+
/// <summary>
33+
/// The human readable file name of the artifact, typically generated during build and release processes. Often includes the package name and version in the file name
34+
/// </summary>
35+
/// <remarks>
36+
/// This file name can also act as the <a href="https://slsa.dev/spec/v1.0/terminology#package-model">Package Name</a>
37+
/// in cases where the package ecosystem maps accordingly.
38+
/// Additionally, the artifact <a href="https://slsa.dev/spec/v1.0/terminology#software-supply-chain">can be published</a>
39+
/// for others, but that is not a guarantee
40+
/// </remarks>
41+
public const string AttributeArtifactFilename = "artifact.filename";
42+
43+
/// <summary>
44+
/// The full <a href="https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-5.pdf">hash value (see glossary)</a>, often found in checksum.txt on a release of the artifact and used to verify package integrity
45+
/// </summary>
46+
/// <remarks>
47+
/// The specific algorithm used to create the cryptographic hash value is
48+
/// not defined. In situations where an artifact has multiple
49+
/// cryptographic hashes, it is up to the implementer to choose which
50+
/// hash value to set here; this should be the most secure hash algorithm
51+
/// that is suitable for the situation and consistent with the
52+
/// corresponding attestation. The implementer can then provide the other
53+
/// hash values through an additional set of attribute extensions as they
54+
/// deem necessary
55+
/// </remarks>
56+
public const string AttributeArtifactHash = "artifact.hash";
57+
58+
/// <summary>
59+
/// The <a href="https://github.com/package-url/purl-spec">Package URL</a> of the <a href="https://slsa.dev/spec/v1.0/terminology#package-model">package artifact</a> provides a standard way to identify and locate the packaged artifact
60+
/// </summary>
61+
public const string AttributeArtifactPurl = "artifact.purl";
62+
63+
/// <summary>
64+
/// The version of the artifact
65+
/// </summary>
66+
public const string AttributeArtifactVersion = "artifact.version";
67+
}
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// Copyright The OpenTelemetry Authors
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
// <auto-generated>This file has been auto generated from 'src\OpenTelemetry.SemanticConventions\scripts\templates\registry\SemanticConventionsAttributes.cs.j2' </auto-generated>
5+
6+
#nullable enable
7+
8+
#pragma warning disable CS1570 // XML comment has badly formed XML
9+
10+
namespace OpenTelemetry.SemanticConventions;
11+
12+
/// <summary>
13+
/// Constants for semantic attribute names outlined by the OpenTelemetry specifications.
14+
/// </summary>
15+
public static class AzAttributes
16+
{
17+
/// <summary>
18+
/// The unique identifier of the service request. It's generated by the Azure service and returned with the response
19+
/// </summary>
20+
public const string AttributeAzServiceRequestId = "az.service_request_id";
21+
}
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
// Copyright The OpenTelemetry Authors
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
// <auto-generated>This file has been auto generated from 'src\OpenTelemetry.SemanticConventions\scripts\templates\registry\SemanticConventionsAttributes.cs.j2' </auto-generated>
5+
6+
#nullable enable
7+
8+
#pragma warning disable CS1570 // XML comment has badly formed XML
9+
10+
namespace OpenTelemetry.SemanticConventions;
11+
12+
/// <summary>
13+
/// Constants for semantic attribute names outlined by the OpenTelemetry specifications.
14+
/// </summary>
15+
public static class CicdAttributes
16+
{
17+
/// <summary>
18+
/// The human readable name of the pipeline within a CI/CD system
19+
/// </summary>
20+
public const string AttributeCicdPipelineName = "cicd.pipeline.name";
21+
22+
/// <summary>
23+
/// The unique identifier of a pipeline run within a CI/CD system
24+
/// </summary>
25+
public const string AttributeCicdPipelineRunId = "cicd.pipeline.run.id";
26+
27+
/// <summary>
28+
/// The human readable name of a task within a pipeline. Task here most closely aligns with a <a href="https://en.wikipedia.org/wiki/Pipeline_(computing)">computing process</a> in a pipeline. Other terms for tasks include commands, steps, and procedures
29+
/// </summary>
30+
public const string AttributeCicdPipelineTaskName = "cicd.pipeline.task.name";
31+
32+
/// <summary>
33+
/// The unique identifier of a task run within a pipeline
34+
/// </summary>
35+
public const string AttributeCicdPipelineTaskRunId = "cicd.pipeline.task.run.id";
36+
37+
/// <summary>
38+
/// The <a href="https://en.wikipedia.org/wiki/URL">URL</a> of the pipeline run providing the complete address in order to locate and identify the pipeline run
39+
/// </summary>
40+
public const string AttributeCicdPipelineTaskRunUrlFull = "cicd.pipeline.task.run.url.full";
41+
42+
/// <summary>
43+
/// The type of the task within a pipeline
44+
/// </summary>
45+
public const string AttributeCicdPipelineTaskType = "cicd.pipeline.task.type";
46+
47+
/// <summary>
48+
/// The type of the task within a pipeline
49+
/// </summary>
50+
public static class CicdPipelineTaskTypeValues
51+
{
52+
/// <summary>
53+
/// build
54+
/// </summary>
55+
public const string Build = "build";
56+
57+
/// <summary>
58+
/// test
59+
/// </summary>
60+
public const string Test = "test";
61+
62+
/// <summary>
63+
/// deploy
64+
/// </summary>
65+
public const string Deploy = "deploy";
66+
}
67+
}

src/OpenTelemetry.SemanticConventions/Attributes/CloudAttributes.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public static class CloudAttributes
6262
/// <li><strong>AWS Lambda:</strong> The function <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a>.
6363
/// Take care not to use the "invoked ARN" directly but replace any
6464
/// <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html">alias suffix</a>
65-
/// with the resolved function version, as the same runtime instance may be invokable with
65+
/// with the resolved function version, as the same runtime instance may be invocable with
6666
/// multiple different aliases.</li>
6767
/// <li><strong>GCP:</strong> The <a href="https://cloud.google.com/iam/docs/full-resource-names">URI of the resource</a></li>
6868
/// <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,

src/OpenTelemetry.SemanticConventions/Attributes/ContainerAttributes.cs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,9 @@ public static class ContainerAttributes
3333
public const string AttributeContainerCommandLine = "container.command_line";
3434

3535
/// <summary>
36-
/// The CPU state for this data point
36+
/// Deprecated, use <c>cpu.mode</c> instead
3737
/// </summary>
38+
[Obsolete("Replaced by <c>cpu.mode</c>")]
3839
public const string AttributeContainerCpuState = "container.cpu.state";
3940

4041
/// <summary>
@@ -92,23 +93,26 @@ public static class ContainerAttributes
9293
public const string AttributeContainerRuntime = "container.runtime";
9394

9495
/// <summary>
95-
/// The CPU state for this data point
96+
/// Deprecated, use <c>cpu.mode</c> instead
9697
/// </summary>
9798
public static class ContainerCpuStateValues
9899
{
99100
/// <summary>
100101
/// When tasks of the cgroup are in user mode (Linux). When all container processes are in user mode (Windows)
101102
/// </summary>
103+
[Obsolete("Replaced by <c>cpu.mode</c>")]
102104
public const string User = "user";
103105

104106
/// <summary>
105107
/// When CPU is used by the system (host OS)
106108
/// </summary>
109+
[Obsolete("Replaced by <c>cpu.mode</c>")]
107110
public const string System = "system";
108111

109112
/// <summary>
110113
/// When tasks of the cgroup are in kernel mode (Linux). When all container processes are in kernel mode (Windows)
111114
/// </summary>
115+
[Obsolete("Replaced by <c>cpu.mode</c>")]
112116
public const string Kernel = "kernel";
113117
}
114118
}
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
// Copyright The OpenTelemetry Authors
2+
// SPDX-License-Identifier: Apache-2.0
3+
4+
// <auto-generated>This file has been auto generated from 'src\OpenTelemetry.SemanticConventions\scripts\templates\registry\SemanticConventionsAttributes.cs.j2' </auto-generated>
5+
6+
#nullable enable
7+
8+
#pragma warning disable CS1570 // XML comment has badly formed XML
9+
10+
namespace OpenTelemetry.SemanticConventions;
11+
12+
/// <summary>
13+
/// Constants for semantic attribute names outlined by the OpenTelemetry specifications.
14+
/// </summary>
15+
public static class CpuAttributes
16+
{
17+
/// <summary>
18+
/// The mode of the CPU
19+
/// </summary>
20+
public const string AttributeCpuMode = "cpu.mode";
21+
22+
/// <summary>
23+
/// The mode of the CPU
24+
/// </summary>
25+
public static class CpuModeValues
26+
{
27+
/// <summary>
28+
/// user
29+
/// </summary>
30+
public const string User = "user";
31+
32+
/// <summary>
33+
/// system
34+
/// </summary>
35+
public const string System = "system";
36+
37+
/// <summary>
38+
/// nice
39+
/// </summary>
40+
public const string Nice = "nice";
41+
42+
/// <summary>
43+
/// idle
44+
/// </summary>
45+
public const string Idle = "idle";
46+
47+
/// <summary>
48+
/// iowait
49+
/// </summary>
50+
public const string Iowait = "iowait";
51+
52+
/// <summary>
53+
/// interrupt
54+
/// </summary>
55+
public const string Interrupt = "interrupt";
56+
57+
/// <summary>
58+
/// steal
59+
/// </summary>
60+
public const string Steal = "steal";
61+
62+
/// <summary>
63+
/// kernel
64+
/// </summary>
65+
public const string Kernel = "kernel";
66+
}
67+
}

0 commit comments

Comments
 (0)