Skip to content

Commit

Permalink
[SemanticConvention] Bump to v1.27.0 (#2069)
Browse files Browse the repository at this point in the history
  • Loading branch information
Kielek authored Sep 19, 2024
1 parent 0bcf991 commit 88de33c
Show file tree
Hide file tree
Showing 30 changed files with 1,152 additions and 160 deletions.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
// 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 ArtifactAttributes
{
/// <summary>
/// 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
/// </summary>
public const string AttributeArtifactAttestationFilename = "artifact.attestation.filename";

/// <summary>
/// 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>
/// </summary>
public const string AttributeArtifactAttestationHash = "artifact.attestation.hash";

/// <summary>
/// The id of the build <a href="https://slsa.dev/attestation-model">software attestation</a>
/// </summary>
public const string AttributeArtifactAttestationId = "artifact.attestation.id";

/// <summary>
/// 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
/// </summary>
/// <remarks>
/// This file name can also act as the <a href="https://slsa.dev/spec/v1.0/terminology#package-model">Package Name</a>
/// in cases where the package ecosystem maps accordingly.
/// Additionally, the artifact <a href="https://slsa.dev/spec/v1.0/terminology#software-supply-chain">can be published</a>
/// for others, but that is not a guarantee
/// </remarks>
public const string AttributeArtifactFilename = "artifact.filename";

/// <summary>
/// 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
/// </summary>
/// <remarks>
/// The specific algorithm used to create the cryptographic hash value is
/// not defined. In situations where an artifact has multiple
/// cryptographic hashes, it is up to the implementer to choose which
/// hash value to set here; this should be the most secure hash algorithm
/// that is suitable for the situation and consistent with the
/// corresponding attestation. The implementer can then provide the other
/// hash values through an additional set of attribute extensions as they
/// deem necessary
/// </remarks>
public const string AttributeArtifactHash = "artifact.hash";

/// <summary>
/// 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
/// </summary>
public const string AttributeArtifactPurl = "artifact.purl";

/// <summary>
/// The version of the artifact
/// </summary>
public const string AttributeArtifactVersion = "artifact.version";
}
21 changes: 21 additions & 0 deletions src/OpenTelemetry.SemanticConventions/Attributes/AzAttributes.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
// 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 AzAttributes
{
/// <summary>
/// The unique identifier of the service request. It's generated by the Azure service and returned with the response
/// </summary>
public const string AttributeAzServiceRequestId = "az.service_request_id";
}
67 changes: 67 additions & 0 deletions src/OpenTelemetry.SemanticConventions/Attributes/CicdAttributes.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
// 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 CicdAttributes
{
/// <summary>
/// The human readable name of the pipeline within a CI/CD system
/// </summary>
public const string AttributeCicdPipelineName = "cicd.pipeline.name";

/// <summary>
/// The unique identifier of a pipeline run within a CI/CD system
/// </summary>
public const string AttributeCicdPipelineRunId = "cicd.pipeline.run.id";

/// <summary>
/// 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
/// </summary>
public const string AttributeCicdPipelineTaskName = "cicd.pipeline.task.name";

/// <summary>
/// The unique identifier of a task run within a pipeline
/// </summary>
public const string AttributeCicdPipelineTaskRunId = "cicd.pipeline.task.run.id";

/// <summary>
/// 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
/// </summary>
public const string AttributeCicdPipelineTaskRunUrlFull = "cicd.pipeline.task.run.url.full";

/// <summary>
/// The type of the task within a pipeline
/// </summary>
public const string AttributeCicdPipelineTaskType = "cicd.pipeline.task.type";

/// <summary>
/// The type of the task within a pipeline
/// </summary>
public static class CicdPipelineTaskTypeValues
{
/// <summary>
/// build
/// </summary>
public const string Build = "build";

/// <summary>
/// test
/// </summary>
public const string Test = "test";

/// <summary>
/// deploy
/// </summary>
public const string Deploy = "deploy";
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public static class CloudAttributes
/// <li><strong>AWS Lambda:</strong> The function <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a>.
/// Take care not to use the "invoked ARN" directly but replace any
/// <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-aliases.html">alias suffix</a>
/// with the resolved function version, as the same runtime instance may be invokable with
/// with the resolved function version, as the same runtime instance may be invocable with
/// multiple different aliases.</li>
/// <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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,9 @@ public static class ContainerAttributes
public const string AttributeContainerCommandLine = "container.command_line";

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

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

/// <summary>
/// The CPU state for this data point
/// Deprecated, use <c>cpu.mode</c> instead
/// </summary>
public static class ContainerCpuStateValues
{
/// <summary>
/// When tasks of the cgroup are in user mode (Linux). When all container processes are in user mode (Windows)
/// </summary>
[Obsolete("Replaced by <c>cpu.mode</c>")]
public const string User = "user";

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

/// <summary>
/// When tasks of the cgroup are in kernel mode (Linux). When all container processes are in kernel mode (Windows)
/// </summary>
[Obsolete("Replaced by <c>cpu.mode</c>")]
public const string Kernel = "kernel";
}
}
67 changes: 67 additions & 0 deletions src/OpenTelemetry.SemanticConventions/Attributes/CpuAttributes.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
// 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 CpuAttributes
{
/// <summary>
/// The mode of the CPU
/// </summary>
public const string AttributeCpuMode = "cpu.mode";

/// <summary>
/// The mode of the CPU
/// </summary>
public static class CpuModeValues
{
/// <summary>
/// user
/// </summary>
public const string User = "user";

/// <summary>
/// system
/// </summary>
public const string System = "system";

/// <summary>
/// nice
/// </summary>
public const string Nice = "nice";

/// <summary>
/// idle
/// </summary>
public const string Idle = "idle";

/// <summary>
/// iowait
/// </summary>
public const string Iowait = "iowait";

/// <summary>
/// interrupt
/// </summary>
public const string Interrupt = "interrupt";

/// <summary>
/// steal
/// </summary>
public const string Steal = "steal";

/// <summary>
/// kernel
/// </summary>
public const string Kernel = "kernel";
}
}
Loading

0 comments on commit 88de33c

Please sign in to comment.