Skip to content

Commit 44100fd

Browse files
authored
Update to semantic-conventions 1.28.0 (#91)
1 parent e1254cf commit 44100fd

21 files changed

+780
-79
lines changed

build.gradle.kts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,10 @@ val snapshot = true
1111
// end
1212

1313
// The release version of https://github.com/open-telemetry/semantic-conventions used to generate classes
14-
var semanticConventionsVersion = "1.27.0"
14+
var semanticConventionsVersion = "1.28.0"
1515
val schemaUrlVersions = listOf(
1616
semanticConventionsVersion,
17+
"1.27.0",
1718
"1.26.0",
1819
"1.25.0",
1920
"1.24.0",

semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/AndroidIncubatingAttributes.java

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,20 @@ public final class AndroidIncubatingAttributes {
2929
* <p>The Android lifecycle states are defined in <a
3030
* href="https://developer.android.com/guide/components/activities/activity-lifecycle#lc">Activity
3131
* lifecycle callbacks</a>, and from which the {@code OS identifiers} are derived.
32+
*
33+
* <p>
34+
*
35+
* @deprecated Replaced by {@code device.app.lifecycle}.
3236
*/
33-
public static final AttributeKey<String> ANDROID_STATE = stringKey("android.state");
37+
@Deprecated public static final AttributeKey<String> ANDROID_STATE = stringKey("android.state");
3438

3539
// Enum definitions
36-
/** Values for {@link #ANDROID_STATE}. */
40+
/**
41+
* Values for {@link #ANDROID_STATE}
42+
*
43+
* @deprecated Replaced by {@code device.app.lifecycle}.
44+
*/
45+
@Deprecated
3746
public static final class AndroidStateIncubatingValues {
3847
/**
3948
* Any time before Activity.onResume() or, if the app has no Activity, Context.startService()

semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/AzIncubatingAttributes.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,13 @@
1313
// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2
1414
@SuppressWarnings("unused")
1515
public final class AzIncubatingAttributes {
16+
/**
17+
* <a
18+
* href="https://learn.microsoft.com/azure/azure-resource-manager/management/azure-services-resource-providers">Azure
19+
* Resource Provider Namespace</a> as recognized by the client.
20+
*/
21+
public static final AttributeKey<String> AZ_NAMESPACE = stringKey("az.namespace");
22+
1623
/**
1724
* The unique identifier of the service request. It's generated by the Azure service and returned
1825
* with the response.

semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/CloudIncubatingAttributes.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ public final class CloudIncubatingAttributes {
8484
* href="https://docs.microsoft.com/rest/api/resources/resources/get-by-id">Fully Qualified
8585
* Resource ID</a> of the invoked function, <em>not</em> the function app, having the form
8686
* {@code
87-
* /subscriptions/<SUBSCIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>}.
87+
* /subscriptions/<SUBSCRIPTION_GUID>/resourceGroups/<RG>/providers/Microsoft.Web/sites/<FUNCAPP>/functions/<FUNC>}.
8888
* This means that a span attribute MUST be used, as an Azure function app can host multiple
8989
* functions that would usually share a TracerProvider.
9090
* </ul>
Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
/*
2+
* Copyright The OpenTelemetry Authors
3+
* SPDX-License-Identifier: Apache-2.0
4+
*/
5+
6+
package io.opentelemetry.semconv.incubating;
7+
8+
import static io.opentelemetry.api.common.AttributeKey.stringKey;
9+
10+
import io.opentelemetry.api.common.AttributeKey;
11+
12+
// DO NOT EDIT, this is an Auto-generated file from
13+
// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2
14+
@SuppressWarnings("unused")
15+
public final class CloudfoundryIncubatingAttributes {
16+
/**
17+
* The guid of the application.
18+
*
19+
* <p>Notes:
20+
*
21+
* <p>Application instrumentation should use the value from environment variable {@code
22+
* VCAP_APPLICATION.application_id}. This is the same value as reported by {@code cf app
23+
* <app-name> --guid}.
24+
*/
25+
public static final AttributeKey<String> CLOUDFOUNDRY_APP_ID = stringKey("cloudfoundry.app.id");
26+
27+
/**
28+
* The index of the application instance. 0 when just one instance is active.
29+
*
30+
* <p>Notes:
31+
*
32+
* <p>CloudFoundry defines the {@code instance_id} in the <a
33+
* href="https://github.com/cloudfoundry/loggregator-api#v2-envelope">Loggegator v2 envelope</a>.
34+
* It is used for logs and metrics emitted by CloudFoundry. It is supposed to contain the
35+
* application instance index for applications deployed on the runtime.
36+
*
37+
* <p>Application instrumentation should use the value from environment variable {@code
38+
* CF_INSTANCE_INDEX}.
39+
*/
40+
public static final AttributeKey<String> CLOUDFOUNDRY_APP_INSTANCE_ID =
41+
stringKey("cloudfoundry.app.instance.id");
42+
43+
/**
44+
* The name of the application.
45+
*
46+
* <p>Notes:
47+
*
48+
* <p>Application instrumentation should use the value from environment variable {@code
49+
* VCAP_APPLICATION.application_name}. This is the same value as reported by {@code cf apps}.
50+
*/
51+
public static final AttributeKey<String> CLOUDFOUNDRY_APP_NAME =
52+
stringKey("cloudfoundry.app.name");
53+
54+
/**
55+
* The guid of the CloudFoundry org the application is running in.
56+
*
57+
* <p>Notes:
58+
*
59+
* <p>Application instrumentation should use the value from environment variable {@code
60+
* VCAP_APPLICATION.org_id}. This is the same value as reported by {@code cf org <org-name>
61+
* --guid}.
62+
*/
63+
public static final AttributeKey<String> CLOUDFOUNDRY_ORG_ID = stringKey("cloudfoundry.org.id");
64+
65+
/**
66+
* The name of the CloudFoundry organization the app is running in.
67+
*
68+
* <p>Notes:
69+
*
70+
* <p>Application instrumentation should use the value from environment variable {@code
71+
* VCAP_APPLICATION.org_name}. This is the same value as reported by {@code cf orgs}.
72+
*/
73+
public static final AttributeKey<String> CLOUDFOUNDRY_ORG_NAME =
74+
stringKey("cloudfoundry.org.name");
75+
76+
/**
77+
* The UID identifying the process.
78+
*
79+
* <p>Notes:
80+
*
81+
* <p>Application instrumentation should use the value from environment variable {@code
82+
* VCAP_APPLICATION.process_id}. It is supposed to be equal to {@code VCAP_APPLICATION.app_id} for
83+
* applications deployed to the runtime. For system components, this could be the actual PID.
84+
*/
85+
public static final AttributeKey<String> CLOUDFOUNDRY_PROCESS_ID =
86+
stringKey("cloudfoundry.process.id");
87+
88+
/**
89+
* The type of process.
90+
*
91+
* <p>Notes:
92+
*
93+
* <p>CloudFoundry applications can consist of multiple jobs. Usually the main process will be of
94+
* type {@code web}. There can be additional background tasks or side-cars with different process
95+
* types.
96+
*/
97+
public static final AttributeKey<String> CLOUDFOUNDRY_PROCESS_TYPE =
98+
stringKey("cloudfoundry.process.type");
99+
100+
/**
101+
* The guid of the CloudFoundry space the application is running in.
102+
*
103+
* <p>Notes:
104+
*
105+
* <p>Application instrumentation should use the value from environment variable {@code
106+
* VCAP_APPLICATION.space_id}. This is the same value as reported by {@code cf space <space-name>
107+
* --guid}.
108+
*/
109+
public static final AttributeKey<String> CLOUDFOUNDRY_SPACE_ID =
110+
stringKey("cloudfoundry.space.id");
111+
112+
/**
113+
* The name of the CloudFoundry space the application is running in.
114+
*
115+
* <p>Notes:
116+
*
117+
* <p>Application instrumentation should use the value from environment variable {@code
118+
* VCAP_APPLICATION.space_name}. This is the same value as reported by {@code cf spaces}.
119+
*/
120+
public static final AttributeKey<String> CLOUDFOUNDRY_SPACE_NAME =
121+
stringKey("cloudfoundry.space.name");
122+
123+
/**
124+
* A guid or another name describing the event source.
125+
*
126+
* <p>Notes:
127+
*
128+
* <p>CloudFoundry defines the {@code source_id} in the <a
129+
* href="https://github.com/cloudfoundry/loggregator-api#v2-envelope">Loggregator v2 envelope</a>.
130+
* It is used for logs and metrics emitted by CloudFoundry. It is supposed to contain the
131+
* component name, e.g. "gorouter", for CloudFoundry components.
132+
*
133+
* <p>When system components are instrumented, values from the <a
134+
* href="https://bosh.io/docs/jobs/#properties-spec">Bosh spec</a> should be used. The {@code
135+
* system.id} should be set to {@code spec.deployment/spec.name}.
136+
*/
137+
public static final AttributeKey<String> CLOUDFOUNDRY_SYSTEM_ID =
138+
stringKey("cloudfoundry.system.id");
139+
140+
/**
141+
* A guid describing the concrete instance of the event source.
142+
*
143+
* <p>Notes:
144+
*
145+
* <p>CloudFoundry defines the {@code instance_id} in the <a
146+
* href="https://github.com/cloudfoundry/loggregator-api#v2-envelope">Loggregator v2 envelope</a>.
147+
* It is used for logs and metrics emitted by CloudFoundry. It is supposed to contain the vm id
148+
* for CloudFoundry components.
149+
*
150+
* <p>When system components are instrumented, values from the <a
151+
* href="https://bosh.io/docs/jobs/#properties-spec">Bosh spec</a> should be used. The {@code
152+
* system.instance.id} should be set to {@code spec.id}.
153+
*/
154+
public static final AttributeKey<String> CLOUDFOUNDRY_SYSTEM_INSTANCE_ID =
155+
stringKey("cloudfoundry.system.instance.id");
156+
157+
// Enum definitions
158+
159+
private CloudfoundryIncubatingAttributes() {}
160+
}

semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ContainerIncubatingAttributes.java

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,11 @@ public final class ContainerIncubatingAttributes {
2727
*/
2828
public static final AttributeKey<String> CONTAINER_COMMAND = stringKey("container.command");
2929

30-
/**
31-
* All the command arguments (including the command/executable itself) run by the container. [2]
32-
*/
30+
/** All the command arguments (including the command/executable itself) run by the container. */
3331
public static final AttributeKey<List<String>> CONTAINER_COMMAND_ARGS =
3432
stringArrayKey("container.command_args");
3533

36-
/** The full command run by the container as a single string representing the full command. [2] */
34+
/** The full command run by the container as a single string representing the full command. */
3735
public static final AttributeKey<String> CONTAINER_COMMAND_LINE =
3836
stringKey("container.command_line");
3937

@@ -47,9 +45,34 @@ public final class ContainerIncubatingAttributes {
4745
@Deprecated
4846
public static final AttributeKey<String> CONTAINER_CPU_STATE = stringKey("container.cpu.state");
4947

48+
/**
49+
* The name of the CSI (<a href="https://github.com/container-storage-interface/spec">Container
50+
* Storage Interface</a>) plugin used by the volume.
51+
*
52+
* <p>Notes:
53+
*
54+
* <p>This can sometimes be referred to as a "driver" in CSI implementations. This should
55+
* represent the {@code name} field of the GetPluginInfo RPC.
56+
*/
57+
public static final AttributeKey<String> CONTAINER_CSI_PLUGIN_NAME =
58+
stringKey("container.csi.plugin.name");
59+
60+
/**
61+
* The unique volume ID returned by the CSI (<a
62+
* href="https://github.com/container-storage-interface/spec">Container Storage Interface</a>)
63+
* plugin.
64+
*
65+
* <p>Notes:
66+
*
67+
* <p>This can sometimes be referred to as a "volume handle" in CSI implementations. This should
68+
* represent the {@code Volume.volume_id} field in CSI spec.
69+
*/
70+
public static final AttributeKey<String> CONTAINER_CSI_VOLUME_ID =
71+
stringKey("container.csi.volume.id");
72+
5073
/**
5174
* Container ID. Usually a UUID, as for example used to <a
52-
* href="https://docs.docker.com/engine/reference/run/#container-identification">identify Docker
75+
* href="https://docs.docker.com/engine/containers/run/#container-identification">identify Docker
5376
* containers</a>. The UUID might be abbreviated.
5477
*/
5578
public static final AttributeKey<String> CONTAINER_ID = stringKey("container.id");

0 commit comments

Comments
 (0)