Skip to content

Commit

Permalink
Update to semantic-conventions 1.27.0 (#81)
Browse files Browse the repository at this point in the history
* Update to semantic-conventions 1.27.0

* update contributing link

* Include 1.26.0 in schemaUrlVersions

---------

Co-authored-by: Jack Berg <[email protected]>
  • Loading branch information
crossoverJie and jack-berg committed Aug 19, 2024
1 parent 2cab896 commit 07f9074
Show file tree
Hide file tree
Showing 31 changed files with 1,082 additions and 189 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ generate semantic conventions classes from the release contents.
## Contributing

Before you start - see OpenTelemetry
general [contributing](https://github.com/open-telemetry/community/blob/main/CONTRIBUTING.md)
general [contributing](https://github.com/open-telemetry/community/tree/main/guides/contributor)
requirements and recommendations.

Make sure to review the projects [license](LICENSE) and sign
Expand Down
3 changes: 2 additions & 1 deletion build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@ val snapshot = true
// end

// The release version of https://github.com/open-telemetry/semantic-conventions used to generate classes
var semanticConventionsVersion = "1.26.0"
var semanticConventionsVersion = "1.27.0"
val schemaUrlVersions = listOf(
semanticConventionsVersion,
"1.26.0",
"1.25.0",
"1.24.0",
"1.23.1",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/

package io.opentelemetry.semconv.incubating;

import static io.opentelemetry.api.common.AttributeKey.stringKey;

import io.opentelemetry.api.common.AttributeKey;

// DO NOT EDIT, this is an Auto-generated file from
// buildscripts/templates/SemanticAttributes.java.j2
@SuppressWarnings("unused")
public final class ArtifactIncubatingAttributes {

/**
* 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.
*/
public static final AttributeKey<String> ARTIFACT_ATTESTATION_FILENAME =
stringKey("artifact.attestation.filename");

/**
* 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>.
*/
public static final AttributeKey<String> ARTIFACT_ATTESTATION_HASH =
stringKey("artifact.attestation.hash");

/** The id of the build <a href="https://slsa.dev/attestation-model">software attestation</a>. */
public static final AttributeKey<String> ARTIFACT_ATTESTATION_ID =
stringKey("artifact.attestation.id");

/**
* 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.
*
* <p>Notes:
*
* <ul>
* <li>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.
* </ul>
*/
public static final AttributeKey<String> ARTIFACT_FILENAME = stringKey("artifact.filename");

/**
* 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.
*
* <p>Notes:
*
* <ul>
* <li>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.
* </ul>
*/
public static final AttributeKey<String> ARTIFACT_HASH = stringKey("artifact.hash");

/**
* 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.
*/
public static final AttributeKey<String> ARTIFACT_PURL = stringKey("artifact.purl");

/** The version of the artifact. */
public static final AttributeKey<String> ARTIFACT_VERSION = stringKey("artifact.version");

private ArtifactIncubatingAttributes() {}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/

package io.opentelemetry.semconv.incubating;

import static io.opentelemetry.api.common.AttributeKey.stringKey;

import io.opentelemetry.api.common.AttributeKey;

// DO NOT EDIT, this is an Auto-generated file from
// buildscripts/templates/SemanticAttributes.java.j2
@SuppressWarnings("unused")
public final class AzIncubatingAttributes {

/**
* The unique identifier of the service request. It's generated by the Azure service and returned
* with the response.
*/
public static final AttributeKey<String> AZ_SERVICE_REQUEST_ID =
stringKey("az.service_request_id");

private AzIncubatingAttributes() {}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/

package io.opentelemetry.semconv.incubating;

import static io.opentelemetry.api.common.AttributeKey.stringKey;

import io.opentelemetry.api.common.AttributeKey;

// DO NOT EDIT, this is an Auto-generated file from
// buildscripts/templates/SemanticAttributes.java.j2
@SuppressWarnings("unused")
public final class CicdIncubatingAttributes {

/** The human readable name of the pipeline within a CI/CD system. */
public static final AttributeKey<String> CICD_PIPELINE_NAME = stringKey("cicd.pipeline.name");

/** The unique identifier of a pipeline run within a CI/CD system. */
public static final AttributeKey<String> CICD_PIPELINE_RUN_ID = stringKey("cicd.pipeline.run.id");

/**
* 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.
*/
public static final AttributeKey<String> CICD_PIPELINE_TASK_NAME =
stringKey("cicd.pipeline.task.name");

/** The unique identifier of a task run within a pipeline. */
public static final AttributeKey<String> CICD_PIPELINE_TASK_RUN_ID =
stringKey("cicd.pipeline.task.run.id");

/**
* 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.
*/
public static final AttributeKey<String> CICD_PIPELINE_TASK_RUN_URL_FULL =
stringKey("cicd.pipeline.task.run.url.full");

/** The type of the task within a pipeline. */
public static final AttributeKey<String> CICD_PIPELINE_TASK_TYPE =
stringKey("cicd.pipeline.task.type");

// Enum definitions
/** Values for {@link #CICD_PIPELINE_TASK_TYPE}. */
public static final class CicdPipelineTaskTypeValues {
/** build. */
public static final String BUILD = "build";

/** test. */
public static final String TEST = "test";

/** deploy. */
public static final String DEPLOY = "deploy";

private CicdPipelineTaskTypeValues() {}
}

private CicdIncubatingAttributes() {}
}
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ public final class CloudIncubatingAttributes {
* Take care not to use the &quot;invoked ARN&quot; 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 multiple different aliases.
* invocable with multiple different aliases.
* <li><strong>GCP:</strong> The <a
* href="https://cloud.google.com/iam/docs/full-resource-names">URI of the resource</a>
* <li><strong>Azure:</strong> The <a
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,12 @@ public final class ContainerIncubatingAttributes {
public static final AttributeKey<String> CONTAINER_COMMAND_LINE =
stringKey("container.command_line");

/** The CPU state for this data point. */
/**
* Deprecated, use {@code cpu.mode} instead.
*
* @deprecated Deprecated, use `cpu.mode` instead.
*/
@Deprecated
public static final AttributeKey<String> CONTAINER_CPU_STATE = stringKey("container.cpu.state");

/**
Expand Down Expand Up @@ -117,7 +122,12 @@ public final class ContainerIncubatingAttributes {
public static final AttributeKey<String> CONTAINER_RUNTIME = stringKey("container.runtime");

// Enum definitions
/** Values for {@link #CONTAINER_CPU_STATE}. */
/**
* Values for {@link #CONTAINER_CPU_STATE}.
*
* @deprecated Deprecated, use `cpu.mode` instead.
*/
@Deprecated
public static final class ContainerCpuStateValues {
/**
* When tasks of the cgroup are in user mode (Linux). When all container processes are in user
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/

package io.opentelemetry.semconv.incubating;

import static io.opentelemetry.api.common.AttributeKey.stringKey;

import io.opentelemetry.api.common.AttributeKey;

// DO NOT EDIT, this is an Auto-generated file from
// buildscripts/templates/SemanticAttributes.java.j2
@SuppressWarnings("unused")
public final class CpuIncubatingAttributes {

/** The mode of the CPU */
public static final AttributeKey<String> CPU_MODE = stringKey("cpu.mode");

// Enum definitions
/** Values for {@link #CPU_MODE}. */
public static final class CpuModeValues {
/** user. */
public static final String USER = "user";

/** system. */
public static final String SYSTEM = "system";

/** nice. */
public static final String NICE = "nice";

/** idle. */
public static final String IDLE = "idle";

/** iowait. */
public static final String IOWAIT = "iowait";

/** interrupt. */
public static final String INTERRUPT = "interrupt";

/** steal. */
public static final String STEAL = "steal";

/** kernel. */
public static final String KERNEL = "kernel";

private CpuModeValues() {}
}

private CpuIncubatingAttributes() {}
}
Loading

0 comments on commit 07f9074

Please sign in to comment.