From 1165ef4b30188c4fa9929cb33959ef71017344b5 Mon Sep 17 00:00:00 2001 From: Josh Suereth Date: Fri, 6 Sep 2024 16:36:29 -0400 Subject: [PATCH] Use weaver for semantic convention codegen (#70) * Initial build generation to weaver. * Use weaver for codegen. * Remove deprecated incubating attributes. * Update generated code. * Add workaround for javadoc issue. * Update codegen. * Regenerate code. * Bump to latest weaver. * Regenerate classes/code. * Allow generated code to have different paragaph styles. * Add dots back into javadoc. * Codegen. * Add back-links from incubating to stable when things go stable. * Update generated incubating files. * Fix formatting. * Fix formatting. * Fix handling of template keys. * codegen * Update build.gradle.kts Co-authored-by: jack-berg <34418638+jack-berg@users.noreply.github.com> * Fix missing deprecated + experimental attributes. * Regenerate semconv. * Fix enum values. * regenerate code. * Fix deprecating stable enum values. * Regenerate code. * Fixes from review. * Fix bug where deprecated attributes were being added in future for-loops. * fix up deprecated attributes. * Add descriptions back to deprecated-for-stable incubating attributes. * Codegen * Add deprecation warnings back into enum value classes. * Fix deprecation on enum value classes. * Fix enum value links. * regenerate * Fix links from deprecated-for-stable enum classes. * regenerate. * Fix deprecated annotation. * regneerate. --------- Co-authored-by: jack-berg <34418638+jack-berg@users.noreply.github.com> --- build.gradle.kts | 50 ++-- buildscripts/checkstyle.xml | 4 +- .../templates/SemanticAttributes.java.j2 | 128 -------- .../IncubatingSemanticAttributes.java.j2 | 76 +++++ .../registry/incubating_java/weaver.yaml | 77 +++++ .../registry/java/SemanticAttributes.java.j2 | 59 ++++ .../templates/registry/java/weaver.yaml | 72 +++++ .../AndroidIncubatingAttributes.java | 11 +- .../ArtifactIncubatingAttributes.java | 31 +- .../incubating/AwsIncubatingAttributes.java | 101 +++---- .../incubating/AzIncubatingAttributes.java | 5 +- .../BrowserIncubatingAttributes.java | 47 ++- .../incubating/CicdIncubatingAttributes.java | 9 +- .../ClientIncubatingAttributes.java | 25 +- .../incubating/CloudIncubatingAttributes.java | 110 ++++--- .../CloudeventsIncubatingAttributes.java | 5 +- .../incubating/CodeIncubatingAttributes.java | 11 +- .../ContainerIncubatingAttributes.java | 55 ++-- .../incubating/CpuIncubatingAttributes.java | 3 +- .../incubating/DbIncubatingAttributes.java | 279 +++++++++--------- .../DeploymentIncubatingAttributes.java | 22 +- .../DestinationIncubatingAttributes.java | 13 +- .../DeviceIncubatingAttributes.java | 49 ++- .../incubating/DiskIncubatingAttributes.java | 3 +- .../incubating/DnsIncubatingAttributes.java | 15 +- .../EnduserIncubatingAttributes.java | 17 +- .../incubating/ErrorIncubatingAttributes.java | 41 +-- .../incubating/EventIncubatingAttributes.java | 15 +- .../ExceptionIncubatingAttributes.java | 42 +-- .../incubating/FaasIncubatingAttributes.java | 70 ++--- .../FeatureFlagIncubatingAttributes.java | 21 +- .../incubating/FileIncubatingAttributes.java | 11 +- .../incubating/GcpIncubatingAttributes.java | 14 +- .../incubating/GenAiIncubatingAttributes.java | 72 +++-- .../incubating/GoIncubatingAttributes.java | 3 +- .../GraphqlIncubatingAttributes.java | 13 +- .../HerokuIncubatingAttributes.java | 5 +- .../incubating/HostIncubatingAttributes.java | 44 ++- .../incubating/HttpIncubatingAttributes.java | 178 ++++++----- .../incubating/JvmIncubatingAttributes.java | 45 +-- .../incubating/K8sIncubatingAttributes.java | 49 +-- .../incubating/LinuxIncubatingAttributes.java | 3 +- .../incubating/LogIncubatingAttributes.java | 27 +- .../MessageIncubatingAttributes.java | 23 +- .../MessagingIncubatingAttributes.java | 168 +++++------ .../incubating/NetIncubatingAttributes.java | 80 +++-- .../NetworkIncubatingAttributes.java | 102 ++++--- .../incubating/OciIncubatingAttributes.java | 19 +- .../OpentracingIncubatingAttributes.java | 11 +- .../incubating/OsIncubatingAttributes.java | 25 +- .../incubating/OtelIncubatingAttributes.java | 20 +- .../incubating/OtherIncubatingAttributes.java | 11 +- .../incubating/PeerIncubatingAttributes.java | 5 +- .../incubating/PoolIncubatingAttributes.java | 9 +- .../ProcessIncubatingAttributes.java | 18 +- .../incubating/RpcIncubatingAttributes.java | 106 +++---- .../ServerIncubatingAttributes.java | 25 +- .../ServiceIncubatingAttributes.java | 91 +++--- .../SessionIncubatingAttributes.java | 5 +- .../SourceIncubatingAttributes.java | 13 +- .../SystemIncubatingAttributes.java | 19 +- .../TelemetryIncubatingAttributes.java | 34 +-- .../incubating/TestIncubatingAttributes.java | 19 +- .../ThreadIncubatingAttributes.java | 7 +- .../incubating/TlsIncubatingAttributes.java | 16 +- .../incubating/UrlIncubatingAttributes.java | 103 +++---- .../UserAgentIncubatingAttributes.java | 30 +- .../incubating/UserIncubatingAttributes.java | 11 +- .../incubating/V8jsIncubatingAttributes.java | 11 +- .../incubating/VcsIncubatingAttributes.java | 32 +- .../WebengineIncubatingAttributes.java | 5 +- .../semconv/ClientAttributes.java | 19 +- .../semconv/ErrorAttributes.java | 41 +-- .../semconv/ExceptionAttributes.java | 34 +-- .../opentelemetry/semconv/HttpAttributes.java | 94 +++--- .../opentelemetry/semconv/JvmAttributes.java | 26 +- .../semconv/NetworkAttributes.java | 47 ++- .../opentelemetry/semconv/OtelAttributes.java | 10 +- .../semconv/ServerAttributes.java | 19 +- .../semconv/ServiceAttributes.java | 15 +- .../semconv/TelemetryAttributes.java | 20 +- .../opentelemetry/semconv/UrlAttributes.java | 33 +-- .../semconv/UserAgentAttributes.java | 3 +- 83 files changed, 1728 insertions(+), 1581 deletions(-) delete mode 100644 buildscripts/templates/SemanticAttributes.java.j2 create mode 100644 buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 create mode 100644 buildscripts/templates/registry/incubating_java/weaver.yaml create mode 100644 buildscripts/templates/registry/java/SemanticAttributes.java.j2 create mode 100644 buildscripts/templates/registry/java/weaver.yaml diff --git a/build.gradle.kts b/build.gradle.kts index e384af5..8bd82c4 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -54,7 +54,7 @@ nexusPublishing { } // start - define tasks to download, unzip, and generate from opentelemetry/semantic-conventions -var generatorVersion = "0.24.0" +var generatorVersion = "v0.9.1" val semanticConventionsRepoZip = "https://github.com/open-telemetry/semantic-conventions/archive/v${semanticConventionsVersion}.zip" val schemaUrl = "https://opentelemetry.io/schemas/$semanticConventionsVersion" @@ -83,35 +83,37 @@ fun generateTask(taskName: String, incubating: Boolean) { standardOutput = System.out executable = "docker" - var filter = if (incubating) "any" else "is_stable" - var classPrefix = if (incubating) "Incubating" else "" + var target = if (incubating) "incubating_java" else "java" val outputDir = if (incubating) "semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/" else "semconv/src/main/java/io/opentelemetry/semconv/" - val packageNameArg = if (incubating) "io.opentelemetry.semconv.incubating" else "io.opentelemetry.semconv" - val stablePackageNameArg = if (incubating) "io.opentelemetry.semconv" else "" - setArgs(listOf( - "run", + val file_args = if (org.gradle.internal.os.OperatingSystem.current().isWindows()) + // Don't need to worry about file system permissions in docker. + listOf() + else { + // Make sure we run as local file user + val unix = com.sun.security.auth.module.UnixSystem() + val uid = unix.getUid() // $(id -u $USERNAME) + val gid = unix.getGid() // $(id -g $USERNAME) + listOf("-u", "$uid:$gid") + } + val weaver_args = listOf( "--rm", - "-v", "$buildDir/semantic-conventions-${semanticConventionsVersion}/model:/source", - "-v", "$projectDir/buildscripts/templates:/templates", - "-v", "$projectDir/$outputDir:/output", - "otel/semconvgen:$generatorVersion", - "--yaml-root", "/source", - "--continue-on-validation-errors", - "code", - "--template", "/templates/SemanticAttributes.java.j2", - "--output", "/output/{{pascal_prefix}}${classPrefix}Attributes.java", - "--file-per-group", "root_namespace", - // Space delimited list of root namespaces to excluded (i.e. "foo bar") - "-Dexcluded_namespaces=ios aspnetcore signalr", - "-Dexcluded_attributes=messaging.client_id", - "-Dfilter=${filter}", - "-DclassPrefix=${classPrefix}", - "-Dpkg=$packageNameArg", - "-DstablePkg=$stablePackageNameArg")) + "--platform=linux/x86_64", + "--mount", "type=bind,source=$buildDir/semantic-conventions-${semanticConventionsVersion}/model,target=/home/weaver/source,readonly", + "--mount", "type=bind,source=$projectDir/buildscripts/templates,target=/home/weaver/templates,readonly", + "--mount", "type=bind,source=$projectDir/$outputDir,target=/home/weaver/target", + "otel/weaver:$generatorVersion", + "registry", "generate", + "--registry=/home/weaver/source", + "--templates=/home/weaver/templates", + "$target", + "/home/weaver/target/") + + setArgs(listOf("run") + file_args + weaver_args) } } +// TODO - With weaver we can generate both of this in one go, but let's refactor smaller pieces at a time. generateTask("generateStableSemanticAttributes", false) generateTask("generateIncubatingSemanticAttributes", true) diff --git a/buildscripts/checkstyle.xml b/buildscripts/checkstyle.xml index 1297813..c305ce8 100644 --- a/buildscripts/checkstyle.xml +++ b/buildscripts/checkstyle.xml @@ -144,7 +144,9 @@ - + + + - {%- elif type == "boolean" -%} - boolean - {%- elif type == "int" -%} - long - {%- elif type == "double" -%} - double - {%- else -%} - {{type}} - {%- endif -%} -{%- endmacro %} -{%- macro to_java_key_type(type) -%} - {%- if type == "string" -%} - stringKey - {%- elif type == "string[]" -%} - stringArrayKey - {%- elif type == "boolean" -%} - booleanKey - {%- elif type == "int" -%} - longKey - {%- elif type == "double" -%} - doubleKey - {%- else -%} - {{type | to_camelcase(False)}}Key - {%- endif -%} -{%- endmacro %} -{%- macro stable_class_ref(const_name, separator) -%} -{{stablePkg}}.{{ root_namespace | to_camelcase(True) }}Attributes{{separator}}{{const_name}} -{%- endmacro %} -{%- set excluded_attributes_list = excluded_attributes.replace("\"", "").split(' ') %} -{%- if filter != 'any' %} -{%- set filtered_attributes = attributes_and_templates | rejectattr("fqn", "in", excluded_attributes) | select(filter) | list %} -{%- else %} -{%- set filtered_attributes = attributes_and_templates | rejectattr("fqn", "in", excluded_attributes) | list %} -{%- endif %} -{%- set filtered_enums = filtered_attributes | selectattr('is_enum', 'equalto', true) | list %} -{%- set excluded_namespaces_list = excluded_namespaces.replace("\"", "").split(' ') %} -{%- if root_namespace not in excluded_namespaces_list and filtered_attributes | count > 0 %} -/* - * Copyright The OpenTelemetry Authors - * SPDX-License-Identifier: Apache-2.0 - */ - -package {{pkg | trim}}; - -import static io.opentelemetry.api.common.AttributeKey.booleanKey; -import static io.opentelemetry.api.common.AttributeKey.doubleKey; -import static io.opentelemetry.api.common.AttributeKey.longKey; -import static io.opentelemetry.api.common.AttributeKey.stringKey; -import static io.opentelemetry.api.common.AttributeKey.stringArrayKey; - -import static io.opentelemetry.semconv.AttributeKeyTemplate.stringArrayKeyTemplate; -import static io.opentelemetry.semconv.AttributeKeyTemplate.stringKeyTemplate; - -import io.opentelemetry.api.common.AttributeKey; -import io.opentelemetry.semconv.AttributeKeyTemplate; -import java.util.List; - -// DO NOT EDIT, this is an Auto-generated file from buildscripts{{template}} -@SuppressWarnings("unused") -public final class {{ root_namespace | to_camelcase(True) }}{{ classPrefix }}Attributes { - {%- for attribute in filtered_attributes %} - - {% set attribute_const_name = attribute.fqn | to_const_name -%} - /** - * {{attribute.brief | render_markdown(code="{{@code {0}}}", paragraph="{0}")}} - {%- if attribute.note %} - * - *

Notes: - {# NOTE: replace("> ", "") removes the following problematic characters which produce mangled javadoc: #} - {# https://github.com/open-telemetry/semantic-conventions/blob/c83a10a9c33c18a769835e959200d0e24dc708fe/model/resource/k8s.yaml#L34-L38 #} -

    {{attribute.note | replace("> ", "") | render_markdown(code="{{@code {0}}}", paragraph="
  • {0}
    • ", list="{0}")}}
- - {%- endif %} - * - {%- if attribute | is_deprecated %} - * @deprecated {{attribute.brief | to_doc_brief}}. - {%- elif attribute | is_stable and stablePkg != "" %} - * @deprecated deprecated in favor of stable {@link {{stable_class_ref(attribute_const_name, '#')}}} attribute. - {%- endif %} - */ - {%- if attribute | is_deprecated or attribute | is_stable and stablePkg != "" %} - @Deprecated - {%- endif %} - {%- if attribute | is_template %} - public static final AttributeKeyTemplate<{{to_java_return_type(attribute.instantiated_type | string) | first_up}}> {{attribute_const_name}} = {{to_java_key_type(attribute.instantiated_type | string)}}Template("{{attribute.fqn}}"); - {%- else %} - public static final AttributeKey<{{to_java_return_type(attribute.attr_type | string) | first_up}}> {{attribute_const_name}} = {{to_java_key_type(attribute.attr_type | string)}}("{{attribute.fqn}}"); - {%- endif %} - {%- endfor %} - - {%- if filtered_enums | count > 0 %} - // Enum definitions - {%- endif %} - {%- for enum_attribute in filtered_enums %} - {%- set class_name = enum_attribute.fqn | to_camelcase(True) ~ "Values" %} - {%- set type = to_java_return_type(enum_attribute.attr_type.enum_type) %} - /** - * Values for {@link #{{ enum_attribute.fqn | to_const_name }}}. - * - {%- if enum_attribute | is_deprecated %} - * @deprecated {{enum_attribute.brief | to_doc_brief}}. - {%- elif enum_attribute | is_stable and stablePkg != "" %} - * @deprecated deprecated in favor of stable {@link {{stable_class_ref(class_name, '.')}}} attribute. - {%- endif %} - */ - {%- if enum_attribute | is_deprecated or enum_attribute | is_stable and stablePkg != "" %} - @Deprecated - {%- endif %} - public static final class {{class_name}} { - {%- for member in enum_attribute.attr_type.members %} - /** {% filter escape %}{{member.brief | to_doc_brief}}.{% endfilter %} */ - public static final {{ type }} {{ member.member_id | to_const_name }} = {{ enum_attribute | print_member_value(member) }}; - - {%- endfor %} - - private {{ class_name }}() {} - } - - {%- endfor %} - - private {{ root_namespace | to_camelcase(True) }}{{ classPrefix }}Attributes() {} -} -{%- endif %} diff --git a/buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 b/buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 new file mode 100644 index 0000000..3199389 --- /dev/null +++ b/buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @@ -0,0 +1,76 @@ +{%- macro to_java_key_type(attribute) -%} + {%- if attribute.type is template_type -%} + {{ attribute.type | instantiated_type | map_text("java_template_key_type") }} + {%- else -%} + {{ attribute.type | instantiated_type | map_text("java_key_type") }} + {%- endif %} +{%- endmacro %} +{%- macro to_java_key_factory(attribute) -%} + {%- if attribute.type is template_type -%} + {{ attribute.type | instantiated_type | map_text("java_template_key_factory") }} + {%- else -%} + {{ attribute.type | instantiated_type | map_text("java_key_factory") }} + {%- endif %} +{%- endmacro %} +{%- set my_class_name = ctx.root_namespace | pascal_case ~ "IncubatingAttributes" -%} +{%- set stable_class_name = ctx.root_namespace | pascal_case ~ "Attributes" -%} +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ +package io.opentelemetry.semconv.incubating; + +import static io.opentelemetry.api.common.AttributeKey.booleanKey; +import static io.opentelemetry.api.common.AttributeKey.doubleKey; +import static io.opentelemetry.api.common.AttributeKey.longKey; +import static io.opentelemetry.api.common.AttributeKey.stringKey; +import static io.opentelemetry.api.common.AttributeKey.stringArrayKey; + +import static io.opentelemetry.semconv.AttributeKeyTemplate.stringArrayKeyTemplate; +import static io.opentelemetry.semconv.AttributeKeyTemplate.stringKeyTemplate; + +import io.opentelemetry.api.common.AttributeKey; +import io.opentelemetry.semconv.AttributeKeyTemplate; +import java.util.List; + +// DO NOT EDIT, this is an Auto-generated file from buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 +@SuppressWarnings("unused") +public final class {{ my_class_name }} { + {% for attribute in ctx.attributes | rejectattr("name", "in", ctx.excluded_attributes) %}{% if attribute is experimental %} + {%- if attribute is deprecated %}{%- set deprecated_javadoc = "@deprecated " ~ attribute.deprecated -%} + {%- else -%}{%- set deprecated_javadoc = "" -%} + {%- endif -%} + {{ [attribute.brief, concat_if("\n\nNotes:\n\n", attribute.note), deprecated_javadoc] | comment(indent=4) }} + {% if attribute is deprecated %}@Deprecated{% endif %} public static final {{ to_java_key_type(attribute) | trim }} {{ attribute.name | screaming_snake_case }} = {{ to_java_key_factory(attribute) | trim }}("{{ attribute.name }}"); + {% elif attribute is stable %} + {%- set stable_class_link = "io.opentelemetry.semconv." ~ stable_class_name ~ "#" ~ (attribute.name | screaming_snake_case) -%} + {{ [attribute.brief, concat_if("\n\nNotes:\n\n", attribute.note), "@deprecated deprecated in favor of stable {@link " ~ stable_class_link ~ "} attribute."] | comment(indent=4) }} + @Deprecated public static final {{ to_java_key_type(attribute) | trim }} {{ attribute.name | screaming_snake_case }} = {{ to_java_key_factory(attribute) | trim }}("{{ attribute.name }}"); + {% endif %} + {% endfor %} + // Enum definitions + {% for attribute in ctx.attributes | select("enum") | rejectattr("name", "in", ctx.excluded_attributes) %} + {%- if attribute is stable -%} + {%- set stable_class_link = "io.opentelemetry.semconv." ~ stable_class_name ~ "." ~ (attribute.name | pascal_case) ~ "Values" -%} + /** + * Values for {@link #{{ attribute.name | screaming_snake_case }}}. + * + * @deprecated deprecated in favor of stable {@link {{stable_class_link}}}. + */ + {%- elif attribute is deprecated -%} + {{ ["Values for {@link #" ~ attribute.name | screaming_snake_case ~ "}", "@deprecated " ~ attribute.deprecated ] | comment }} + {%- else -%} + /** Values for {@link #{{ attribute.name | screaming_snake_case }}}. */ + {%- endif -%} + {% if attribute is stable or attribute is deprecated %}@Deprecated{% endif %} + public static final class {{ attribute.name | pascal_case }}Values { + {%- for member in attribute.type.members %} + {{ [member.brief or (member.id ~ '.')] | comment(indent=4) }} + public static final {{ attribute.type | instantiated_type | map_text("java_enum_type") }} {{ member.id | screaming_snake_case }} = {{ member.value | print_member_value }}; + {%- endfor %} + private {{ attribute.name | pascal_case }}Values() {} + } + {% endfor %} + + private {{ my_class_name }}() {} +} \ No newline at end of file diff --git a/buildscripts/templates/registry/incubating_java/weaver.yaml b/buildscripts/templates/registry/incubating_java/weaver.yaml new file mode 100644 index 0000000..78b52cf --- /dev/null +++ b/buildscripts/templates/registry/incubating_java/weaver.yaml @@ -0,0 +1,77 @@ +params: + excluded_namespaces: ["ios", "aspnetcore", "signalr"] + excluded_attributes: ["messaging.client_id"] +comment_formats: + javadoc: + format: html + header: "/**" + prefix: " * " + footer: " */" + old_style_paragraph: true + omit_closing_li: true + inline_code_snippet: "{@code {{code}}}" + block_code_snippet: "
{@code {{code}}}
" + trim: true + remove_trailing_dots: false +default_comment_format: javadoc +templates: + - pattern: IncubatingSemanticAttributes.java.j2 + filter: > + semconv_grouped_attributes({ + "exclude_root_namespace": $excluded_namespaces, + "exclude_stability": [], + "exclude_deprecated": false + }) | map({ + root_namespace: .root_namespace, + attributes: .attributes, + excluded_attributes: $excluded_attributes[] + }) + application_mode: each + file_name: "{{ctx.root_namespace | pascal_case}}IncubatingAttributes.java" +text_maps: + java_enum_type: + int: long + double: double + boolean: boolean + string: String + string[]: String[] + int[]: long[] + double[]: double[] + boolean[]: boolean[] + java_key_type: + int: AttributeKey + double: AttributeKey + boolean: AttributeKey + string: AttributeKey + string[]: AttributeKey> + int[]: AttributeKey> + double[]: AttributeKey> + boolean[]: AttributeKey> + java_template_key_type: + int: AttributeKeyTemplate + double: AttributeKeyTemplate + boolean: AttributeKeyTemplate + string: AttributeKeyTemplate + string[]: AttributeKeyTemplate> + int[]: AttributeKeyTemplate> + double[]: AttributeKeyTemplate> + boolean[]: AttributeKeyTemplate> + java_key_factory: + int: longKey + double: doubleKey + boolean: booleanKey + string: stringKey + string[]: stringArrayKey + int[]: longArrayKey + double[]: doubleArrayKey + boolean[]: booleanArrayKey + java_template_key_factory: + int: longKeyTemplate + double: doubleKeyTemplate + boolean: booleanKeyTemplate + string: stringKeyTemplate + string[]: stringArrayKeyTemplate + int[]: longArrayKeyTemplate + double[]: doubleArrayKeyTemplate + boolean[]: booleanArrayKeyTemplate + diff --git a/buildscripts/templates/registry/java/SemanticAttributes.java.j2 b/buildscripts/templates/registry/java/SemanticAttributes.java.j2 new file mode 100644 index 0000000..415ef81 --- /dev/null +++ b/buildscripts/templates/registry/java/SemanticAttributes.java.j2 @@ -0,0 +1,59 @@ +{%- macro to_java_key_type(attribute) -%} + {%- if attribute.type is template_type -%} + {{ attribute.type | instantiated_type | map_text("java_template_key_type") }} + {%- else -%} + {{ attribute.type | instantiated_type | map_text("java_key_type") }} + {%- endif %} +{%- endmacro %} +{%- macro to_java_key_factory(attribute) -%} + {%- if attribute.type is template_type -%} + {{ attribute.type | instantiated_type | map_text("java_template_key_factory") }} + {%- else -%} + {{ attribute.type | instantiated_type | map_text("java_key_factory") }} + {%- endif %} +{%- endmacro %} +{%- set my_class_name = ctx.root_namespace | pascal_case ~ "Attributes" -%} + +/* + * Copyright The OpenTelemetry Authors + * SPDX-License-Identifier: Apache-2.0 + */ +package io.opentelemetry.semconv; + +import static io.opentelemetry.api.common.AttributeKey.booleanKey; +import static io.opentelemetry.api.common.AttributeKey.doubleKey; +import static io.opentelemetry.api.common.AttributeKey.longKey; +import static io.opentelemetry.api.common.AttributeKey.stringKey; +import static io.opentelemetry.api.common.AttributeKey.stringArrayKey; + +import static io.opentelemetry.semconv.AttributeKeyTemplate.stringArrayKeyTemplate; +import static io.opentelemetry.semconv.AttributeKeyTemplate.stringKeyTemplate; + +import io.opentelemetry.api.common.AttributeKey; +import io.opentelemetry.semconv.AttributeKeyTemplate; +import java.util.List; + +// DO NOT EDIT, this is an Auto-generated file from buildscripts/templates/registry/java/SemanticAttributes.java.j2 +@SuppressWarnings("unused") +public final class {{ my_class_name }} { + {% for attribute in ctx.attributes %}{% if attribute is stable %} + {%- if attribute is deprecated %} + {%- set deprecated_javadoc = "@deprecated " ~ attribute.deprecated -%} + {%- endif -%} + {{ [attribute.brief, concat_if("\n\nNotes:\n\n", attribute.note), deprecated_javadoc] | comment(indent=4) }} + {% if attribute is deprecated %}@Deprecated{% endif %} public static final {{ to_java_key_type(attribute) | trim }} {{ attribute.name | screaming_snake_case }} = {{ to_java_key_factory(attribute) | trim }}("{{ attribute.name }}"); + {% endif %}{% endfor %} + {% for attribute in ctx.attributes %}{% if attribute is enum and attribute is stable %} + // Enum definition + /** Values for {@link #{{ attribute.name | screaming_snake_case }}}. */ + public static final class {{ attribute.name | pascal_case }}Values { + {%- for member in attribute.type.members %} + {{ [member.brief or (member.id ~ '.')] | comment(indent=4) }} + public static final {{ attribute.type | instantiated_type | map_text("java_enum_type") }} {{ member.id | screaming_snake_case }} = {{ member.value | print_member_value }}; + {%- endfor %} + private {{ attribute.name | pascal_case }}Values() {} + } + {% endif %}{% endfor %} + + private {{ my_class_name }}() {} +} diff --git a/buildscripts/templates/registry/java/weaver.yaml b/buildscripts/templates/registry/java/weaver.yaml new file mode 100644 index 0000000..dbc0301 --- /dev/null +++ b/buildscripts/templates/registry/java/weaver.yaml @@ -0,0 +1,72 @@ +params: + excluded_namespaces: ["ios", "aspnetcore", "signalr"] + excluded_attributes: ["messaging.client_id"] +comment_formats: + javadoc: + format: html + header: "/**" + prefix: " * " + footer: " */" + old_style_paragraph: true + omit_closing_li: true + inline_code_snippet: "{@code {{code}}}" + block_code_snippet: "
{@code {{code}}}
" + trim: true + remove_trailing_dots: false +default_comment_format: javadoc +templates: + - pattern: SemanticAttributes.java.j2 + filter: > + semconv_grouped_attributes({ + "exclude_root_namespace": $excluded_namespaces, + "exclude_stability": ["experimental", "deprecated"], + "exclude_deprecated": false + }) + application_mode: each + file_name: "{{ctx.root_namespace | pascal_case}}Attributes.java" +text_maps: + java_enum_type: + int: long + double: double + boolean: boolean + string: String + string[]: String[] + int[]: long[] + double[]: double[] + boolean[]: boolean[] + java_key_type: + int: AttributeKey + double: AttributeKey + boolean: AttributeKey + string: AttributeKey + string[]: AttributeKey> + int[]: AttributeKey> + double[]: AttributeKey> + boolean[]: AttributeKey> + java_template_key_type: + int: AttributeKeyTemplate + double: AttributeKeyTemplate + boolean: AttributeKeyTemplate + string: AttributeKeyTemplate + string[]: AttributeKeyTemplate> + int[]: AttributeKeyTemplate> + double[]: AttributeKeyTemplate> + boolean[]: AttributeKeyTemplate> + java_key_factory: + int: longKey + double: doubleKey + boolean: booleanKey + string: stringKey + string[]: stringArrayKey + int[]: longArrayKey + double[]: doubleArrayKey + boolean[]: booleanArrayKey + java_template_key_factory: + int: longKeyTemplate + double: doubleKeyTemplate + boolean: booleanKeyTemplate + string: stringKeyTemplate + string[]: stringArrayKeyTemplate + int[]: longArrayKeyTemplate + double[]: doubleArrayKeyTemplate + boolean[]: booleanArrayKeyTemplate diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/AndroidIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/AndroidIncubatingAttributes.java index adb86bb..4ef5a11 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/AndroidIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/AndroidIncubatingAttributes.java @@ -10,10 +10,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class AndroidIncubatingAttributes { - /** * Uniquely identifies the framework API revision offered by a version ({@code os.version}) of the * android operating system. More information can be found Notes: * - * + *

The Android lifecycle states are defined in Activity + * lifecycle callbacks, and from which the {@code OS identifiers} are derived. */ public static final AttributeKey ANDROID_STATE = stringKey("android.state"); diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ArtifactIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ArtifactIncubatingAttributes.java index 26f02f2..3e6d5d8 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ArtifactIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ArtifactIncubatingAttributes.java @@ -10,10 +10,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.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 Notes: * - *

+ *

This file name can also act as the Package Name in cases where the + * package ecosystem maps accordingly. Additionally, the artifact can be published for + * others, but that is not a guarantee. */ public static final AttributeKey ARTIFACT_FILENAME = stringKey("artifact.filename"); @@ -59,14 +56,12 @@ public final class ArtifactIncubatingAttributes { * *

Notes: * - *

    - *
  • 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. - *
+ *

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. */ public static final AttributeKey ARTIFACT_HASH = stringKey("artifact.hash"); @@ -80,5 +75,7 @@ public final class ArtifactIncubatingAttributes { /** The version of the artifact. */ public static final AttributeKey ARTIFACT_VERSION = stringKey("artifact.version"); + // Enum definitions + private ArtifactIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/AwsIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/AwsIncubatingAttributes.java index 893e6fb..aecf5af 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/AwsIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/AwsIncubatingAttributes.java @@ -15,10 +15,9 @@ import java.util.List; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class AwsIncubatingAttributes { - /** The JSON-serialized value of each item in the {@code AttributeDefinitions} request field. */ public static final AttributeKey> AWS_DYNAMODB_ATTRIBUTE_DEFINITIONS = stringArrayKey("aws.dynamodb.attribute_definitions"); @@ -159,9 +158,7 @@ public final class AwsIncubatingAttributes { * *

Notes: * - *

    - *
  • This may be different from {@code cloud.resource_id} if an alias is involved. - *
+ *

This may be different from {@code cloud.resource_id} if an alias is involved. */ public static final AttributeKey AWS_LAMBDA_INVOKED_ARN = stringKey("aws.lambda.invoked_arn"); @@ -171,11 +168,9 @@ public final class AwsIncubatingAttributes { * *

Notes: * - *

+ *

See the log + * group ARN format documentation. */ public static final AttributeKey> AWS_LOG_GROUP_ARNS = stringArrayKey("aws.log.group.arns"); @@ -185,10 +180,8 @@ public final class AwsIncubatingAttributes { * *

Notes: * - *

    - *
  • Multiple log groups must be supported for cases like multi-container applications, where - * a single application has sidecar containers, and each write to their own log group. - *
+ *

Multiple log groups must be supported for cases like multi-container applications, where a + * single application has sidecar containers, and each write to their own log group. */ public static final AttributeKey> AWS_LOG_GROUP_NAMES = stringArrayKey("aws.log.group.names"); @@ -198,12 +191,10 @@ public final class AwsIncubatingAttributes { * *

Notes: * - *

+ *

See the log + * stream ARN format documentation. One log group can contain several log streams, so these + * ARNs necessarily identify both a log group and a log stream. */ public static final AttributeKey> AWS_LOG_STREAM_ARNS = stringArrayKey("aws.log.stream.arns"); @@ -225,11 +216,9 @@ public final class AwsIncubatingAttributes { * *

Notes: * - *

    - *
  • The {@code bucket} attribute is applicable to all S3 operations that reference a bucket, - * i.e. that require the bucket name as a mandatory parameter. This applies to almost all S3 - * operations except {@code list-buckets}. - *
+ *

The {@code bucket} attribute is applicable to all S3 operations that reference a bucket, + * i.e. that require the bucket name as a mandatory parameter. This applies to almost all S3 + * operations except {@code list-buckets}. */ public static final AttributeKey AWS_S3_BUCKET = stringKey("aws.s3.bucket"); @@ -238,11 +227,14 @@ public final class AwsIncubatingAttributes { * *

Notes: * + *

The {@code copy_source} attribute applies to S3 copy operations and corresponds to the + * {@code --copy-source} parameter of the copy-object + * operation within the S3 API. This applies in particular to the following operations: + * + *

+ * *

    - *
  • The {@code copy_source} attribute applies to S3 copy operations and corresponds to the - * {@code --copy-source} parameter of the copy-object - * operation within the S3 API. This applies in particular to the following operations: *
  • copy-object *
  • Notes: * - * + *

    The {@code delete} attribute is only applicable to the delete-object + * operation. The {@code delete} attribute corresponds to the {@code --delete} parameter of the delete-objects + * operation within the S3 API. */ public static final AttributeKey AWS_S3_DELETE = stringKey("aws.s3.delete"); @@ -273,10 +262,13 @@ public final class AwsIncubatingAttributes { * *

    Notes: * + *

    The {@code key} attribute is applicable to all object-related S3 operations, i.e. that + * require the object key as a mandatory parameter. This applies in particular to the following + * operations: + * + *

    + * *

      - *
    • The {@code key} attribute is applicable to all object-related S3 operations, i.e. that - * require the object key as a mandatory parameter. This applies in particular to the - * following operations: *
    • copy-object *
    • Notes: * - * + *

      The {@code part_number} attribute is only applicable to the upload-part + * and upload-part-copy + * operations. The {@code part_number} attribute corresponds to the {@code --part-number} + * parameter of the upload-part + * operation within the S3 API. */ public static final AttributeKey AWS_S3_PART_NUMBER = longKey("aws.s3.part_number"); @@ -331,11 +321,14 @@ public final class AwsIncubatingAttributes { * *

      Notes: * + *

      The {@code upload_id} attribute applies to S3 multipart-upload operations and corresponds to + * the {@code --upload-id} parameter of the S3 API multipart + * operations. This applies in particular to the following operations: + * + *

      + * *

        - *
      • The {@code upload_id} attribute applies to S3 multipart-upload operations and corresponds - * to the {@code --upload-id} parameter of the S3 API - * multipart operations. This applies in particular to the following operations: *
      • abort-multipart-upload *
      • AZ_SERVICE_REQUEST_ID = stringKey("az.service_request_id"); + // Enum definitions + private AzIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/BrowserIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/BrowserIncubatingAttributes.java index a4024b9..8c7ab84 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/BrowserIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/BrowserIncubatingAttributes.java @@ -13,20 +13,17 @@ import java.util.List; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class BrowserIncubatingAttributes { - /** * Array of brand name and version separated by a space * *

        Notes: * - *

        + *

        This value is intended to be taken from the UA client hints API ({@code + * navigator.userAgentData.brands}). */ public static final AttributeKey> BROWSER_BRANDS = stringArrayKey("browser.brands"); @@ -35,9 +32,7 @@ public final class BrowserIncubatingAttributes { * *

        Notes: * - *

          - *
        • This value is intended to be taken from the Navigator API {@code navigator.language}. - *
        + *

        This value is intended to be taken from the Navigator API {@code navigator.language}. */ public static final AttributeKey BROWSER_LANGUAGE = stringKey("browser.language"); @@ -46,11 +41,9 @@ public final class BrowserIncubatingAttributes { * *

        Notes: * - *

          - *
        • This value is intended to be taken from the UA client hints API ({@code - * navigator.userAgentData.mobile}). If unavailable, this attribute SHOULD be left unset. - *
        + *

        This value is intended to be taken from the UA client hints API ({@code + * navigator.userAgentData.mobile}). If unavailable, this attribute SHOULD be left unset. */ public static final AttributeKey BROWSER_MOBILE = booleanKey("browser.mobile"); @@ -59,20 +52,20 @@ public final class BrowserIncubatingAttributes { * *

        Notes: * - *

          - *
        • This value is intended to be taken from the UA client hints API ({@code - * navigator.userAgentData.platform}). If unavailable, the legacy {@code navigator.platform} - * API SHOULD NOT be used instead and this attribute SHOULD be left unset in order for the - * values to be consistent. The list of possible values is defined in the W3C User-Agent Client - * Hints specification. Note that some (but not all) of these values can overlap with - * values in the {@code os.type} and {@code os.name} attributes. - * However, for consistency, the values in the {@code browser.platform} attribute should - * capture the exact value that the user agent provides. - *
        + *

        This value is intended to be taken from the UA client hints API ({@code + * navigator.userAgentData.platform}). If unavailable, the legacy {@code navigator.platform} API + * SHOULD NOT be used instead and this attribute SHOULD be left unset in order for the values to + * be consistent. The list of possible values is defined in the W3C User-Agent Client Hints + * specification. Note that some (but not all) of these values can overlap with values in the + * {@code os.type} and {@code os.name} attributes. However, for consistency, + * the values in the {@code browser.platform} attribute should capture the exact value that the + * user agent provides. */ public static final AttributeKey BROWSER_PLATFORM = stringKey("browser.platform"); + // Enum definitions + private BrowserIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/CicdIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/CicdIncubatingAttributes.java index 0998cf9..7be0976 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/CicdIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/CicdIncubatingAttributes.java @@ -10,10 +10,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class CicdIncubatingAttributes { - /** The human readable name of the pipeline within a CI/CD system. */ public static final AttributeKey CICD_PIPELINE_NAME = stringKey("cicd.pipeline.name"); @@ -46,13 +45,13 @@ public final class CicdIncubatingAttributes { // Enum definitions /** Values for {@link #CICD_PIPELINE_TASK_TYPE}. */ public static final class CicdPipelineTaskTypeValues { - /** build. */ + /** build */ public static final String BUILD = "build"; - /** test. */ + /** test */ public static final String TEST = "test"; - /** deploy. */ + /** deploy */ public static final String DEPLOY = "deploy"; private CicdPipelineTaskTypeValues() {} diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ClientIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ClientIncubatingAttributes.java index 8f80a60..ce50d80 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ClientIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ClientIncubatingAttributes.java @@ -11,21 +11,20 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class ClientIncubatingAttributes { - /** * Client address - domain name if available without reverse DNS lookup; otherwise, IP address or * Unix domain socket name. * *

        Notes: * - *

          - *
        • When observed from the server side, and when communicating through an intermediary, - * {@code client.address} SHOULD represent the client address behind any intermediaries, for - * example proxies, if it's available. - *
        + *

        When observed from the server side, and when communicating through an intermediary, {@code + * client.address} SHOULD represent the client address behind any intermediaries, for example + * proxies, if it's available. + * + *

        * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.ClientAttributes#CLIENT_ADDRESS} attribute. @@ -37,16 +36,18 @@ public final class ClientIncubatingAttributes { * *

        Notes: * - *

          - *
        • When observed from the server side, and when communicating through an intermediary, - * {@code client.port} SHOULD represent the client port behind any intermediaries, for - * example proxies, if it's available. - *
        + *

        When observed from the server side, and when communicating through an intermediary, {@code + * client.port} SHOULD represent the client port behind any intermediaries, for example proxies, + * if it's available. + * + *

        * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.ClientAttributes#CLIENT_PORT} attribute. */ @Deprecated public static final AttributeKey CLIENT_PORT = longKey("client.port"); + // Enum definitions + private ClientIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/CloudIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/CloudIncubatingAttributes.java index ee8cadb..bbdc7dc 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/CloudIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/CloudIncubatingAttributes.java @@ -10,10 +10,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class CloudIncubatingAttributes { - /** The cloud account ID the resource is assigned to. */ public static final AttributeKey CLOUD_ACCOUNT_ID = stringKey("cloud.account.id"); @@ -23,9 +22,7 @@ public final class CloudIncubatingAttributes { * *

        Notes: * - *

          - *
        • Availability zones are called "zones" on Alibaba Cloud and Google Cloud. - *
        + *

        Availability zones are called "zones" on Alibaba Cloud and Google Cloud. */ public static final AttributeKey CLOUD_AVAILABILITY_ZONE = stringKey("cloud.availability_zone"); @@ -35,9 +32,7 @@ public final class CloudIncubatingAttributes { * *

        Notes: * - *

          - *
        • The prefix of the service SHOULD match the one specified in {@code cloud.provider}. - *
        + *

        The prefix of the service SHOULD match the one specified in {@code cloud.provider}. */ public static final AttributeKey CLOUD_PLATFORM = stringKey("cloud.platform"); @@ -49,15 +44,12 @@ public final class CloudIncubatingAttributes { * *

        Notes: * - *

        + *

        Refer to your provider's docs to see the available regions, for example Alibaba Cloud regions, AWS regions, Azure regions, Google Cloud regions, or Tencent Cloud regions. */ public static final AttributeKey CLOUD_REGION = stringKey("cloud.region"); @@ -71,14 +63,18 @@ public final class CloudIncubatingAttributes { * *

        Notes: * + *

        On some cloud providers, it may not be possible to determine the full ID at startup, so it + * may be necessary to set {@code cloud.resource_id} as a span attribute instead. + * + *

        The exact value to use for {@code cloud.resource_id} depends on the cloud provider. The + * following well-known definitions MUST be used if you set this attribute and they apply: + * + *

        + * *

          - *
        • On some cloud providers, it may not be possible to determine the full ID at startup, so - * it may be necessary to set {@code cloud.resource_id} as a span attribute instead. - *
        • The exact value to use for {@code cloud.resource_id} depends on the cloud provider. The - * following well-known definitions MUST be used if you set this attribute and they apply: *
        • AWS Lambda: The function ARN. - * Take care not to use the "invoked ARN" directly but replace any alias * suffix with the resolved function version, as the same runtime instance may be * invocable with multiple different aliases. @@ -98,88 +94,88 @@ public final class CloudIncubatingAttributes { // Enum definitions /** Values for {@link #CLOUD_PLATFORM}. */ public static final class CloudPlatformValues { - /** Alibaba Cloud Elastic Compute Service. */ + /** Alibaba Cloud Elastic Compute Service */ public static final String ALIBABA_CLOUD_ECS = "alibaba_cloud_ecs"; - /** Alibaba Cloud Function Compute. */ + /** Alibaba Cloud Function Compute */ public static final String ALIBABA_CLOUD_FC = "alibaba_cloud_fc"; - /** Red Hat OpenShift on Alibaba Cloud. */ + /** Red Hat OpenShift on Alibaba Cloud */ public static final String ALIBABA_CLOUD_OPENSHIFT = "alibaba_cloud_openshift"; - /** AWS Elastic Compute Cloud. */ + /** AWS Elastic Compute Cloud */ public static final String AWS_EC2 = "aws_ec2"; - /** AWS Elastic Container Service. */ + /** AWS Elastic Container Service */ public static final String AWS_ECS = "aws_ecs"; - /** AWS Elastic Kubernetes Service. */ + /** AWS Elastic Kubernetes Service */ public static final String AWS_EKS = "aws_eks"; - /** AWS Lambda. */ + /** AWS Lambda */ public static final String AWS_LAMBDA = "aws_lambda"; - /** AWS Elastic Beanstalk. */ + /** AWS Elastic Beanstalk */ public static final String AWS_ELASTIC_BEANSTALK = "aws_elastic_beanstalk"; - /** AWS App Runner. */ + /** AWS App Runner */ public static final String AWS_APP_RUNNER = "aws_app_runner"; - /** Red Hat OpenShift on AWS (ROSA). */ + /** Red Hat OpenShift on AWS (ROSA) */ public static final String AWS_OPENSHIFT = "aws_openshift"; - /** Azure Virtual Machines. */ + /** Azure Virtual Machines */ public static final String AZURE_VM = "azure_vm"; - /** Azure Container Apps. */ + /** Azure Container Apps */ public static final String AZURE_CONTAINER_APPS = "azure_container_apps"; - /** Azure Container Instances. */ + /** Azure Container Instances */ public static final String AZURE_CONTAINER_INSTANCES = "azure_container_instances"; - /** Azure Kubernetes Service. */ + /** Azure Kubernetes Service */ public static final String AZURE_AKS = "azure_aks"; - /** Azure Functions. */ + /** Azure Functions */ public static final String AZURE_FUNCTIONS = "azure_functions"; - /** Azure App Service. */ + /** Azure App Service */ public static final String AZURE_APP_SERVICE = "azure_app_service"; - /** Azure Red Hat OpenShift. */ + /** Azure Red Hat OpenShift */ public static final String AZURE_OPENSHIFT = "azure_openshift"; - /** Google Bare Metal Solution (BMS). */ + /** Google Bare Metal Solution (BMS) */ public static final String GCP_BARE_METAL_SOLUTION = "gcp_bare_metal_solution"; - /** Google Cloud Compute Engine (GCE). */ + /** Google Cloud Compute Engine (GCE) */ public static final String GCP_COMPUTE_ENGINE = "gcp_compute_engine"; - /** Google Cloud Run. */ + /** Google Cloud Run */ public static final String GCP_CLOUD_RUN = "gcp_cloud_run"; - /** Google Cloud Kubernetes Engine (GKE). */ + /** Google Cloud Kubernetes Engine (GKE) */ public static final String GCP_KUBERNETES_ENGINE = "gcp_kubernetes_engine"; - /** Google Cloud Functions (GCF). */ + /** Google Cloud Functions (GCF) */ public static final String GCP_CLOUD_FUNCTIONS = "gcp_cloud_functions"; - /** Google Cloud App Engine (GAE). */ + /** Google Cloud App Engine (GAE) */ public static final String GCP_APP_ENGINE = "gcp_app_engine"; - /** Red Hat OpenShift on Google Cloud. */ + /** Red Hat OpenShift on Google Cloud */ public static final String GCP_OPENSHIFT = "gcp_openshift"; - /** Red Hat OpenShift on IBM Cloud. */ + /** Red Hat OpenShift on IBM Cloud */ public static final String IBM_CLOUD_OPENSHIFT = "ibm_cloud_openshift"; - /** Tencent Cloud Cloud Virtual Machine (CVM). */ + /** Tencent Cloud Cloud Virtual Machine (CVM) */ public static final String TENCENT_CLOUD_CVM = "tencent_cloud_cvm"; - /** Tencent Cloud Elastic Kubernetes Service (EKS). */ + /** Tencent Cloud Elastic Kubernetes Service (EKS) */ public static final String TENCENT_CLOUD_EKS = "tencent_cloud_eks"; - /** Tencent Cloud Serverless Cloud Function (SCF). */ + /** Tencent Cloud Serverless Cloud Function (SCF) */ public static final String TENCENT_CLOUD_SCF = "tencent_cloud_scf"; private CloudPlatformValues() {} @@ -187,25 +183,25 @@ private CloudPlatformValues() {} /** Values for {@link #CLOUD_PROVIDER}. */ public static final class CloudProviderValues { - /** Alibaba Cloud. */ + /** Alibaba Cloud */ public static final String ALIBABA_CLOUD = "alibaba_cloud"; - /** Amazon Web Services. */ + /** Amazon Web Services */ public static final String AWS = "aws"; - /** Microsoft Azure. */ + /** Microsoft Azure */ public static final String AZURE = "azure"; - /** Google Cloud Platform. */ + /** Google Cloud Platform */ public static final String GCP = "gcp"; - /** Heroku Platform as a Service. */ + /** Heroku Platform as a Service */ public static final String HEROKU = "heroku"; - /** IBM Cloud. */ + /** IBM Cloud */ public static final String IBM_CLOUD = "ibm_cloud"; - /** Tencent Cloud. */ + /** Tencent Cloud */ public static final String TENCENT_CLOUD = "tencent_cloud"; private CloudProviderValues() {} diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/CloudeventsIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/CloudeventsIncubatingAttributes.java index 31691c2..1045e16 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/CloudeventsIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/CloudeventsIncubatingAttributes.java @@ -10,10 +10,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class CloudeventsIncubatingAttributes { - /** * The event_id @@ -53,5 +52,7 @@ public final class CloudeventsIncubatingAttributes { public static final AttributeKey CLOUDEVENTS_EVENT_TYPE = stringKey("cloudevents.event_type"); + // Enum definitions + private CloudeventsIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/CodeIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/CodeIncubatingAttributes.java index fb8d6da..a0175b3 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/CodeIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/CodeIncubatingAttributes.java @@ -11,10 +11,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class CodeIncubatingAttributes { - /** * The column number in {@code code.filepath} best representing the operation. It SHOULD point * within the code unit named in {@code code.function}. @@ -39,9 +38,9 @@ public final class CodeIncubatingAttributes { public static final AttributeKey CODE_LINENO = longKey("code.lineno"); /** - * The "namespace" within which {@code code.function} is defined. Usually the qualified - * class or module name, such that {@code code.namespace} + some separator + {@code code.function} - * form a unique identifier for the code unit. + * The "namespace" within which {@code code.function} is defined. Usually the qualified class or + * module name, such that {@code code.namespace} + some separator + {@code code.function} form a + * unique identifier for the code unit. */ public static final AttributeKey CODE_NAMESPACE = stringKey("code.namespace"); @@ -51,5 +50,7 @@ public final class CodeIncubatingAttributes { */ public static final AttributeKey CODE_STACKTRACE = stringKey("code.stacktrace"); + // Enum definitions + private CodeIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ContainerIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ContainerIncubatingAttributes.java index ff7aada..b622743 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ContainerIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ContainerIncubatingAttributes.java @@ -14,19 +14,16 @@ import java.util.List; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class ContainerIncubatingAttributes { - /** * The command used to run the container (i.e. the command name). * *

          Notes: * - *

            - *
          • If using embedded credentials or sensitive data, it is recommended to remove them to - * prevent potential leakage. - *
          + *

          If using embedded credentials or sensitive data, it is recommended to remove them to prevent + * potential leakage. */ public static final AttributeKey CONTAINER_COMMAND = stringKey("container.command"); @@ -43,7 +40,9 @@ public final class ContainerIncubatingAttributes { /** * Deprecated, use {@code cpu.mode} instead. * - * @deprecated Deprecated, use `cpu.mode` instead. + *

          + * + * @deprecated Replaced by {@code cpu.mode} */ @Deprecated public static final AttributeKey CONTAINER_CPU_STATE = stringKey("container.cpu.state"); @@ -60,17 +59,15 @@ public final class ContainerIncubatingAttributes { * *

          Notes: * - *

            - *
          • Docker defines a sha256 of the image id; {@code container.image.id} corresponds to the - * {@code Image} field from the Docker container inspect API - * endpoint. K8s defines a link to the container registry repository with digest {@code - * "imageID": "registry.azurecr.io - * /namespace/service/dockerfile@sha256:bdeabd40c3a8a492eaf9e8e44d0ebbb84bac7ee25ac0cf8a7159d25f62555625"}. - * The ID is assigned by the container runtime and can vary in different environments. - * Consider using {@code oci.manifest.digest} if it is important to identify the same image - * in different environments/runtimes. - *
          + *

          Docker defines a sha256 of the image id; {@code container.image.id} corresponds to the + * {@code Image} field from the Docker container inspect API + * endpoint. K8s defines a link to the container registry repository with digest {@code "imageID": + * "registry.azurecr.io + * /namespace/service/dockerfile@sha256:bdeabd40c3a8a492eaf9e8e44d0ebbb84bac7ee25ac0cf8a7159d25f62555625"}. + * The ID is assigned by the container runtime and can vary in different environments. Consider + * using {@code oci.manifest.digest} if it is important to identify the same image in different + * environments/runtimes. */ public static final AttributeKey CONTAINER_IMAGE_ID = stringKey("container.image.id"); @@ -82,13 +79,11 @@ public final class ContainerIncubatingAttributes { * *

          Notes: * - *

            - *
          • Docker - * and CRI - * report those under the {@code RepoDigests} field. - *
          + *

          Docker + * and CRI + * report those under the {@code RepoDigests} field. */ public static final AttributeKey> CONTAINER_IMAGE_REPO_DIGESTS = stringArrayKey("container.image.repo_digests"); @@ -109,7 +104,9 @@ public final class ContainerIncubatingAttributes { /** * Deprecated, use {@code container.label} instead. * - * @deprecated Deprecated, use `container.label` instead. + *

          + * + * @deprecated Replaced by {@code container.label}. */ @Deprecated public static final AttributeKeyTemplate CONTAINER_LABELS = @@ -123,9 +120,9 @@ public final class ContainerIncubatingAttributes { // Enum definitions /** - * Values for {@link #CONTAINER_CPU_STATE}. + * Values for {@link #CONTAINER_CPU_STATE} * - * @deprecated Deprecated, use `cpu.mode` instead. + * @deprecated Replaced by {@code cpu.mode} */ @Deprecated public static final class ContainerCpuStateValues { @@ -135,7 +132,7 @@ public static final class ContainerCpuStateValues { */ public static final String USER = "user"; - /** When CPU is used by the system (host OS). */ + /** When CPU is used by the system (host OS) */ public static final String SYSTEM = "system"; /** diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/CpuIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/CpuIncubatingAttributes.java index 0f3659d..d667dbe 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/CpuIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/CpuIncubatingAttributes.java @@ -10,10 +10,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class CpuIncubatingAttributes { - /** The mode of the CPU */ public static final AttributeKey CPU_MODE = stringKey("cpu.mode"); diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DbIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DbIncubatingAttributes.java index 73d0304..62ecc74 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DbIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DbIncubatingAttributes.java @@ -15,10 +15,9 @@ import io.opentelemetry.semconv.AttributeKeyTemplate; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class DbIncubatingAttributes { - /** * The consistency level of the query. Based on consistency values from CQL. @@ -51,7 +50,9 @@ public final class DbIncubatingAttributes { /** * Deprecated, use {@code db.collection.name} instead. * - * @deprecated Deprecated, use `db.collection.name` instead. + *

          + * + * @deprecated Replaced by {@code db.collection.name}. */ @Deprecated public static final AttributeKey DB_CASSANDRA_TABLE = stringKey("db.cassandra.table"); @@ -74,7 +75,9 @@ public final class DbIncubatingAttributes { /** * Deprecated, use {@code db.client.connection.pool.name} instead. * - * @deprecated Deprecated, use `db.client.connection.pool.name` instead. + *

          + * + * @deprecated Replaced by {@code db.client.connection.pool.name}. */ @Deprecated public static final AttributeKey DB_CLIENT_CONNECTIONS_POOL_NAME = @@ -83,7 +86,9 @@ public final class DbIncubatingAttributes { /** * Deprecated, use {@code db.client.connection.state} instead. * - * @deprecated Deprecated, use `db.client.connection.state` instead. + *

          + * + * @deprecated Replaced by {@code db.client.connection.state}. */ @Deprecated public static final AttributeKey DB_CLIENT_CONNECTIONS_STATE = @@ -94,22 +99,21 @@ public final class DbIncubatingAttributes { * *

          Notes: * - *

            - *
          • It is RECOMMENDED to capture the value as provided by the application without attempting - * to do any case normalization. If the collection name is parsed from the query text, it - * SHOULD be the first collection name found in the query and it SHOULD match the value - * provided in the query text including any schema and database name prefix. For batch - * operations, if the individual operations are known to have the same collection name then - * that collection name SHOULD be used, otherwise {@code db.collection.name} SHOULD NOT be - * captured. - *
          + *

          It is RECOMMENDED to capture the value as provided by the application without attempting to + * do any case normalization. If the collection name is parsed from the query text, it SHOULD be + * the first collection name found in the query and it SHOULD match the value provided in the + * query text including any schema and database name prefix. For batch operations, if the + * individual operations are known to have the same collection name then that collection name + * SHOULD be used, otherwise {@code db.collection.name} SHOULD NOT be captured. */ public static final AttributeKey DB_COLLECTION_NAME = stringKey("db.collection.name"); /** * Deprecated, use {@code server.address}, {@code server.port} attributes instead. * - * @deprecated Deprecated, use `server.address`, `server.port` attributes instead. + *

          + * + * @deprecated "Replaced by {@code server.address} and {@code server.port}." */ @Deprecated public static final AttributeKey DB_CONNECTION_STRING = stringKey("db.connection_string"); @@ -125,7 +129,9 @@ public final class DbIncubatingAttributes { /** * Deprecated, use {@code db.collection.name} instead. * - * @deprecated Deprecated, use `db.collection.name` instead. + *

          + * + * @deprecated Replaced by {@code db.collection.name}. */ @Deprecated public static final AttributeKey DB_COSMOSDB_CONTAINER = @@ -154,7 +160,9 @@ public final class DbIncubatingAttributes { /** * Deprecated, use {@code db.namespace} instead. * - * @deprecated Deprecated, use `db.namespace` instead. + *

          + * + * @deprecated Replaced by {@code db.namespace}. */ @Deprecated public static final AttributeKey DB_ELASTICSEARCH_CLUSTER_NAME = @@ -171,13 +179,11 @@ public final class DbIncubatingAttributes { * *

          Notes: * - *

            - *
          • Many Elasticsearch url paths allow dynamic values. These SHOULD be recorded in span - * attributes in the format {@code db.elasticsearch.path_parts.}, where {@code } - * is the url path part name. The implementation SHOULD reference the elasticsearch - * schema in order to map the path part values to their names. - *
          + *

          Many Elasticsearch url paths allow dynamic values. These SHOULD be recorded in span + * attributes in the format {@code db.elasticsearch.path_parts.}, where {@code } is the + * url path part name. The implementation SHOULD reference the elasticsearch + * schema in order to map the path part values to their names. */ public static final AttributeKeyTemplate DB_ELASTICSEARCH_PATH_PARTS = stringKeyTemplate("db.elasticsearch.path_parts"); @@ -186,15 +192,19 @@ public final class DbIncubatingAttributes { * Deprecated, no general replacement at this time. For Elasticsearch, use {@code * db.elasticsearch.node.name} instead. * - * @deprecated Deprecated, no general replacement at this time. For Elasticsearch, use - * `db.elasticsearch.node.name` instead. + *

          + * + * @deprecated Deprecated, no general replacement at this time. For Elasticsearch, use {@code + * db.elasticsearch.node.name} instead. */ @Deprecated public static final AttributeKey DB_INSTANCE_ID = stringKey("db.instance.id"); /** * Removed, no replacement at this time. * - * @deprecated Removed, no replacement at this time. + *

          + * + * @deprecated Removed as not used. */ @Deprecated public static final AttributeKey DB_JDBC_DRIVER_CLASSNAME = @@ -203,7 +213,9 @@ public final class DbIncubatingAttributes { /** * Deprecated, use {@code db.collection.name} instead. * - * @deprecated Deprecated, use `db.collection.name` instead. + *

          + * + * @deprecated Replaced by {@code db.collection.name}. */ @Deprecated public static final AttributeKey DB_MONGODB_COLLECTION = @@ -212,8 +224,9 @@ public final class DbIncubatingAttributes { /** * Deprecated, SQL Server instance is now populated as a part of {@code db.namespace} attribute. * - * @deprecated Deprecated, SQL Server instance is now populated as a part of `db.namespace` - * attribute. + *

          + * + * @deprecated Deprecated, no replacement at this time. */ @Deprecated public static final AttributeKey DB_MSSQL_INSTANCE_NAME = @@ -222,7 +235,9 @@ public final class DbIncubatingAttributes { /** * Deprecated, use {@code db.namespace} instead. * - * @deprecated Deprecated, use `db.namespace` instead. + *

          + * + * @deprecated Replaced by {@code db.namespace}. */ @Deprecated public static final AttributeKey DB_NAME = stringKey("db.name"); @@ -231,23 +246,22 @@ public final class DbIncubatingAttributes { * *

          Notes: * - *

            - *
          • If a database system has multiple namespace components, they SHOULD be concatenated - * (potentially using database system specific conventions) from most general to most - * specific namespace component, and more specific namespaces SHOULD NOT be captured without - * the more general namespaces, to ensure that "startswith" queries for the more - * general namespaces will be valid. Semantic conventions for individual database systems - * SHOULD document what {@code db.namespace} means in the context of that system. It is - * RECOMMENDED to capture the value as provided by the application without attempting to do - * any case normalization. - *
          + *

          If a database system has multiple namespace components, they SHOULD be concatenated + * (potentially using database system specific conventions) from most general to most specific + * namespace component, and more specific namespaces SHOULD NOT be captured without the more + * general namespaces, to ensure that "startswith" queries for the more general namespaces will be + * valid. Semantic conventions for individual database systems SHOULD document what {@code + * db.namespace} means in the context of that system. It is RECOMMENDED to capture the value as + * provided by the application without attempting to do any case normalization. */ public static final AttributeKey DB_NAMESPACE = stringKey("db.namespace"); /** * Deprecated, use {@code db.operation.name} instead. * - * @deprecated Deprecated, use `db.operation.name` instead. + *

          + * + * @deprecated Replaced by {@code db.operation.name}. */ @Deprecated public static final AttributeKey DB_OPERATION = stringKey("db.operation"); @@ -257,10 +271,8 @@ public final class DbIncubatingAttributes { * *

          Notes: * - *

            - *
          • Operations are only considered batches when they contain two or more operations, and so - * {@code db.operation.batch.size} SHOULD never be {@code 1}. - *
          + *

          Operations are only considered batches when they contain two or more operations, and so + * {@code db.operation.batch.size} SHOULD never be {@code 1}. */ public static final AttributeKey DB_OPERATION_BATCH_SIZE = longKey("db.operation.batch.size"); @@ -270,14 +282,12 @@ public final class DbIncubatingAttributes { * *

          Notes: * - *

            - *
          • It is RECOMMENDED to capture the value as provided by the application without attempting - * to do any case normalization. If the operation name is parsed from the query text, it - * SHOULD be the first operation name found in the query. For batch operations, if the - * individual operations are known to have the same operation name then that operation name - * SHOULD be used prepended by {@code BATCH}, otherwise {@code db.operation.name} SHOULD be - * {@code BATCH} or some other database system specific term if more applicable. - *
          + *

          It is RECOMMENDED to capture the value as provided by the application without attempting to + * do any case normalization. If the operation name is parsed from the query text, it SHOULD be + * the first operation name found in the query. For batch operations, if the individual operations + * are known to have the same operation name then that operation name SHOULD be used prepended by + * {@code BATCH }, otherwise {@code db.operation.name} SHOULD be {@code BATCH} or some other + * database system specific term if more applicable. */ public static final AttributeKey DB_OPERATION_NAME = stringKey("db.operation.name"); @@ -287,11 +297,9 @@ public final class DbIncubatingAttributes { * *

          Notes: * - *

            - *
          • Query parameters should only be captured when {@code db.query.text} is parameterized with - * placeholders. If a parameter has no name and instead is referenced only by index, then - * {@code } SHOULD be the 0-based index. - *
          + *

          Query parameters should only be captured when {@code db.query.text} is parameterized with + * placeholders. If a parameter has no name and instead is referenced only by index, then {@code + * } SHOULD be the 0-based index. */ public static final AttributeKeyTemplate DB_QUERY_PARAMETER = stringKeyTemplate("db.query.parameter"); @@ -301,25 +309,24 @@ public final class DbIncubatingAttributes { * *

          Notes: * - *

            - *
          • For sanitization see Sanitization of - * {@code db.query.text}. For batch operations, if the individual operations are known - * to have the same query text then that query text SHOULD be used, otherwise all of the - * individual query texts SHOULD be concatenated with separator {@code ;} or some other - * database system specific separator if more applicable. Even though parameterized query - * text can potentially have sensitive data, by using a parameterized query the user is - * giving a strong signal that any sensitive data will be passed as parameter values, and - * the benefit to observability of capturing the static part of the query text by default - * outweighs the risk. - *
          + *

          For sanitization see Sanitization of {@code + * db.query.text}. For batch operations, if the individual operations are known to have the + * same query text then that query text SHOULD be used, otherwise all of the individual query + * texts SHOULD be concatenated with separator {@code ; } or some other database system specific + * separator if more applicable. Even though parameterized query text can potentially have + * sensitive data, by using a parameterized query the user is giving a strong signal that any + * sensitive data will be passed as parameter values, and the benefit to observability of + * capturing the static part of the query text by default outweighs the risk. */ public static final AttributeKey DB_QUERY_TEXT = stringKey("db.query.text"); /** * Deprecated, use {@code db.namespace} instead. * - * @deprecated Deprecated, use `db.namespace` instead. + *

          + * + * @deprecated Replaced by {@code db.namespace}. */ @Deprecated public static final AttributeKey DB_REDIS_DATABASE_INDEX = @@ -328,14 +335,18 @@ public final class DbIncubatingAttributes { /** * Deprecated, use {@code db.collection.name} instead. * - * @deprecated Deprecated, use `db.collection.name` instead. + *

          + * + * @deprecated Replaced by {@code db.collection.name}. */ @Deprecated public static final AttributeKey DB_SQL_TABLE = stringKey("db.sql.table"); /** * The database statement being executed. * - * @deprecated The database statement being executed. + *

          + * + * @deprecated Replaced by {@code db.query.text}. */ @Deprecated public static final AttributeKey DB_STATEMENT = stringKey("db.statement"); @@ -344,18 +355,18 @@ public final class DbIncubatingAttributes { * *

          Notes: * - *

            - *
          • The actual DBMS may differ from the one identified by the client. For example, when using - * PostgreSQL client libraries to connect to a CockroachDB, the {@code db.system} is set to - * {@code postgresql} based on the instrumentation's best knowledge. - *
          + *

          The actual DBMS may differ from the one identified by the client. For example, when using + * PostgreSQL client libraries to connect to a CockroachDB, the {@code db.system} is set to {@code + * postgresql} based on the instrumentation's best knowledge. */ public static final AttributeKey DB_SYSTEM = stringKey("db.system"); /** * Deprecated, no replacement at this time. * - * @deprecated Deprecated, no replacement at this time. + *

          + * + * @deprecated No replacement at this time. */ @Deprecated public static final AttributeKey DB_USER = stringKey("db.user"); @@ -410,9 +421,9 @@ private DbClientConnectionStateValues() {} } /** - * Values for {@link #DB_CLIENT_CONNECTIONS_STATE}. + * Values for {@link #DB_CLIENT_CONNECTIONS_STATE} * - * @deprecated Deprecated, use `db.client.connection.state` instead. + * @deprecated Replaced by {@code db.client.connection.state}. */ @Deprecated public static final class DbClientConnectionsStateValues { @@ -427,7 +438,7 @@ private DbClientConnectionsStateValues() {} /** Values for {@link #DB_COSMOSDB_CONNECTION_MODE}. */ public static final class DbCosmosdbConnectionModeValues { - /** Gateway (HTTP) connections mode. */ + /** Gateway (HTTP) connections mode */ public static final String GATEWAY = "gateway"; /** Direct connection. */ @@ -491,163 +502,163 @@ public static final class DbSystemValues { /** Some other SQL database. Fallback only. See notes. */ public static final String OTHER_SQL = "other_sql"; - /** Adabas (Adaptable Database System). */ + /** Adabas (Adaptable Database System) */ public static final String ADABAS = "adabas"; - /** Deprecated, use `intersystems_cache` instead. */ + /** Deprecated, use {@code intersystems_cache} instead. */ public static final String CACHE = "cache"; - /** InterSystems Caché. */ + /** InterSystems Caché */ public static final String INTERSYSTEMS_CACHE = "intersystems_cache"; - /** Apache Cassandra. */ + /** Apache Cassandra */ public static final String CASSANDRA = "cassandra"; - /** ClickHouse. */ + /** ClickHouse */ public static final String CLICKHOUSE = "clickhouse"; - /** Deprecated, use `other_sql` instead. */ + /** Deprecated, use {@code other_sql} instead. */ public static final String CLOUDSCAPE = "cloudscape"; - /** CockroachDB. */ + /** CockroachDB */ public static final String COCKROACHDB = "cockroachdb"; /** Deprecated, no replacement at this time. */ public static final String COLDFUSION = "coldfusion"; - /** Microsoft Azure Cosmos DB. */ + /** Microsoft Azure Cosmos DB */ public static final String COSMOSDB = "cosmosdb"; - /** Couchbase. */ + /** Couchbase */ public static final String COUCHBASE = "couchbase"; - /** CouchDB. */ + /** CouchDB */ public static final String COUCHDB = "couchdb"; - /** IBM Db2. */ + /** IBM Db2 */ public static final String DB2 = "db2"; - /** Apache Derby. */ + /** Apache Derby */ public static final String DERBY = "derby"; - /** Amazon DynamoDB. */ + /** Amazon DynamoDB */ public static final String DYNAMODB = "dynamodb"; - /** EnterpriseDB. */ + /** EnterpriseDB */ public static final String EDB = "edb"; - /** Elasticsearch. */ + /** Elasticsearch */ public static final String ELASTICSEARCH = "elasticsearch"; - /** FileMaker. */ + /** FileMaker */ public static final String FILEMAKER = "filemaker"; - /** Firebird. */ + /** Firebird */ public static final String FIREBIRD = "firebird"; - /** Deprecated, use `other_sql` instead. */ + /** Deprecated, use {@code other_sql} instead. */ public static final String FIRSTSQL = "firstsql"; - /** Apache Geode. */ + /** Apache Geode */ public static final String GEODE = "geode"; - /** H2. */ + /** H2 */ public static final String H2 = "h2"; - /** SAP HANA. */ + /** SAP HANA */ public static final String HANADB = "hanadb"; - /** Apache HBase. */ + /** Apache HBase */ public static final String HBASE = "hbase"; - /** Apache Hive. */ + /** Apache Hive */ public static final String HIVE = "hive"; - /** HyperSQL DataBase. */ + /** HyperSQL DataBase */ public static final String HSQLDB = "hsqldb"; - /** InfluxDB. */ + /** InfluxDB */ public static final String INFLUXDB = "influxdb"; - /** Informix. */ + /** Informix */ public static final String INFORMIX = "informix"; - /** Ingres. */ + /** Ingres */ public static final String INGRES = "ingres"; - /** InstantDB. */ + /** InstantDB */ public static final String INSTANTDB = "instantdb"; - /** InterBase. */ + /** InterBase */ public static final String INTERBASE = "interbase"; - /** MariaDB. */ + /** MariaDB */ public static final String MARIADB = "mariadb"; - /** SAP MaxDB. */ + /** SAP MaxDB */ public static final String MAXDB = "maxdb"; - /** Memcached. */ + /** Memcached */ public static final String MEMCACHED = "memcached"; - /** MongoDB. */ + /** MongoDB */ public static final String MONGODB = "mongodb"; - /** Microsoft SQL Server. */ + /** Microsoft SQL Server */ public static final String MSSQL = "mssql"; /** Deprecated, Microsoft SQL Server Compact is discontinued. */ public static final String MSSQLCOMPACT = "mssqlcompact"; - /** MySQL. */ + /** MySQL */ public static final String MYSQL = "mysql"; - /** Neo4j. */ + /** Neo4j */ public static final String NEO4J = "neo4j"; - /** Netezza. */ + /** Netezza */ public static final String NETEZZA = "netezza"; - /** OpenSearch. */ + /** OpenSearch */ public static final String OPENSEARCH = "opensearch"; - /** Oracle Database. */ + /** Oracle Database */ public static final String ORACLE = "oracle"; - /** Pervasive PSQL. */ + /** Pervasive PSQL */ public static final String PERVASIVE = "pervasive"; - /** PointBase. */ + /** PointBase */ public static final String POINTBASE = "pointbase"; - /** PostgreSQL. */ + /** PostgreSQL */ public static final String POSTGRESQL = "postgresql"; - /** Progress Database. */ + /** Progress Database */ public static final String PROGRESS = "progress"; - /** Redis. */ + /** Redis */ public static final String REDIS = "redis"; - /** Amazon Redshift. */ + /** Amazon Redshift */ public static final String REDSHIFT = "redshift"; - /** Cloud Spanner. */ + /** Cloud Spanner */ public static final String SPANNER = "spanner"; - /** SQLite. */ + /** SQLite */ public static final String SQLITE = "sqlite"; - /** Sybase. */ + /** Sybase */ public static final String SYBASE = "sybase"; - /** Teradata. */ + /** Teradata */ public static final String TERADATA = "teradata"; - /** Trino. */ + /** Trino */ public static final String TRINO = "trino"; - /** Vertica. */ + /** Vertica */ public static final String VERTICA = "vertica"; private DbSystemValues() {} diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DeploymentIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DeploymentIncubatingAttributes.java index 3e59c41..bec65df 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DeploymentIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DeploymentIncubatingAttributes.java @@ -10,14 +10,15 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class DeploymentIncubatingAttributes { - /** * 'Deprecated, use {@code deployment.environment.name} instead.' * - * @deprecated 'Deprecated, use `deployment.environment.name` instead.'. + *

          + * + * @deprecated Deprecated, use {@code deployment.environment.name} instead. */ @Deprecated public static final AttributeKey DEPLOYMENT_ENVIRONMENT = @@ -29,11 +30,14 @@ public final class DeploymentIncubatingAttributes { * *

          Notes: * + *

          {@code deployment.environment.name} does not affect the uniqueness constraints defined + * through the {@code service.namespace}, {@code service.name} and {@code service.instance.id} + * resource attributes. This implies that resources carrying the following attribute combinations + * MUST be considered to be identifying the same service: + * + *

          + * *

            - *
          • {@code deployment.environment.name} does not affect the uniqueness constraints defined - * through the {@code service.namespace}, {@code service.name} and {@code - * service.instance.id} resource attributes. This implies that resources carrying the - * following attribute combinations MUST be considered to be identifying the same service: *
          • {@code service.name=frontend}, {@code deployment.environment.name=production} *
          • {@code service.name=frontend}, {@code deployment.environment.name=staging}. *
          @@ -53,10 +57,10 @@ public final class DeploymentIncubatingAttributes { // Enum definitions /** Values for {@link #DEPLOYMENT_STATUS}. */ public static final class DeploymentStatusValues { - /** failed. */ + /** failed */ public static final String FAILED = "failed"; - /** succeeded. */ + /** succeeded */ public static final String SUCCEEDED = "succeeded"; private DeploymentStatusValues() {} diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DestinationIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DestinationIncubatingAttributes.java index 1b9d015..b17e085 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DestinationIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DestinationIncubatingAttributes.java @@ -11,26 +11,25 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class DestinationIncubatingAttributes { - /** * Destination address - domain name if available without reverse DNS lookup; otherwise, IP * address or Unix domain socket name. * *

          Notes: * - *

            - *
          • When observed from the source side, and when communicating through an intermediary, - * {@code destination.address} SHOULD represent the destination address behind any - * intermediaries, for example proxies, if it's available. - *
          + *

          When observed from the source side, and when communicating through an intermediary, {@code + * destination.address} SHOULD represent the destination address behind any intermediaries, for + * example proxies, if it's available. */ public static final AttributeKey DESTINATION_ADDRESS = stringKey("destination.address"); /** Destination port number */ public static final AttributeKey DESTINATION_PORT = longKey("destination.port"); + // Enum definitions + private DestinationIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DeviceIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DeviceIncubatingAttributes.java index 3718a51..a7e445d 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DeviceIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DeviceIncubatingAttributes.java @@ -10,28 +10,25 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class DeviceIncubatingAttributes { - /** * A unique identifier representing the device * *

          Notes: * - *

            - *
          • The device identifier MUST only be defined using the values outlined below. This value is - * not an advertising identifier and MUST NOT be used as such. On iOS (Swift or - * Objective-C), this value MUST be equal to the vendor - * identifier. On Android (Java or Kotlin), this value MUST be equal to the Firebase - * Installation ID or a globally unique UUID which is persisted across sessions in your - * application. More information can be found here on best - * practices and exact implementation details. Caution should be taken when storing personal - * data or anything which can identify a user. GDPR and data protection laws may apply, - * ensure you do your own due diligence. - *
          + *

          The device identifier MUST only be defined using the values outlined below. This value is + * not an advertising identifier and MUST NOT be used as such. On iOS (Swift or Objective-C), this + * value MUST be equal to the vendor + * identifier. On Android (Java or Kotlin), this value MUST be equal to the Firebase + * Installation ID or a globally unique UUID which is persisted across sessions in your + * application. More information can be found here on best practices + * and exact implementation details. Caution should be taken when storing personal data or + * anything which can identify a user. GDPR and data protection laws may apply, ensure you do your + * own due diligence. */ public static final AttributeKey DEVICE_ID = stringKey("device.id"); @@ -40,11 +37,9 @@ public final class DeviceIncubatingAttributes { * *

          Notes: * - *

            - *
          • The Android OS provides this field via Build. - * iOS apps SHOULD hardcode the value {@code Apple}. - *
          + *

          The Android OS provides this field via Build. iOS + * apps SHOULD hardcode the value {@code Apple}. */ public static final AttributeKey DEVICE_MANUFACTURER = stringKey("device.manufacturer"); @@ -53,10 +48,8 @@ public final class DeviceIncubatingAttributes { * *

          Notes: * - *

            - *
          • It's recommended this value represents a machine-readable version of the model identifier - * rather than the market or consumer-friendly name of the device. - *
          + *

          It's recommended this value represents a machine-readable version of the model identifier + * rather than the market or consumer-friendly name of the device. */ public static final AttributeKey DEVICE_MODEL_IDENTIFIER = stringKey("device.model.identifier"); @@ -66,12 +59,12 @@ public final class DeviceIncubatingAttributes { * *

          Notes: * - *

            - *
          • It's recommended this value represents a human-readable version of the device model - * rather than a machine-readable alternative. - *
          + *

          It's recommended this value represents a human-readable version of the device model rather + * than a machine-readable alternative. */ public static final AttributeKey DEVICE_MODEL_NAME = stringKey("device.model.name"); + // Enum definitions + private DeviceIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DiskIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DiskIncubatingAttributes.java index fc49fd4..eb9e3f0 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DiskIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DiskIncubatingAttributes.java @@ -10,10 +10,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class DiskIncubatingAttributes { - /** The disk IO operation direction. */ public static final AttributeKey DISK_IO_DIRECTION = stringKey("disk.io.direction"); diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DnsIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DnsIncubatingAttributes.java index ef01ec0..5b265de 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DnsIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DnsIncubatingAttributes.java @@ -10,23 +10,22 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class DnsIncubatingAttributes { - /** * The name being queried. * *

          Notes: * - *

            - *
          • If the name field contains non-printable characters (below 32 or above 126), those - * characters should be represented as escaped base 10 integers (\DDD). Back slashes and - * quotes should be escaped. Tabs, carriage returns, and line feeds should be converted to - * \t, \r, and \n respectively. - *
          + *

          If the name field contains non-printable characters (below 32 or above 126), those + * characters should be represented as escaped base 10 integers (\DDD). Back slashes and quotes + * should be escaped. Tabs, carriage returns, and line feeds should be converted to \t, \r, and \n + * respectively. */ public static final AttributeKey DNS_QUESTION_NAME = stringKey("dns.question.name"); + // Enum definitions + private DnsIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/EnduserIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/EnduserIncubatingAttributes.java index ba981e4..cdf48b6 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/EnduserIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/EnduserIncubatingAttributes.java @@ -10,30 +10,37 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class EnduserIncubatingAttributes { - /** * Deprecated, use {@code user.id} instead. * - * @deprecated Deprecated, use `user.id` instead. + *

          + * + * @deprecated Replaced by {@code user.id} attribute. */ @Deprecated public static final AttributeKey ENDUSER_ID = stringKey("enduser.id"); /** * Deprecated, use {@code user.roles} instead. * - * @deprecated Deprecated, use `user.roles` instead. + *

          + * + * @deprecated Replaced by {@code user.roles} attribute. */ @Deprecated public static final AttributeKey ENDUSER_ROLE = stringKey("enduser.role"); /** * Deprecated, no replacement at this time. * - * @deprecated Deprecated, no replacement at this time. + *

          + * + * @deprecated Removed. */ @Deprecated public static final AttributeKey ENDUSER_SCOPE = stringKey("enduser.scope"); + // Enum definitions + private EnduserIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ErrorIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ErrorIncubatingAttributes.java index 21ad81e..5400bc2 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ErrorIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ErrorIncubatingAttributes.java @@ -10,28 +10,35 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class ErrorIncubatingAttributes { - /** * Describes a class of error the operation ended with. * *

          Notes: * + *

          The {@code error.type} SHOULD be predictable, and SHOULD have low cardinality. + * + *

          When {@code error.type} is set to a type (e.g., an exception type), its canonical class name + * identifying the type within the artifact SHOULD be used. + * + *

          Instrumentations SHOULD document the list of errors they report. + * + *

          The cardinality of {@code error.type} within one instrumentation library SHOULD be low. + * Telemetry consumers that aggregate data from multiple instrumentation libraries and + * applications should be prepared for {@code error.type} to have high cardinality at query time + * when no additional filters are applied. + * + *

          If the operation has completed successfully, instrumentations SHOULD NOT set {@code + * error.type}. + * + *

          If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status + * codes), it's RECOMMENDED to: + * + *

          + * *

            - *
          • The {@code error.type} SHOULD be predictable, and SHOULD have low cardinality. - *
          • When {@code error.type} is set to a type (e.g., an exception type), its canonical class - * name identifying the type within the artifact SHOULD be used. - *
          • Instrumentations SHOULD document the list of errors they report. - *
          • The cardinality of {@code error.type} within one instrumentation library SHOULD be low. - * Telemetry consumers that aggregate data from multiple instrumentation libraries and - * applications should be prepared for {@code error.type} to have high cardinality at query - * time when no additional filters are applied. - *
          • If the operation has completed successfully, instrumentations SHOULD NOT set {@code - * error.type}. - *
          • If a specific domain defines its own set of error identifiers (such as HTTP or gRPC - * status codes), it's RECOMMENDED to: *
          • Use a domain-specific attribute *
          • Set {@code error.type} to capture all errors, regardless of whether they are defined * within the domain-specific set or not. @@ -47,13 +54,11 @@ public final class ErrorIncubatingAttributes { * Values for {@link #ERROR_TYPE}. * * @deprecated deprecated in favor of stable {@link - * io.opentelemetry.semconv.ErrorAttributes.ErrorTypeValues} attribute. + * io.opentelemetry.semconv.ErrorAttributes.ErrorTypeValues}. */ @Deprecated public static final class ErrorTypeValues { - /** - * A fallback error value to be used when the instrumentation doesn't define a custom value. - */ + /** A fallback error value to be used when the instrumentation doesn't define a custom value. */ public static final String OTHER = "_OTHER"; private ErrorTypeValues() {} diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/EventIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/EventIncubatingAttributes.java index c0708f2..42a9b78 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/EventIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/EventIncubatingAttributes.java @@ -10,23 +10,22 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class EventIncubatingAttributes { - /** * Identifies the class / type of event. * *

            Notes: * - *

              - *
            • Event names are subject to the same rules as attribute names. Notably, event names are - * namespaced to avoid collisions and provide a clean separation of semantics for events in - * separate domains like browser, mobile, and kubernetes. - *
            + *

            Event names are subject to the same rules as attribute names. Notably, event names are + * namespaced to avoid collisions and provide a clean separation of semantics for events in + * separate domains like browser, mobile, and kubernetes. */ public static final AttributeKey EVENT_NAME = stringKey("event.name"); + // Enum definitions + private EventIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ExceptionIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ExceptionIncubatingAttributes.java index 657cf2a..e1482ad 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ExceptionIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ExceptionIncubatingAttributes.java @@ -11,32 +11,30 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class ExceptionIncubatingAttributes { - /** * SHOULD be set to true if the exception event is recorded at a point where it is known that the * exception is escaping the scope of the span. * *

            Notes: * - *

              - *
            • An exception is considered to have escaped (or left) the scope of a span, if that span is - * ended while the exception is still logically "in flight". This may be actually - * "in flight" in some languages (e.g. if the exception is passed to a Context - * manager's {@code __exit__} method in Python) but will usually be caught at the point of - * recording the exception in most languages. - *
            • It is usually not possible to determine at the point where an exception is thrown whether - * it will escape the scope of a span. However, it is trivial to know that an exception will - * escape, if one checks for an active exception just before ending the span, as done in the - * example - * for recording span exceptions. - *
            • It follows that an exception may still escape the scope of the span even if the {@code - * exception.escaped} attribute was not set or set to false, since the event might have been - * recorded at a time where it was not clear whether the exception will escape. - *
            + *

            An exception is considered to have escaped (or left) the scope of a span, if that span is + * ended while the exception is still logically "in flight". This may be actually "in flight" in + * some languages (e.g. if the exception is passed to a Context manager's {@code __exit__} method + * in Python) but will usually be caught at the point of recording the exception in most + * languages. + * + *

            It is usually not possible to determine at the point where an exception is thrown whether it + * will escape the scope of a span. However, it is trivial to know that an exception will escape, + * if one checks for an active exception just before ending the span, as done in the example + * for recording span exceptions. + * + *

            It follows that an exception may still escape the scope of the span even if the {@code + * exception.escaped} attribute was not set or set to false, since the event might have been + * recorded at a time where it was not clear whether the exception will escape. * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.ExceptionAttributes#EXCEPTION_ESCAPED} attribute. @@ -47,6 +45,8 @@ public final class ExceptionIncubatingAttributes { /** * The exception message. * + *

            + * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.ExceptionAttributes#EXCEPTION_MESSAGE} attribute. */ @@ -57,6 +57,8 @@ public final class ExceptionIncubatingAttributes { * A stacktrace as a string in the natural representation for the language runtime. The * representation is to be determined and documented by each language SIG. * + *

            + * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.ExceptionAttributes#EXCEPTION_STACKTRACE} attribute. */ @@ -67,10 +69,14 @@ public final class ExceptionIncubatingAttributes { * The type of the exception (its fully-qualified class name, if applicable). The dynamic type of * the exception should be preferred over the static type in languages that support it. * + *

            + * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.ExceptionAttributes#EXCEPTION_TYPE} attribute. */ @Deprecated public static final AttributeKey EXCEPTION_TYPE = stringKey("exception.type"); + // Enum definitions + private ExceptionIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/FaasIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/FaasIncubatingAttributes.java index 68cc656..5ea5f93 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/FaasIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/FaasIncubatingAttributes.java @@ -12,10 +12,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class FaasIncubatingAttributes { - /** * A boolean that is true if the serverless function is executed for the first time (aka * cold-start). @@ -59,6 +58,8 @@ public final class FaasIncubatingAttributes { * *

            Notes: * + *

            + * *

              *
            • AWS Lambda: Use the (full) log stream name. *
            @@ -73,9 +74,7 @@ public final class FaasIncubatingAttributes { * *

            Notes: * - *

              - *
            • SHOULD be equal to the {@code faas.name} resource attribute of the invoked function. - *
            + *

            SHOULD be equal to the {@code faas.name} resource attribute of the invoked function. */ public static final AttributeKey FAAS_INVOKED_NAME = stringKey("faas.invoked_name"); @@ -84,9 +83,7 @@ public final class FaasIncubatingAttributes { * *

            Notes: * - *

              - *
            • SHOULD be equal to the {@code cloud.provider} resource attribute of the invoked function. - *
            + *

            SHOULD be equal to the {@code cloud.provider} resource attribute of the invoked function. */ public static final AttributeKey FAAS_INVOKED_PROVIDER = stringKey("faas.invoked_provider"); @@ -96,9 +93,7 @@ public final class FaasIncubatingAttributes { * *

            Notes: * - *

              - *
            • SHOULD be equal to the {@code cloud.region} resource attribute of the invoked function. - *
            + *

            SHOULD be equal to the {@code cloud.region} resource attribute of the invoked function. */ public static final AttributeKey FAAS_INVOKED_REGION = stringKey("faas.invoked_region"); @@ -107,12 +102,10 @@ public final class FaasIncubatingAttributes { * *

            Notes: * - *

              - *
            • It's recommended to set this attribute since e.g. too little memory can easily stop a - * Java AWS Lambda function from working correctly. On AWS Lambda, the environment variable - * {@code AWS_LAMBDA_FUNCTION_MEMORY_SIZE} provides this information (which must be - * multiplied by 1,048,576). - *
            + *

            It's recommended to set this attribute since e.g. too little memory can easily stop a Java + * AWS Lambda function from working correctly. On AWS Lambda, the environment variable {@code + * AWS_LAMBDA_FUNCTION_MEMORY_SIZE} provides this information (which must be multiplied by + * 1,048,576). */ public static final AttributeKey FAAS_MAX_MEMORY = longKey("faas.max_memory"); @@ -121,14 +114,18 @@ public final class FaasIncubatingAttributes { * *

            Notes: * + *

            This is the name of the function as configured/deployed on the FaaS platform and is usually + * different from the name of the callback function (which may be stored in the {@code code.namespace}/{@code + * code.function} span attributes). + * + *

            For some cloud providers, the above definition is ambiguous. The following definition of + * function name MUST be used for this attribute (and consequently the span name) for the listed + * cloud providers/products: + * + *

            + * *

              - *
            • This is the name of the function as configured/deployed on the FaaS platform and is - * usually different from the name of the callback function (which may be stored in the {@code code.namespace}/{@code - * code.function} span attributes). - *
            • For some cloud providers, the above definition is ambiguous. The following definition of - * function name MUST be used for this attribute (and consequently the span name) for the - * listed cloud providers/products: *
            • Azure: The full name {@code /}, i.e., function app name * followed by a forward slash followed by the function name (this form can also be seen in * the resource JSON for the function). This means that a span attribute MUST be used, as an @@ -153,8 +150,11 @@ public final class FaasIncubatingAttributes { * *

              Notes: * + *

              Depending on the cloud provider and platform, use: + * + *

              + * *

                - *
              • Depending on the cloud provider and platform, use: *
              • AWS Lambda: The function * version (an integer represented as a decimal string). @@ -186,19 +186,19 @@ private FaasDocumentOperationValues() {} /** Values for {@link #FAAS_INVOKED_PROVIDER}. */ public static final class FaasInvokedProviderValues { - /** Alibaba Cloud. */ + /** Alibaba Cloud */ public static final String ALIBABA_CLOUD = "alibaba_cloud"; - /** Amazon Web Services. */ + /** Amazon Web Services */ public static final String AWS = "aws"; - /** Microsoft Azure. */ + /** Microsoft Azure */ public static final String AZURE = "azure"; - /** Google Cloud Platform. */ + /** Google Cloud Platform */ public static final String GCP = "gcp"; - /** Tencent Cloud. */ + /** Tencent Cloud */ public static final String TENCENT_CLOUD = "tencent_cloud"; private FaasInvokedProviderValues() {} @@ -206,19 +206,19 @@ private FaasInvokedProviderValues() {} /** Values for {@link #FAAS_TRIGGER}. */ public static final class FaasTriggerValues { - /** A response to some data source operation such as a database or filesystem read/write. */ + /** A response to some data source operation such as a database or filesystem read/write */ public static final String DATASOURCE = "datasource"; - /** To provide an answer to an inbound HTTP request. */ + /** To provide an answer to an inbound HTTP request */ public static final String HTTP = "http"; - /** A function is set to be executed when messages are sent to a messaging system. */ + /** A function is set to be executed when messages are sent to a messaging system */ public static final String PUBSUB = "pubsub"; - /** A function is scheduled to be executed regularly. */ + /** A function is scheduled to be executed regularly */ public static final String TIMER = "timer"; - /** If none of the others apply. */ + /** If none of the others apply */ public static final String OTHER = "other"; private FaasTriggerValues() {} diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/FeatureFlagIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/FeatureFlagIncubatingAttributes.java index 50fd950..fb55216 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/FeatureFlagIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/FeatureFlagIncubatingAttributes.java @@ -10,10 +10,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class FeatureFlagIncubatingAttributes { - /** The unique identifier of the feature flag. */ public static final AttributeKey FEATURE_FLAG_KEY = stringKey("feature_flag.key"); @@ -27,17 +26,17 @@ public final class FeatureFlagIncubatingAttributes { * *

                Notes: * - *

                  - *
                • A semantic identifier, commonly referred to as a variant, provides a means for referring - * to a value without including the value itself. This can provide additional context for - * understanding the meaning behind a value. For example, the variant {@code red} maybe be - * used for the value {@code #c05543}. - *
                • A stringified version of the value can be used in situations where a semantic identifier - * is unavailable. String representation of the value should be determined by the - * implementer. - *
                + *

                A semantic identifier, commonly referred to as a variant, provides a means for referring to + * a value without including the value itself. This can provide additional context for + * understanding the meaning behind a value. For example, the variant {@code red} maybe be used + * for the value {@code #c05543}. + * + *

                A stringified version of the value can be used in situations where a semantic identifier is + * unavailable. String representation of the value should be determined by the implementer. */ public static final AttributeKey FEATURE_FLAG_VARIANT = stringKey("feature_flag.variant"); + // Enum definitions + private FeatureFlagIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/FileIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/FileIncubatingAttributes.java index e44f561..85f5d10 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/FileIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/FileIncubatingAttributes.java @@ -11,10 +11,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class FileIncubatingAttributes { - /** Directory where the file is located. It should include the drive letter, when appropriate. */ public static final AttributeKey FILE_DIRECTORY = stringKey("file.directory"); @@ -23,10 +22,8 @@ public final class FileIncubatingAttributes { * *

                Notes: * - *

                  - *
                • When the file name has multiple extensions (example.tar.gz), only the last one should be - * captured ("gz", not "tar.gz"). - *
                + *

                When the file name has multiple extensions (example.tar.gz), only the last one should be + * captured ("gz", not "tar.gz"). */ public static final AttributeKey FILE_EXTENSION = stringKey("file.extension"); @@ -42,5 +39,7 @@ public final class FileIncubatingAttributes { /** File size in bytes. */ public static final AttributeKey FILE_SIZE = longKey("file.size"); + // Enum definitions + private FileIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/GcpIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/GcpIncubatingAttributes.java index 50315c5..33dda09 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/GcpIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/GcpIncubatingAttributes.java @@ -11,21 +11,17 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class GcpIncubatingAttributes { - /** * Identifies the Google Cloud service for which the official client library is intended. * *

                Notes: * - *

                  - *
                • Intended to be a stable identifier for Google Cloud client libraries that is uniform - * across implementation languages. The value should be derived from the canonical service - * domain for the service; for example, 'foo.googleapis.com' should result in a value of - * 'foo'. - *
                + *

                Intended to be a stable identifier for Google Cloud client libraries that is uniform across + * implementation languages. The value should be derived from the canonical service domain for the + * service; for example, 'foo.googleapis.com' should result in a value of 'foo'. */ public static final AttributeKey GCP_CLIENT_SERVICE = stringKey("gcp.client.service"); @@ -64,5 +60,7 @@ public final class GcpIncubatingAttributes { public static final AttributeKey GCP_GCE_INSTANCE_NAME = stringKey("gcp.gce.instance.name"); + // Enum definitions + private GcpIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/GenAiIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/GenAiIncubatingAttributes.java index ada9ea9..e52a1e4 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/GenAiIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/GenAiIncubatingAttributes.java @@ -14,19 +14,16 @@ import java.util.List; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class GenAiIncubatingAttributes { - /** * The full response received from the GenAI model. * *

                Notes: * - *

                + *

                It's RECOMMENDED to format completions as JSON string matching OpenAI messages format */ public static final AttributeKey GEN_AI_COMPLETION = stringKey("gen_ai.completion"); @@ -35,12 +32,10 @@ public final class GenAiIncubatingAttributes { * *

                Notes: * - *

                  - *
                • If one of the predefined values applies, but specific system uses a different name it's - * RECOMMENDED to document it in the semantic conventions for specific GenAI system and use - * system-specific name in the instrumentation. If a different name is not documented, - * instrumentation libraries SHOULD use applicable predefined value. - *
                + *

                If one of the predefined values applies, but specific system uses a different name it's + * RECOMMENDED to document it in the semantic conventions for specific GenAI system and use + * system-specific name in the instrumentation. If a different name is not documented, + * instrumentation libraries SHOULD use applicable predefined value. */ public static final AttributeKey GEN_AI_OPERATION_NAME = stringKey("gen_ai.operation.name"); @@ -50,10 +45,8 @@ public final class GenAiIncubatingAttributes { * *

                Notes: * - *

                + *

                It's RECOMMENDED to format prompts as JSON string matching OpenAI messages format */ public static final AttributeKey GEN_AI_PROMPT = stringKey("gen_ai.prompt"); @@ -105,15 +98,15 @@ public final class GenAiIncubatingAttributes { * *

                Notes: * - *

                  - *
                • The {@code gen_ai.system} describes a family of GenAI models with specific model - * identified by {@code gen_ai.request.model} and {@code gen_ai.response.model} attributes. - *
                • The actual GenAI product may differ from the one identified by the client. For example, - * when using OpenAI client libraries to communicate with Mistral, the {@code gen_ai.system} - * is set to {@code openai} based on the instrumentation's best knowledge. - *
                • For custom model, a custom friendly name SHOULD be used. If none of these options apply, - * the {@code gen_ai.system} SHOULD be set to {@code _OTHER}. - *
                + *

                The {@code gen_ai.system} describes a family of GenAI models with specific model identified + * by {@code gen_ai.request.model} and {@code gen_ai.response.model} attributes. + * + *

                The actual GenAI product may differ from the one identified by the client. For example, when + * using OpenAI client libraries to communicate with Mistral, the {@code gen_ai.system} is set to + * {@code openai} based on the instrumentation's best knowledge. + * + *

                For custom model, a custom friendly name SHOULD be used. If none of these options apply, the + * {@code gen_ai.system} SHOULD be set to {@code _OTHER}. */ public static final AttributeKey GEN_AI_SYSTEM = stringKey("gen_ai.system"); @@ -123,7 +116,9 @@ public final class GenAiIncubatingAttributes { /** * Deprecated, use {@code gen_ai.usage.output_tokens} instead. * - * @deprecated Deprecated, use `gen_ai.usage.output_tokens` instead. + *

                + * + * @deprecated Replaced by {@code gen_ai.usage.output_tokens} attribute. */ @Deprecated public static final AttributeKey GEN_AI_USAGE_COMPLETION_TOKENS = @@ -140,7 +135,9 @@ public final class GenAiIncubatingAttributes { /** * Deprecated, use {@code gen_ai.usage.input_tokens} instead. * - * @deprecated Deprecated, use `gen_ai.usage.input_tokens` instead. + *

                + * + * @deprecated Replaced by {@code gen_ai.usage.input_tokens} attribute. */ @Deprecated public static final AttributeKey GEN_AI_USAGE_PROMPT_TOKENS = @@ -150,14 +147,15 @@ public final class GenAiIncubatingAttributes { /** Values for {@link #GEN_AI_OPERATION_NAME}. */ public static final class GenAiOperationNameValues { /** - * Chat completion operation such as [OpenAI Chat - * API](https://platform.openai.com/docs/api-reference/chat). + * Chat completion operation such as OpenAI Chat API */ public static final String CHAT = "chat"; /** - * Text completions operation such as [OpenAI Completions API - * (Legacy)](https://platform.openai.com/docs/api-reference/completions). + * Text completions operation such as OpenAI Completions API + * (Legacy) */ public static final String TEXT_COMPLETION = "text_completion"; @@ -166,16 +164,16 @@ private GenAiOperationNameValues() {} /** Values for {@link #GEN_AI_SYSTEM}. */ public static final class GenAiSystemValues { - /** OpenAI. */ + /** OpenAI */ public static final String OPENAI = "openai"; - /** Vertex AI. */ + /** Vertex AI */ public static final String VERTEX_AI = "vertex_ai"; - /** Anthropic. */ + /** Anthropic */ public static final String ANTHROPIC = "anthropic"; - /** Cohere. */ + /** Cohere */ public static final String COHERE = "cohere"; private GenAiSystemValues() {} @@ -183,10 +181,10 @@ private GenAiSystemValues() {} /** Values for {@link #GEN_AI_TOKEN_TYPE}. */ public static final class GenAiTokenTypeValues { - /** Input tokens (prompt, input, etc.). */ + /** Input tokens (prompt, input, etc.) */ public static final String INPUT = "input"; - /** Output tokens (completion, response, etc.). */ + /** Output tokens (completion, response, etc.) */ public static final String COMPLETION = "output"; private GenAiTokenTypeValues() {} diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/GoIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/GoIncubatingAttributes.java index 2a71c2d..b38e12f 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/GoIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/GoIncubatingAttributes.java @@ -10,10 +10,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class GoIncubatingAttributes { - /** The type of memory. */ public static final AttributeKey GO_MEMORY_TYPE = stringKey("go.memory.type"); diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/GraphqlIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/GraphqlIncubatingAttributes.java index 8e09c2e..8e075ce 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/GraphqlIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/GraphqlIncubatingAttributes.java @@ -10,18 +10,15 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class GraphqlIncubatingAttributes { - /** * The GraphQL document being executed. * *

                Notes: * - *

                  - *
                • The value may be sanitized to exclude sensitive information. - *
                + *

                The value may be sanitized to exclude sensitive information. */ public static final AttributeKey GRAPHQL_DOCUMENT = stringKey("graphql.document"); @@ -36,13 +33,13 @@ public final class GraphqlIncubatingAttributes { // Enum definitions /** Values for {@link #GRAPHQL_OPERATION_TYPE}. */ public static final class GraphqlOperationTypeValues { - /** GraphQL query. */ + /** GraphQL query */ public static final String QUERY = "query"; - /** GraphQL mutation. */ + /** GraphQL mutation */ public static final String MUTATION = "mutation"; - /** GraphQL subscription. */ + /** GraphQL subscription */ public static final String SUBSCRIPTION = "subscription"; private GraphqlOperationTypeValues() {} diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/HerokuIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/HerokuIncubatingAttributes.java index a18d3f8..1aca39a 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/HerokuIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/HerokuIncubatingAttributes.java @@ -10,10 +10,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class HerokuIncubatingAttributes { - /** Unique identifier for the application */ public static final AttributeKey HEROKU_APP_ID = stringKey("heroku.app.id"); @@ -25,5 +24,7 @@ public final class HerokuIncubatingAttributes { public static final AttributeKey HEROKU_RELEASE_CREATION_TIMESTAMP = stringKey("heroku.release.creation_timestamp"); + // Enum definitions + private HerokuIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/HostIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/HostIncubatingAttributes.java index 39296d9..1ff665b 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/HostIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/HostIncubatingAttributes.java @@ -13,10 +13,9 @@ import java.util.List; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class HostIncubatingAttributes { - /** The CPU architecture the host system is running on. */ public static final AttributeKey HOST_ARCH = stringKey("host.arch"); @@ -43,11 +42,9 @@ public final class HostIncubatingAttributes { * *

                Notes: * - *

                  - *
                • CPUID command returns the vendor ID string in - * EBX, EDX and ECX registers. Writing these to memory in this order results in a - * 12-character string. - *
                + *

                CPUID command returns the vendor ID string in + * EBX, EDX and ECX registers. Writing these to memory in this order results in a 12-character + * string. */ public static final AttributeKey HOST_CPU_VENDOR_ID = stringKey("host.cpu.vendor.id"); @@ -75,11 +72,8 @@ public final class HostIncubatingAttributes { * *

                Notes: * - *

                  - *
                • IPv4 Addresses MUST be specified in dotted-quad notation. IPv6 addresses MUST be - * specified in the RFC 5952 - * format. - *
                + *

                IPv4 Addresses MUST be specified in dotted-quad notation. IPv6 addresses MUST be specified + * in the RFC 5952 format. */ public static final AttributeKey> HOST_IP = stringArrayKey("host.ip"); @@ -88,12 +82,10 @@ public final class HostIncubatingAttributes { * *

                Notes: * - *

                  - *
                • MAC Addresses MUST be represented in IEEE - * RA hexadecimal form: as hyphen-separated octets in uppercase hexadecimal form from - * most to least significant. - *
                + *

                MAC Addresses MUST be represented in IEEE RA + * hexadecimal form: as hyphen-separated octets in uppercase hexadecimal form from most to + * least significant. */ public static final AttributeKey> HOST_MAC = stringArrayKey("host.mac"); @@ -109,28 +101,28 @@ public final class HostIncubatingAttributes { // Enum definitions /** Values for {@link #HOST_ARCH}. */ public static final class HostArchValues { - /** AMD64. */ + /** AMD64 */ public static final String AMD64 = "amd64"; - /** ARM32. */ + /** ARM32 */ public static final String ARM32 = "arm32"; - /** ARM64. */ + /** ARM64 */ public static final String ARM64 = "arm64"; - /** Itanium. */ + /** Itanium */ public static final String IA64 = "ia64"; - /** 32-bit PowerPC. */ + /** 32-bit PowerPC */ public static final String PPC32 = "ppc32"; - /** 64-bit PowerPC. */ + /** 64-bit PowerPC */ public static final String PPC64 = "ppc64"; - /** IBM z/Architecture. */ + /** IBM z/Architecture */ public static final String S390X = "s390x"; - /** 32-bit x86. */ + /** 32-bit x86 */ public static final String X86 = "x86"; private HostArchValues() {} diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/HttpIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/HttpIncubatingAttributes.java index 29995e4..7a141e1 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/HttpIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/HttpIncubatingAttributes.java @@ -14,14 +14,15 @@ import java.util.List; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class HttpIncubatingAttributes { - /** * Deprecated, use {@code client.address} instead. * - * @deprecated Deprecated, use `client.address` instead. + *

                + * + * @deprecated Replaced by {@code client.address}. */ @Deprecated public static final AttributeKey HTTP_CLIENT_IP = stringKey("http.client_ip"); @@ -32,7 +33,9 @@ public final class HttpIncubatingAttributes { /** * Deprecated, use {@code network.protocol.name} instead. * - * @deprecated Deprecated, use `network.protocol.name` instead. + *

                + * + * @deprecated Replaced by {@code network.protocol.name}. */ @Deprecated public static final AttributeKey HTTP_FLAVOR = stringKey("http.flavor"); @@ -40,15 +43,19 @@ public final class HttpIncubatingAttributes { * Deprecated, use one of {@code server.address}, {@code client.address} or {@code * http.request.header.host} instead, depending on the usage. * - * @deprecated Deprecated, use one of `server.address`, `client.address` or - * `http.request.header.host` instead, depending on the usage. + *

                + * + * @deprecated Replaced by one of {@code server.address}, {@code client.address} or {@code + * http.request.header.host}, depending on the usage. */ @Deprecated public static final AttributeKey HTTP_HOST = stringKey("http.host"); /** * Deprecated, use {@code http.request.method} instead. * - * @deprecated Deprecated, use `http.request.method` instead. + *

                + * + * @deprecated Replaced by {@code http.request.method}. */ @Deprecated public static final AttributeKey HTTP_METHOD = stringKey("http.method"); @@ -66,16 +73,15 @@ public final class HttpIncubatingAttributes { * *

                Notes: * - *

                  - *
                • Instrumentations SHOULD require an explicit configuration of which headers are to be - * captured. Including all request headers can be a security risk - explicit configuration - * helps avoid leaking sensitive information. The {@code User-Agent} header is already - * captured in the {@code user_agent.original} attribute. Users MAY explicitly configure - * instrumentations to capture them even though it is not recommended. The attribute value - * MUST consist of either multiple header values as an array of strings or a single-item - * array containing a possibly comma-concatenated string, depending on the way the HTTP - * library provides access to headers. - *
                + *

                Instrumentations SHOULD require an explicit configuration of which headers are to be + * captured. Including all request headers can be a security risk - explicit configuration helps + * avoid leaking sensitive information. The {@code User-Agent} header is already captured in the + * {@code user_agent.original} attribute. Users MAY explicitly configure instrumentations to + * capture them even though it is not recommended. The attribute value MUST consist of either + * multiple header values as an array of strings or a single-item array containing a possibly + * comma-concatenated string, depending on the way the HTTP library provides access to headers. + * + *

                * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.HttpAttributes#HTTP_REQUEST_HEADER} attribute. @@ -89,25 +95,28 @@ public final class HttpIncubatingAttributes { * *

                Notes: * - *

                  - *
                • HTTP request method value SHOULD be "known" to the instrumentation. By default, - * this convention defines "known" methods as the ones listed in RFC9110 and the PATCH - * method defined in RFC5789. - *
                • If the HTTP request method is not known to instrumentation, it MUST set the {@code - * http.request.method} attribute to {@code _OTHER}. - *
                • If the HTTP instrumentation could end up converting valid HTTP request methods to {@code - * _OTHER}, then it MUST provide a way to override the list of known HTTP methods. If this - * override is done via environment variable, then the environment variable MUST be named - * OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of - * case-sensitive known HTTP methods (this list MUST be a full override of the default known - * method, it is not a list of known methods in addition to the defaults). - *
                • HTTP method names are case-sensitive and {@code http.request.method} attribute value MUST - * match a known HTTP method name exactly. Instrumentations for specific web frameworks that - * consider HTTP methods to be case insensitive, SHOULD populate a canonical equivalent. - * Tracing instrumentations that do so, MUST also set {@code http.request.method_original} - * to the original value. - *
                + *

                HTTP request method value SHOULD be "known" to the instrumentation. By default, this + * convention defines "known" methods as the ones listed in RFC9110 and the PATCH + * method defined in RFC5789. + * + *

                If the HTTP request method is not known to instrumentation, it MUST set the {@code + * http.request.method} attribute to {@code _OTHER}. + * + *

                If the HTTP instrumentation could end up converting valid HTTP request methods to {@code + * _OTHER}, then it MUST provide a way to override the list of known HTTP methods. If this + * override is done via environment variable, then the environment variable MUST be named + * OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of case-sensitive + * known HTTP methods (this list MUST be a full override of the default known method, it is not a + * list of known methods in addition to the defaults). + * + *

                HTTP method names are case-sensitive and {@code http.request.method} attribute value MUST + * match a known HTTP method name exactly. Instrumentations for specific web frameworks that + * consider HTTP methods to be case insensitive, SHOULD populate a canonical equivalent. Tracing + * instrumentations that do so, MUST also set {@code http.request.method_original} to the original + * value. + * + *

                * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.HttpAttributes#HTTP_REQUEST_METHOD} attribute. @@ -118,6 +127,8 @@ public final class HttpIncubatingAttributes { /** * Original HTTP method sent by the client in the request line. * + *

                + * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.HttpAttributes#HTTP_REQUEST_METHOD_ORIGINAL} attribute. */ @@ -130,11 +141,11 @@ public final class HttpIncubatingAttributes { * *

                Notes: * - *

                  - *
                • The resend count SHOULD be updated each time an HTTP request gets resent by the client, - * regardless of what was the cause of the resending (e.g. redirection, authorization - * failure, 503 Server Unavailable, network issues, or any other). - *
                + *

                The resend count SHOULD be updated each time an HTTP request gets resent by the client, + * regardless of what was the cause of the resending (e.g. redirection, authorization failure, 503 + * Server Unavailable, network issues, or any other). + * + *

                * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.HttpAttributes#HTTP_REQUEST_RESEND_COUNT} attribute. @@ -153,7 +164,9 @@ public final class HttpIncubatingAttributes { /** * Deprecated, use {@code http.request.header.content-length} instead. * - * @deprecated Deprecated, use `http.request.header.content-length` instead. + *

                + * + * @deprecated Replaced by {@code http.request.header.content-length}. */ @Deprecated public static final AttributeKey HTTP_REQUEST_CONTENT_LENGTH = @@ -162,7 +175,9 @@ public final class HttpIncubatingAttributes { /** * Deprecated, use {@code http.request.body.size} instead. * - * @deprecated Deprecated, use `http.request.body.size` instead. + *

                + * + * @deprecated Replaced by {@code http.request.body.size}. */ @Deprecated public static final AttributeKey HTTP_REQUEST_CONTENT_LENGTH_UNCOMPRESSED = @@ -183,15 +198,14 @@ public final class HttpIncubatingAttributes { * *

                Notes: * - *

                  - *
                • Instrumentations SHOULD require an explicit configuration of which headers are to be - * captured. Including all response headers can be a security risk - explicit configuration - * helps avoid leaking sensitive information. Users MAY explicitly configure - * instrumentations to capture them even though it is not recommended. The attribute value - * MUST consist of either multiple header values as an array of strings or a single-item - * array containing a possibly comma-concatenated string, depending on the way the HTTP - * library provides access to headers. - *
                + *

                Instrumentations SHOULD require an explicit configuration of which headers are to be + * captured. Including all response headers can be a security risk - explicit configuration helps + * avoid leaking sensitive information. Users MAY explicitly configure instrumentations to capture + * them even though it is not recommended. The attribute value MUST consist of either multiple + * header values as an array of strings or a single-item array containing a possibly + * comma-concatenated string, depending on the way the HTTP library provides access to headers. + * + *

                * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.HttpAttributes#HTTP_RESPONSE_HEADER} attribute. @@ -210,6 +224,8 @@ public final class HttpIncubatingAttributes { /** * HTTP response status code. * + *

                + * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.HttpAttributes#HTTP_RESPONSE_STATUS_CODE} attribute. */ @@ -220,7 +236,9 @@ public final class HttpIncubatingAttributes { /** * Deprecated, use {@code http.response.header.content-length} instead. * - * @deprecated Deprecated, use `http.response.header.content-length` instead. + *

                + * + * @deprecated Replaced by {@code http.response.header.content-length}. */ @Deprecated public static final AttributeKey HTTP_RESPONSE_CONTENT_LENGTH = @@ -229,7 +247,9 @@ public final class HttpIncubatingAttributes { /** * Deprecated, use {@code http.response.body.size} instead. * - * @deprecated Deprecated, use `http.response.body.size` instead. + *

                + * + * @deprecated Replace by {@code http.response.body.size}. */ @Deprecated public static final AttributeKey HTTP_RESPONSE_CONTENT_LENGTH_UNCOMPRESSED = @@ -241,12 +261,12 @@ public final class HttpIncubatingAttributes { * *

                Notes: * - *

                  - *
                • MUST NOT be populated when this is not supported by the HTTP server framework as the - * route attribute should have low-cardinality and the URI path can NOT substitute it. - * SHOULD include the application - * root if there is one. - *
                + *

                MUST NOT be populated when this is not supported by the HTTP server framework as the route + * attribute should have low-cardinality and the URI path can NOT substitute it. SHOULD include + * the application root if there is + * one. + * + *

                * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.HttpAttributes#HTTP_ROUTE} attribute. @@ -256,14 +276,18 @@ public final class HttpIncubatingAttributes { /** * Deprecated, use {@code url.scheme} instead. * - * @deprecated Deprecated, use `url.scheme` instead. + *

                + * + * @deprecated Replaced by {@code url.scheme} instead. */ @Deprecated public static final AttributeKey HTTP_SCHEME = stringKey("http.scheme"); /** * Deprecated, use {@code server.address} instead. * - * @deprecated Deprecated, use `server.address` instead. + *

                + * + * @deprecated Replaced by {@code server.address}. */ @Deprecated public static final AttributeKey HTTP_SERVER_NAME = stringKey("http.server_name"); @@ -271,28 +295,36 @@ public final class HttpIncubatingAttributes { /** * Deprecated, use {@code http.response.status_code} instead. * - * @deprecated Deprecated, use `http.response.status_code` instead. + *

                + * + * @deprecated Replaced by {@code http.response.status_code}. */ @Deprecated public static final AttributeKey HTTP_STATUS_CODE = longKey("http.status_code"); /** * Deprecated, use {@code url.path} and {@code url.query} instead. * - * @deprecated Deprecated, use `url.path` and `url.query` instead. + *

                + * + * @deprecated Split to {@code url.path} and `url.query. */ @Deprecated public static final AttributeKey HTTP_TARGET = stringKey("http.target"); /** * Deprecated, use {@code url.full} instead. * - * @deprecated Deprecated, use `url.full` instead. + *

                + * + * @deprecated Replaced by {@code url.full}. */ @Deprecated public static final AttributeKey HTTP_URL = stringKey("http.url"); /** * Deprecated, use {@code user_agent.original} instead. * - * @deprecated Deprecated, use `user_agent.original` instead. + *

                + * + * @deprecated Replaced by {@code user_agent.original}. */ @Deprecated public static final AttributeKey HTTP_USER_AGENT = stringKey("http.user_agent"); @@ -310,22 +342,22 @@ private HttpConnectionStateValues() {} } /** - * Values for {@link #HTTP_FLAVOR}. + * Values for {@link #HTTP_FLAVOR} * - * @deprecated Deprecated, use `network.protocol.name` instead. + * @deprecated Replaced by {@code network.protocol.name}. */ @Deprecated public static final class HttpFlavorValues { - /** HTTP/1.0. */ + /** HTTP/1.0 */ public static final String HTTP_1_0 = "1.0"; - /** HTTP/1.1. */ + /** HTTP/1.1 */ public static final String HTTP_1_1 = "1.1"; - /** HTTP/2. */ + /** HTTP/2 */ public static final String HTTP_2_0 = "2.0"; - /** HTTP/3. */ + /** HTTP/3 */ public static final String HTTP_3_0 = "3.0"; /** SPDY protocol. */ @@ -341,7 +373,7 @@ private HttpFlavorValues() {} * Values for {@link #HTTP_REQUEST_METHOD}. * * @deprecated deprecated in favor of stable {@link - * io.opentelemetry.semconv.HttpAttributes.HttpRequestMethodValues} attribute. + * io.opentelemetry.semconv.HttpAttributes.HttpRequestMethodValues}. */ @Deprecated public static final class HttpRequestMethodValues { diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/JvmIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/JvmIncubatingAttributes.java index b42d5f2..365fc94 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/JvmIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/JvmIncubatingAttributes.java @@ -11,19 +11,16 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class JvmIncubatingAttributes { - /** * Name of the buffer pool. * *

                Notes: * - *

                + *

                Pool names are generally obtained via BufferPoolMXBean#getName(). */ public static final AttributeKey JVM_BUFFER_POOL_NAME = stringKey("jvm.buffer.pool.name"); @@ -32,10 +29,10 @@ public final class JvmIncubatingAttributes { * *

                Notes: * - *

                + *

                Garbage collector action is generally obtained via GarbageCollectionNotificationInfo#getGcAction(). + * + *

                * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.JvmAttributes#JVM_GC_ACTION} attribute. @@ -47,10 +44,10 @@ public final class JvmIncubatingAttributes { * *

                Notes: * - *

                + *

                Garbage collector name is generally obtained via GarbageCollectionNotificationInfo#getGcName(). + * + *

                * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.JvmAttributes#JVM_GC_NAME} attribute. @@ -62,10 +59,10 @@ public final class JvmIncubatingAttributes { * *

                Notes: * - *

                + *

                Pool names are generally obtained via MemoryPoolMXBean#getName(). + * + *

                * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.JvmAttributes#JVM_MEMORY_POOL_NAME} attribute. @@ -76,6 +73,8 @@ public final class JvmIncubatingAttributes { /** * The type of memory. * + *

                + * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.JvmAttributes#JVM_MEMORY_TYPE} attribute. */ @@ -85,6 +84,8 @@ public final class JvmIncubatingAttributes { /** * Whether the thread is daemon or not. * + *

                + * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.JvmAttributes#JVM_THREAD_DAEMON} attribute. */ @@ -94,6 +95,8 @@ public final class JvmIncubatingAttributes { /** * State of the thread. * + *

                + * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.JvmAttributes#JVM_THREAD_STATE} attribute. */ @@ -105,14 +108,14 @@ public final class JvmIncubatingAttributes { * Values for {@link #JVM_MEMORY_TYPE}. * * @deprecated deprecated in favor of stable {@link - * io.opentelemetry.semconv.JvmAttributes.JvmMemoryTypeValues} attribute. + * io.opentelemetry.semconv.JvmAttributes.JvmMemoryTypeValues}. */ @Deprecated public static final class JvmMemoryTypeValues { /** Heap memory. */ public static final String HEAP = "heap"; - /** Non-heap memory. */ + /** Non-heap memory */ public static final String NON_HEAP = "non_heap"; private JvmMemoryTypeValues() {} @@ -122,7 +125,7 @@ private JvmMemoryTypeValues() {} * Values for {@link #JVM_THREAD_STATE}. * * @deprecated deprecated in favor of stable {@link - * io.opentelemetry.semconv.JvmAttributes.JvmThreadStateValues} attribute. + * io.opentelemetry.semconv.JvmAttributes.JvmThreadStateValues}. */ @Deprecated public static final class JvmThreadStateValues { diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/K8sIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/K8sIncubatingAttributes.java index ec9df27..87898cc 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/K8sIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/K8sIncubatingAttributes.java @@ -13,10 +13,9 @@ import io.opentelemetry.semconv.AttributeKeyTemplate; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class K8sIncubatingAttributes { - /** The name of the cluster. */ public static final AttributeKey K8S_CLUSTER_NAME = stringKey("k8s.cluster.name"); @@ -25,23 +24,29 @@ public final class K8sIncubatingAttributes { * *

                Notes: * - *

                  - *
                • K8s doesn't have support for obtaining a cluster ID. If this is ever added, we will - * recommend collecting the {@code k8s.cluster.uid} through the official APIs. In the - * meantime, we are able to use the {@code uid} of the {@code kube-system} namespace as a - * proxy for cluster ID. Read on for the rationale. - *
                • Every object created in a K8s cluster is assigned a distinct UID. The {@code kube-system} - * namespace is used by Kubernetes itself and will exist for the lifetime of the cluster. - * Using the {@code uid} of the {@code kube-system} namespace is a reasonable proxy for the - * K8s ClusterID as it will only change if the cluster is rebuilt. Furthermore, Kubernetes - * UIDs are UUIDs as standardized by ISO/IEC 9834-8 and ITU-T - * X.667. Which states: - *
                • If generated according to one of the mechanisms defined in Rec. ITU-T X.667 | ISO/IEC - * 9834-8, a UUID is either guaranteed to be different from all other UUIDs generated before - * 3603 A.D., or is extremely likely to be different (depending on the mechanism chosen). - *
                • Therefore, UIDs between clusters should be extremely unlikely to conflict. - *
                + *

                K8s doesn't have support for obtaining a cluster ID. If this is ever added, we will + * recommend collecting the {@code k8s.cluster.uid} through the official APIs. In the meantime, we + * are able to use the {@code uid} of the {@code kube-system} namespace as a proxy for cluster ID. + * Read on for the rationale. + * + *

                Every object created in a K8s cluster is assigned a distinct UID. The {@code kube-system} + * namespace is used by Kubernetes itself and will exist for the lifetime of the cluster. Using + * the {@code uid} of the {@code kube-system} namespace is a reasonable proxy for the K8s + * ClusterID as it will only change if the cluster is rebuilt. Furthermore, Kubernetes UIDs are + * UUIDs as standardized by ISO/IEC + * 9834-8 and ITU-T X.667. Which states: + * + *

                + * + *

                + * + * If generated according to one of the mechanisms defined in Rec. ITU-T X.667 | ISO/IEC 9834-8, a + * UUID is either guaranteed to be different from all other UUIDs generated before 3603 A.D., or + * is extremely likely to be different (depending on the mechanism chosen). + * + *
                + * + *

                Therefore, UIDs between clusters should be extremely unlikely to conflict. */ public static final AttributeKey K8S_CLUSTER_UID = stringKey("k8s.cluster.uid"); @@ -112,7 +117,9 @@ public final class K8sIncubatingAttributes { /** * Deprecated, use {@code k8s.pod.label} instead. * - * @deprecated Deprecated, use `k8s.pod.label` instead. + *

                + * + * @deprecated Replaced by {@code k8s.pod.label}. */ @Deprecated public static final AttributeKeyTemplate K8S_POD_LABELS = @@ -136,5 +143,7 @@ public final class K8sIncubatingAttributes { /** The UID of the StatefulSet. */ public static final AttributeKey K8S_STATEFULSET_UID = stringKey("k8s.statefulset.uid"); + // Enum definitions + private K8sIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/LinuxIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/LinuxIncubatingAttributes.java index 75f145d..0ba4e05 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/LinuxIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/LinuxIncubatingAttributes.java @@ -10,10 +10,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class LinuxIncubatingAttributes { - /** The Linux Slab memory state */ public static final AttributeKey LINUX_MEMORY_SLAB_STATE = stringKey("linux.memory.slab.state"); diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/LogIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/LogIncubatingAttributes.java index 2d4b259..6a75ecf 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/LogIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/LogIncubatingAttributes.java @@ -10,10 +10,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class LogIncubatingAttributes { - /** The basename of the file. */ public static final AttributeKey LOG_FILE_NAME = stringKey("log.file.name"); @@ -36,11 +35,9 @@ public final class LogIncubatingAttributes { * *

                Notes: * - *

                  - *
                • This value MAY be added when processing a Log Record which was originally transmitted as - * a string or equivalent data type AND the Body field of the Log Record does not contain - * the same value. (e.g. a syslog or a log record read from a file.) - *
                + *

                This value MAY be added when processing a Log Record which was originally transmitted as a + * string or equivalent data type AND the Body field of the Log Record does not contain the same + * value. (e.g. a syslog or a log record read from a file.) */ public static final AttributeKey LOG_RECORD_ORIGINAL = stringKey("log.record.original"); @@ -49,23 +46,21 @@ public final class LogIncubatingAttributes { * *

                Notes: * - *

                  - *
                • If an id is provided, other log records with the same id will be considered duplicates - * and can be removed safely. This means, that two distinguishable log records MUST have - * different values. The id MAY be an Universally - * Unique Lexicographically Sortable Identifier (ULID), but other identifiers (e.g. - * UUID) may be used as needed. - *
                + *

                If an id is provided, other log records with the same id will be considered duplicates and + * can be removed safely. This means, that two distinguishable log records MUST have different + * values. The id MAY be an Universally Unique + * Lexicographically Sortable Identifier (ULID), but other identifiers (e.g. UUID) may be used + * as needed. */ public static final AttributeKey LOG_RECORD_UID = stringKey("log.record.uid"); // Enum definitions /** Values for {@link #LOG_IOSTREAM}. */ public static final class LogIostreamValues { - /** Logs from stdout stream. */ + /** Logs from stdout stream */ public static final String STDOUT = "stdout"; - /** Events from stderr stream. */ + /** Events from stderr stream */ public static final String STDERR = "stderr"; private LogIostreamValues() {} diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/MessageIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/MessageIncubatingAttributes.java index 620e73a..06d8e75 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/MessageIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/MessageIncubatingAttributes.java @@ -11,14 +11,15 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class MessageIncubatingAttributes { - /** * Deprecated, use {@code rpc.message.compressed_size} instead. * - * @deprecated Deprecated, use `rpc.message.compressed_size` instead. + *

                + * + * @deprecated Replaced by {@code rpc.message.compressed_size}. */ @Deprecated public static final AttributeKey MESSAGE_COMPRESSED_SIZE = @@ -27,21 +28,27 @@ public final class MessageIncubatingAttributes { /** * Deprecated, use {@code rpc.message.id} instead. * - * @deprecated Deprecated, use `rpc.message.id` instead. + *

                + * + * @deprecated Replaced by {@code rpc.message.id}. */ @Deprecated public static final AttributeKey MESSAGE_ID = longKey("message.id"); /** * Deprecated, use {@code rpc.message.type} instead. * - * @deprecated Deprecated, use `rpc.message.type` instead. + *

                + * + * @deprecated Replaced by {@code rpc.message.type}. */ @Deprecated public static final AttributeKey MESSAGE_TYPE = stringKey("message.type"); /** * Deprecated, use {@code rpc.message.uncompressed_size} instead. * - * @deprecated Deprecated, use `rpc.message.uncompressed_size` instead. + *

                + * + * @deprecated Replaced by {@code rpc.message.uncompressed_size}. */ @Deprecated public static final AttributeKey MESSAGE_UNCOMPRESSED_SIZE = @@ -49,9 +56,9 @@ public final class MessageIncubatingAttributes { // Enum definitions /** - * Values for {@link #MESSAGE_TYPE}. + * Values for {@link #MESSAGE_TYPE} * - * @deprecated Deprecated, use `rpc.message.type` instead. + * @deprecated Replaced by {@code rpc.message.type}. */ @Deprecated public static final class MessageTypeValues { diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/MessagingIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/MessagingIncubatingAttributes.java index 9fdd6d3..15a78f2 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/MessagingIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/MessagingIncubatingAttributes.java @@ -14,22 +14,18 @@ import java.util.List; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class MessagingIncubatingAttributes { - /** * The number of messages sent, received, or processed in the scope of the batching operation. * *

                Notes: * - *

                  - *
                • Instrumentations SHOULD NOT set {@code messaging.batch.message_count} on spans that - * operate with a single message. When a messaging client library supports both batch and - * single-message API for the same operation, instrumentations SHOULD use {@code - * messaging.batch.message_count} for batching APIs and SHOULD NOT use it for single-message - * APIs. - *
                + *

                Instrumentations SHOULD NOT set {@code messaging.batch.message_count} on spans that operate + * with a single message. When a messaging client library supports both batch and single-message + * API for the same operation, instrumentations SHOULD use {@code messaging.batch.message_count} + * for batching APIs and SHOULD NOT use it for single-message APIs. */ public static final AttributeKey MESSAGING_BATCH_MESSAGE_COUNT = longKey("messaging.batch.message_count"); @@ -42,11 +38,8 @@ public final class MessagingIncubatingAttributes { * *

                Notes: * - *

                  - *
                • Semantic conventions for individual messaging systems SHOULD document whether {@code - * messaging.consumer.group.name} is applicable and what it means in the context of that - * system. - *
                + *

                Semantic conventions for individual messaging systems SHOULD document whether {@code + * messaging.consumer.group.name} is applicable and what it means in the context of that system. */ public static final AttributeKey MESSAGING_CONSUMER_GROUP_NAME = stringKey("messaging.consumer.group.name"); @@ -63,11 +56,9 @@ public final class MessagingIncubatingAttributes { * *

                Notes: * - *

                  - *
                • Destination name SHOULD uniquely identify a specific queue, topic or other entity within - * the broker. If the broker doesn't have such notion, the destination name SHOULD uniquely - * identify the broker. - *
                + *

                Destination name SHOULD uniquely identify a specific queue, topic or other entity within the + * broker. If the broker doesn't have such notion, the destination name SHOULD uniquely identify + * the broker. */ public static final AttributeKey MESSAGING_DESTINATION_NAME = stringKey("messaging.destination.name"); @@ -84,11 +75,9 @@ public final class MessagingIncubatingAttributes { * *

                Notes: * - *

                  - *
                • Semantic conventions for individual messaging systems SHOULD document whether {@code - * messaging.destination.subscription.name} is applicable and what it means in the context - * of that system. - *
                + *

                Semantic conventions for individual messaging systems SHOULD document whether {@code + * messaging.destination.subscription.name} is applicable and what it means in the context of that + * system. */ public static final AttributeKey MESSAGING_DESTINATION_SUBSCRIPTION_NAME = stringKey("messaging.destination.subscription.name"); @@ -98,12 +87,10 @@ public final class MessagingIncubatingAttributes { * *

                Notes: * - *

                  - *
                • Destination names could be constructed from templates. An example would be a destination - * name involving a user name or product id. Although the destination name in this case is - * of high cardinality, the underlying template is of low cardinality and can be effectively - * used for grouping and aggregation. - *
                + *

                Destination names could be constructed from templates. An example would be a destination + * name involving a user name or product id. Although the destination name in this case is of high + * cardinality, the underlying template is of low cardinality and can be effectively used for + * grouping and aggregation. */ public static final AttributeKey MESSAGING_DESTINATION_TEMPLATE = stringKey("messaging.destination.template"); @@ -118,7 +105,9 @@ public final class MessagingIncubatingAttributes { /** * Deprecated, no replacement at this time. * - * @deprecated Deprecated, no replacement at this time. + *

                + * + * @deprecated No replacement at this time. */ @Deprecated public static final AttributeKey MESSAGING_DESTINATION_PUBLISH_ANONYMOUS = @@ -127,7 +116,9 @@ public final class MessagingIncubatingAttributes { /** * Deprecated, no replacement at this time. * - * @deprecated Deprecated, no replacement at this time. + *

                + * + * @deprecated No replacement at this time. */ @Deprecated public static final AttributeKey MESSAGING_DESTINATION_PUBLISH_NAME = @@ -136,7 +127,9 @@ public final class MessagingIncubatingAttributes { /** * Deprecated, use {@code messaging.consumer.group.name} instead. * - * @deprecated Deprecated, use `messaging.consumer.group.name` instead. + *

                + * + * @deprecated Replaced by {@code messaging.consumer.group.name}. */ @Deprecated public static final AttributeKey MESSAGING_EVENTHUBS_CONSUMER_GROUP = @@ -168,7 +161,9 @@ public final class MessagingIncubatingAttributes { /** * Deprecated, use {@code messaging.consumer.group.name} instead. * - * @deprecated Deprecated, use `messaging.consumer.group.name` instead. + *

                + * + * @deprecated Replaced by {@code messaging.consumer.group.name}. */ @Deprecated public static final AttributeKey MESSAGING_KAFKA_CONSUMER_GROUP = @@ -177,7 +172,9 @@ public final class MessagingIncubatingAttributes { /** * Deprecated, use {@code messaging.destination.partition.id} instead. * - * @deprecated Deprecated, use `messaging.destination.partition.id` instead. + *

                + * + * @deprecated Replaced by {@code messaging.destination.partition.id}. */ @Deprecated public static final AttributeKey MESSAGING_KAFKA_DESTINATION_PARTITION = @@ -190,10 +187,8 @@ public final class MessagingIncubatingAttributes { * *

                Notes: * - *

                  - *
                • If the key type is not string, it's string representation has to be supplied for the - * attribute. If the key has no unambiguous, canonical string form, don't include its value. - *
                + *

                If the key type is not string, it's string representation has to be supplied for the + * attribute. If the key has no unambiguous, canonical string form, don't include its value. */ public static final AttributeKey MESSAGING_KAFKA_MESSAGE_KEY = stringKey("messaging.kafka.message.key"); @@ -201,7 +196,9 @@ public final class MessagingIncubatingAttributes { /** * Deprecated, use {@code messaging.kafka.offset} instead. * - * @deprecated Deprecated, use `messaging.kafka.offset` instead. + *

                + * + * @deprecated Replaced by {@code messaging.kafka.offset}. */ @Deprecated public static final AttributeKey MESSAGING_KAFKA_MESSAGE_OFFSET = @@ -219,17 +216,15 @@ public final class MessagingIncubatingAttributes { * *

                Notes: * - *

                  - *
                • This can refer to both the compressed or uncompressed body size. If both sizes are known, - * the uncompressed body size should be used. - *
                + *

                This can refer to both the compressed or uncompressed body size. If both sizes are known, + * the uncompressed body size should be used. */ public static final AttributeKey MESSAGING_MESSAGE_BODY_SIZE = longKey("messaging.message.body.size"); /** * The conversation ID identifying the conversation to which the message belongs, represented as a - * string. Sometimes called "Correlation ID". + * string. Sometimes called "Correlation ID". */ public static final AttributeKey MESSAGING_MESSAGE_CONVERSATION_ID = stringKey("messaging.message.conversation_id"); @@ -239,10 +234,8 @@ public final class MessagingIncubatingAttributes { * *

                Notes: * - *

                  - *
                • This can refer to both the compressed or uncompressed size. If both sizes are known, the - * uncompressed size should be used. - *
                + *

                This can refer to both the compressed or uncompressed size. If both sizes are known, the + * uncompressed size should be used. */ public static final AttributeKey MESSAGING_MESSAGE_ENVELOPE_SIZE = longKey("messaging.message.envelope.size"); @@ -255,7 +248,9 @@ public final class MessagingIncubatingAttributes { /** * Deprecated, use {@code messaging.operation.type} instead. * - * @deprecated Deprecated, use `messaging.operation.type` instead. + *

                + * + * @deprecated Replaced by {@code messaging.operation.type}. */ @Deprecated public static final AttributeKey MESSAGING_OPERATION = stringKey("messaging.operation"); @@ -269,9 +264,7 @@ public final class MessagingIncubatingAttributes { * *

                Notes: * - *

                  - *
                • If a custom value is used, it MUST be of low cardinality. - *
                + *

                If a custom value is used, it MUST be of low cardinality. */ public static final AttributeKey MESSAGING_OPERATION_TYPE = stringKey("messaging.operation.type"); @@ -287,7 +280,10 @@ public final class MessagingIncubatingAttributes { /** * Deprecated, use {@code messaging.consumer.group.name} instead. * - * @deprecated Deprecated, use `messaging.consumer.group.name` instead. + *

                + * + * @deprecated Replaced by {@code messaging.consumer.group.name} on the consumer spans. No + * replacement for producer spans. */ @Deprecated public static final AttributeKey MESSAGING_ROCKETMQ_CLIENT_GROUP = @@ -333,7 +329,9 @@ public final class MessagingIncubatingAttributes { /** * Deprecated, use {@code messaging.servicebus.destination.subscription_name} instead. * - * @deprecated Deprecated, use `messaging.servicebus.destination.subscription_name` instead. + *

                + * + * @deprecated Replaced by {@code messaging.servicebus.destination.subscription_name}. */ @Deprecated public static final AttributeKey MESSAGING_SERVICEBUS_DESTINATION_SUBSCRIPTION_NAME = @@ -360,11 +358,9 @@ public final class MessagingIncubatingAttributes { * *

                Notes: * - *

                  - *
                • The actual messaging system may differ from the one known by the client. For example, - * when using Kafka client libraries to communicate with Azure Event Hubs, the {@code - * messaging.system} is set to {@code kafka} based on the instrumentation's best knowledge. - *
                + *

                The actual messaging system may differ from the one known by the client. For example, when + * using Kafka client libraries to communicate with Azure Event Hubs, the {@code messaging.system} + * is set to {@code kafka} based on the instrumentation's best knowledge. */ public static final AttributeKey MESSAGING_SYSTEM = stringKey("messaging.system"); @@ -373,14 +369,14 @@ public final class MessagingIncubatingAttributes { public static final class MessagingOperationTypeValues { /** * One or more messages are provided for publishing to an intermediary. If a single message is - * published, the context of the "Publish" span can be used as the creation context and - * no "Create" span needs to be created. + * published, the context of the "Publish" span can be used as the creation context and no + * "Create" span needs to be created. */ public static final String PUBLISH = "publish"; /** - * A message is created. "Create" spans always refer to a single message and are used to - * provide a unique creation context for messages in batch publishing scenarios. + * A message is created. "Create" spans always refer to a single message and are used to provide + * a unique creation context for messages in batch publishing scenarios. */ public static final String CREATE = "create"; @@ -396,7 +392,7 @@ public static final class MessagingOperationTypeValues { /** One or more messages are settled. */ public static final String SETTLE = "settle"; - /** Deprecated. Use `process` instead. */ + /** Deprecated. Use {@code process} instead. */ public static final String DELIVER = "deliver"; private MessagingOperationTypeValues() {} @@ -404,10 +400,10 @@ private MessagingOperationTypeValues() {} /** Values for {@link #MESSAGING_ROCKETMQ_CONSUMPTION_MODEL}. */ public static final class MessagingRocketmqConsumptionModelValues { - /** Clustering consumption model. */ + /** Clustering consumption model */ public static final String CLUSTERING = "clustering"; - /** Broadcasting consumption model. */ + /** Broadcasting consumption model */ public static final String BROADCASTING = "broadcasting"; private MessagingRocketmqConsumptionModelValues() {} @@ -415,16 +411,16 @@ private MessagingRocketmqConsumptionModelValues() {} /** Values for {@link #MESSAGING_ROCKETMQ_MESSAGE_TYPE}. */ public static final class MessagingRocketmqMessageTypeValues { - /** Normal message. */ + /** Normal message */ public static final String NORMAL = "normal"; - /** FIFO message. */ + /** FIFO message */ public static final String FIFO = "fifo"; - /** Delay message. */ + /** Delay message */ public static final String DELAY = "delay"; - /** Transaction message. */ + /** Transaction message */ public static final String TRANSACTION = "transaction"; private MessagingRocketmqMessageTypeValues() {} @@ -432,16 +428,16 @@ private MessagingRocketmqMessageTypeValues() {} /** Values for {@link #MESSAGING_SERVICEBUS_DISPOSITION_STATUS}. */ public static final class MessagingServicebusDispositionStatusValues { - /** Message is completed. */ + /** Message is completed */ public static final String COMPLETE = "complete"; - /** Message is abandoned. */ + /** Message is abandoned */ public static final String ABANDON = "abandon"; - /** Message is sent to dead letter queue. */ + /** Message is sent to dead letter queue */ public static final String DEAD_LETTER = "dead_letter"; - /** Message is deferred. */ + /** Message is deferred */ public static final String DEFER = "defer"; private MessagingServicebusDispositionStatusValues() {} @@ -449,37 +445,37 @@ private MessagingServicebusDispositionStatusValues() {} /** Values for {@link #MESSAGING_SYSTEM}. */ public static final class MessagingSystemValues { - /** Apache ActiveMQ. */ + /** Apache ActiveMQ */ public static final String ACTIVEMQ = "activemq"; - /** Amazon Simple Queue Service (SQS). */ + /** Amazon Simple Queue Service (SQS) */ public static final String AWS_SQS = "aws_sqs"; - /** Azure Event Grid. */ + /** Azure Event Grid */ public static final String EVENTGRID = "eventgrid"; - /** Azure Event Hubs. */ + /** Azure Event Hubs */ public static final String EVENTHUBS = "eventhubs"; - /** Azure Service Bus. */ + /** Azure Service Bus */ public static final String SERVICEBUS = "servicebus"; - /** Google Cloud Pub/Sub. */ + /** Google Cloud Pub/Sub */ public static final String GCP_PUBSUB = "gcp_pubsub"; - /** Java Message Service. */ + /** Java Message Service */ public static final String JMS = "jms"; - /** Apache Kafka. */ + /** Apache Kafka */ public static final String KAFKA = "kafka"; - /** RabbitMQ. */ + /** RabbitMQ */ public static final String RABBITMQ = "rabbitmq"; - /** Apache RocketMQ. */ + /** Apache RocketMQ */ public static final String ROCKETMQ = "rocketmq"; - /** Apache Pulsar. */ + /** Apache Pulsar */ public static final String PULSAR = "pulsar"; private MessagingSystemValues() {} diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/NetIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/NetIncubatingAttributes.java index a257ef5..bb587e7 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/NetIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/NetIncubatingAttributes.java @@ -11,35 +11,42 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class NetIncubatingAttributes { - /** * Deprecated, use {@code network.local.address}. * - * @deprecated Deprecated, use `network.local.address`. + *

                + * + * @deprecated Replaced by {@code network.local.address}. */ @Deprecated public static final AttributeKey NET_HOST_IP = stringKey("net.host.ip"); /** * Deprecated, use {@code server.address}. * - * @deprecated Deprecated, use `server.address`. + *

                + * + * @deprecated Replaced by {@code server.address}. */ @Deprecated public static final AttributeKey NET_HOST_NAME = stringKey("net.host.name"); /** * Deprecated, use {@code server.port}. * - * @deprecated Deprecated, use `server.port`. + *

                + * + * @deprecated Replaced by {@code server.port}. */ @Deprecated public static final AttributeKey NET_HOST_PORT = longKey("net.host.port"); /** * Deprecated, use {@code network.peer.address}. * - * @deprecated Deprecated, use `network.peer.address`. + *

                + * + * @deprecated Replaced by {@code network.peer.address}. */ @Deprecated public static final AttributeKey NET_PEER_IP = stringKey("net.peer.ip"); @@ -47,22 +54,29 @@ public final class NetIncubatingAttributes { * Deprecated, use {@code server.address} on client spans and {@code client.address} on server * spans. * - * @deprecated Deprecated, use `server.address` on client spans and `client.address` on server - * spans. + *

                + * + * @deprecated Replaced by {@code server.address} on client spans and {@code client.address} on + * server spans. */ @Deprecated public static final AttributeKey NET_PEER_NAME = stringKey("net.peer.name"); /** * Deprecated, use {@code server.port} on client spans and {@code client.port} on server spans. * - * @deprecated Deprecated, use `server.port` on client spans and `client.port` on server spans. + *

                + * + * @deprecated Replaced by {@code server.port} on client spans and {@code client.port} on server + * spans. */ @Deprecated public static final AttributeKey NET_PEER_PORT = longKey("net.peer.port"); /** * Deprecated, use {@code network.protocol.name}. * - * @deprecated Deprecated, use `network.protocol.name`. + *

                + * + * @deprecated Replaced by {@code network.protocol.name}. */ @Deprecated public static final AttributeKey NET_PROTOCOL_NAME = stringKey("net.protocol.name"); @@ -70,7 +84,9 @@ public final class NetIncubatingAttributes { /** * Deprecated, use {@code network.protocol.version}. * - * @deprecated Deprecated, use `network.protocol.version`. + *

                + * + * @deprecated Replaced by {@code network.protocol.version}. */ @Deprecated public static final AttributeKey NET_PROTOCOL_VERSION = stringKey("net.protocol.version"); @@ -78,7 +94,9 @@ public final class NetIncubatingAttributes { /** * Deprecated, use {@code network.transport} and {@code network.type}. * - * @deprecated Deprecated, use `network.transport` and `network.type`. + *

                + * + * @deprecated Split to {@code network.transport} and {@code network.type}. */ @Deprecated public static final AttributeKey NET_SOCK_FAMILY = stringKey("net.sock.family"); @@ -86,7 +104,9 @@ public final class NetIncubatingAttributes { /** * Deprecated, use {@code network.local.address}. * - * @deprecated Deprecated, use `network.local.address`. + *

                + * + * @deprecated Replaced by {@code network.local.address}. */ @Deprecated public static final AttributeKey NET_SOCK_HOST_ADDR = stringKey("net.sock.host.addr"); @@ -94,7 +114,9 @@ public final class NetIncubatingAttributes { /** * Deprecated, use {@code network.local.port}. * - * @deprecated Deprecated, use `network.local.port`. + *

                + * + * @deprecated Replaced by {@code network.local.port}. */ @Deprecated public static final AttributeKey NET_SOCK_HOST_PORT = longKey("net.sock.host.port"); @@ -102,7 +124,9 @@ public final class NetIncubatingAttributes { /** * Deprecated, use {@code network.peer.address}. * - * @deprecated Deprecated, use `network.peer.address`. + *

                + * + * @deprecated Replaced by {@code network.peer.address}. */ @Deprecated public static final AttributeKey NET_SOCK_PEER_ADDR = stringKey("net.sock.peer.addr"); @@ -110,7 +134,9 @@ public final class NetIncubatingAttributes { /** * Deprecated, no replacement at this time. * - * @deprecated Deprecated, no replacement at this time. + *

                + * + * @deprecated Removed. */ @Deprecated public static final AttributeKey NET_SOCK_PEER_NAME = stringKey("net.sock.peer.name"); @@ -118,7 +144,9 @@ public final class NetIncubatingAttributes { /** * Deprecated, use {@code network.peer.port}. * - * @deprecated Deprecated, use `network.peer.port`. + *

                + * + * @deprecated Replaced by {@code network.peer.port}. */ @Deprecated public static final AttributeKey NET_SOCK_PEER_PORT = longKey("net.sock.peer.port"); @@ -126,34 +154,36 @@ public final class NetIncubatingAttributes { /** * Deprecated, use {@code network.transport}. * - * @deprecated Deprecated, use `network.transport`. + *

                + * + * @deprecated Replaced by {@code network.transport}. */ @Deprecated public static final AttributeKey NET_TRANSPORT = stringKey("net.transport"); // Enum definitions /** - * Values for {@link #NET_SOCK_FAMILY}. + * Values for {@link #NET_SOCK_FAMILY} * - * @deprecated Deprecated, use `network.transport` and `network.type`. + * @deprecated Split to {@code network.transport} and {@code network.type}. */ @Deprecated public static final class NetSockFamilyValues { - /** IPv4 address. */ + /** IPv4 address */ public static final String INET = "inet"; - /** IPv6 address. */ + /** IPv6 address */ public static final String INET6 = "inet6"; - /** Unix domain socket path. */ + /** Unix domain socket path */ public static final String UNIX = "unix"; private NetSockFamilyValues() {} } /** - * Values for {@link #NET_TRANSPORT}. + * Values for {@link #NET_TRANSPORT} * - * @deprecated Deprecated, use `network.transport`. + * @deprecated Replaced by {@code network.transport}. */ @Deprecated public static final class NetTransportValues { diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/NetworkIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/NetworkIncubatingAttributes.java index 094b19d..b0781d1 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/NetworkIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/NetworkIncubatingAttributes.java @@ -11,10 +11,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class NetworkIncubatingAttributes { - /** The ISO 3166-1 alpha-2 2-character country code associated with the mobile carrier network. */ public static final AttributeKey NETWORK_CARRIER_ICC = stringKey("network.carrier.icc"); @@ -44,6 +43,8 @@ public final class NetworkIncubatingAttributes { /** * Local address of the network connection - IP address or Unix domain socket name. * + *

                + * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.NetworkAttributes#NETWORK_LOCAL_ADDRESS} attribute. */ @@ -54,6 +55,8 @@ public final class NetworkIncubatingAttributes { /** * Local port number of the network connection. * + *

                + * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.NetworkAttributes#NETWORK_LOCAL_PORT} attribute. */ @@ -63,6 +66,8 @@ public final class NetworkIncubatingAttributes { /** * Peer address of the network connection - IP address or Unix domain socket name. * + *

                + * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.NetworkAttributes#NETWORK_PEER_ADDRESS} attribute. */ @@ -72,6 +77,8 @@ public final class NetworkIncubatingAttributes { /** * Peer port number of the network connection. * + *

                + * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.NetworkAttributes#NETWORK_PEER_PORT} attribute. */ @@ -84,9 +91,7 @@ public final class NetworkIncubatingAttributes { * *

                Notes: * - *

                  - *
                • The value SHOULD be normalized to lowercase. - *
                + *

                The value SHOULD be normalized to lowercase. * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.NetworkAttributes#NETWORK_PROTOCOL_NAME} attribute. @@ -100,12 +105,12 @@ public final class NetworkIncubatingAttributes { * *

                Notes: * - *

                  - *
                • If protocol version is subject to negotiation (for example using ALPN), this attribute SHOULD be - * set to the negotiated version. If the actual protocol version is not known, this - * attribute SHOULD NOT be set. - *
                + *

                If protocol version is subject to negotiation (for example using ALPN), this attribute SHOULD be set to + * the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT + * be set. + * + *

                * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.NetworkAttributes#NETWORK_PROTOCOL_VERSION} attribute. @@ -121,12 +126,13 @@ public final class NetworkIncubatingAttributes { * *

                Notes: * - *

                  - *
                • The value SHOULD be normalized to lowercase. - *
                • Consider always setting the transport when setting a port number, since a port number is - * ambiguous without knowing the transport. For example different processes could be - * listening on TCP port 12345 and UDP port 12345. - *
                + *

                The value SHOULD be normalized to lowercase. + * + *

                Consider always setting the transport when setting a port number, since a port number is + * ambiguous without knowing the transport. For example different processes could be listening on + * TCP port 12345 and UDP port 12345. + * + *

                * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.NetworkAttributes#NETWORK_TRANSPORT} attribute. @@ -139,9 +145,7 @@ public final class NetworkIncubatingAttributes { * *

                Notes: * - *

                  - *
                • The value SHOULD be normalized to lowercase. - *
                + *

                The value SHOULD be normalized to lowercase. * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.NetworkAttributes#NETWORK_TYPE} attribute. @@ -151,67 +155,67 @@ public final class NetworkIncubatingAttributes { // Enum definitions /** Values for {@link #NETWORK_CONNECTION_SUBTYPE}. */ public static final class NetworkConnectionSubtypeValues { - /** GPRS. */ + /** GPRS */ public static final String GPRS = "gprs"; - /** EDGE. */ + /** EDGE */ public static final String EDGE = "edge"; - /** UMTS. */ + /** UMTS */ public static final String UMTS = "umts"; - /** CDMA. */ + /** CDMA */ public static final String CDMA = "cdma"; - /** EVDO Rel. 0. */ + /** EVDO Rel. 0 */ public static final String EVDO_0 = "evdo_0"; - /** EVDO Rev. A. */ + /** EVDO Rev. A */ public static final String EVDO_A = "evdo_a"; - /** CDMA2000 1XRTT. */ + /** CDMA2000 1XRTT */ public static final String CDMA2000_1XRTT = "cdma2000_1xrtt"; - /** HSDPA. */ + /** HSDPA */ public static final String HSDPA = "hsdpa"; - /** HSUPA. */ + /** HSUPA */ public static final String HSUPA = "hsupa"; - /** HSPA. */ + /** HSPA */ public static final String HSPA = "hspa"; - /** IDEN. */ + /** IDEN */ public static final String IDEN = "iden"; - /** EVDO Rev. B. */ + /** EVDO Rev. B */ public static final String EVDO_B = "evdo_b"; - /** LTE. */ + /** LTE */ public static final String LTE = "lte"; - /** EHRPD. */ + /** EHRPD */ public static final String EHRPD = "ehrpd"; - /** HSPAP. */ + /** HSPAP */ public static final String HSPAP = "hspap"; - /** GSM. */ + /** GSM */ public static final String GSM = "gsm"; - /** TD-SCDMA. */ + /** TD-SCDMA */ public static final String TD_SCDMA = "td_scdma"; - /** IWLAN. */ + /** IWLAN */ public static final String IWLAN = "iwlan"; - /** 5G NR (New Radio). */ + /** 5G NR (New Radio) */ public static final String NR = "nr"; - /** 5G NRNSA (New Radio Non-Standalone). */ + /** 5G NRNSA (New Radio Non-Standalone) */ public static final String NRNSA = "nrnsa"; - /** LTE CA. */ + /** LTE CA */ public static final String LTE_CA = "lte_ca"; private NetworkConnectionSubtypeValues() {} @@ -252,23 +256,23 @@ private NetworkIoDirectionValues() {} * Values for {@link #NETWORK_TRANSPORT}. * * @deprecated deprecated in favor of stable {@link - * io.opentelemetry.semconv.NetworkAttributes.NetworkTransportValues} attribute. + * io.opentelemetry.semconv.NetworkAttributes.NetworkTransportValues}. */ @Deprecated public static final class NetworkTransportValues { - /** TCP. */ + /** TCP */ public static final String TCP = "tcp"; - /** UDP. */ + /** UDP */ public static final String UDP = "udp"; /** Named or anonymous pipe. */ public static final String PIPE = "pipe"; - /** Unix domain socket. */ + /** Unix domain socket */ public static final String UNIX = "unix"; - /** QUIC. */ + /** QUIC */ public static final String QUIC = "quic"; private NetworkTransportValues() {} @@ -278,14 +282,14 @@ private NetworkTransportValues() {} * Values for {@link #NETWORK_TYPE}. * * @deprecated deprecated in favor of stable {@link - * io.opentelemetry.semconv.NetworkAttributes.NetworkTypeValues} attribute. + * io.opentelemetry.semconv.NetworkAttributes.NetworkTypeValues}. */ @Deprecated public static final class NetworkTypeValues { - /** IPv4. */ + /** IPv4 */ public static final String IPV4 = "ipv4"; - /** IPv6. */ + /** IPv6 */ public static final String IPV6 = "ipv6"; private NetworkTypeValues() {} diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/OciIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/OciIncubatingAttributes.java index fe7e320..5c3f09c 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/OciIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/OciIncubatingAttributes.java @@ -10,26 +10,25 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class OciIncubatingAttributes { - /** * The digest of the OCI image manifest. For container images specifically is the digest by which * the container image is known. * *

                Notes: * - *

                + *

                Follows OCI + * Image Manifest Specification, and specifically the Digest + * property. An example can be found in Example + * Image Manifest. */ public static final AttributeKey OCI_MANIFEST_DIGEST = stringKey("oci.manifest.digest"); + // Enum definitions + private OciIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/OpentracingIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/OpentracingIncubatingAttributes.java index 194e1ea..d44ed1a 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/OpentracingIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/OpentracingIncubatingAttributes.java @@ -10,28 +10,25 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class OpentracingIncubatingAttributes { - /** * Parent-child Reference type * *

                Notes: * - *

                  - *
                • The causal relationship between a child Span and a parent Span. - *
                + *

                The causal relationship between a child Span and a parent Span. */ public static final AttributeKey OPENTRACING_REF_TYPE = stringKey("opentracing.ref_type"); // Enum definitions /** Values for {@link #OPENTRACING_REF_TYPE}. */ public static final class OpentracingRefTypeValues { - /** The parent Span depends on the child Span in some capacity. */ + /** The parent Span depends on the child Span in some capacity */ public static final String CHILD_OF = "child_of"; - /** The parent Span doesn't depend in any way on the result of the child Span. */ + /** The parent Span doesn't depend in any way on the result of the child Span */ public static final String FOLLOWS_FROM = "follows_from"; private OpentracingRefTypeValues() {} diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/OsIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/OsIncubatingAttributes.java index e19e088..498904f 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/OsIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/OsIncubatingAttributes.java @@ -10,10 +10,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class OsIncubatingAttributes { - /** Unique identifier for a particular build or compilation of the operating system. */ public static final AttributeKey OS_BUILD_ID = stringKey("os.build_id"); @@ -38,37 +37,37 @@ public final class OsIncubatingAttributes { // Enum definitions /** Values for {@link #OS_TYPE}. */ public static final class OsTypeValues { - /** Microsoft Windows. */ + /** Microsoft Windows */ public static final String WINDOWS = "windows"; - /** Linux. */ + /** Linux */ public static final String LINUX = "linux"; - /** Apple Darwin. */ + /** Apple Darwin */ public static final String DARWIN = "darwin"; - /** FreeBSD. */ + /** FreeBSD */ public static final String FREEBSD = "freebsd"; - /** NetBSD. */ + /** NetBSD */ public static final String NETBSD = "netbsd"; - /** OpenBSD. */ + /** OpenBSD */ public static final String OPENBSD = "openbsd"; - /** DragonFly BSD. */ + /** DragonFly BSD */ public static final String DRAGONFLYBSD = "dragonflybsd"; - /** HP-UX (Hewlett Packard Unix). */ + /** HP-UX (Hewlett Packard Unix) */ public static final String HPUX = "hpux"; - /** AIX (Advanced Interactive eXecutive). */ + /** AIX (Advanced Interactive eXecutive) */ public static final String AIX = "aix"; - /** SunOS, Oracle Solaris. */ + /** SunOS, Oracle Solaris */ public static final String SOLARIS = "solaris"; - /** IBM z/OS. */ + /** IBM z/OS */ public static final String Z_OS = "z_os"; private OsTypeValues() {} diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/OtelIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/OtelIncubatingAttributes.java index bd1e999..89e422f 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/OtelIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/OtelIncubatingAttributes.java @@ -10,18 +10,17 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class OtelIncubatingAttributes { - /** - * @deprecated . + * @deprecated use the {@code otel.scope.name} attribute. */ @Deprecated public static final AttributeKey OTEL_LIBRARY_NAME = stringKey("otel.library.name"); /** - * @deprecated . + * @deprecated use the {@code otel.scope.version} attribute. */ @Deprecated public static final AttributeKey OTEL_LIBRARY_VERSION = stringKey("otel.library.version"); @@ -29,6 +28,8 @@ public final class OtelIncubatingAttributes { /** * The name of the instrumentation scope - ({@code InstrumentationScope.Name} in OTLP). * + *

                + * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.OtelAttributes#OTEL_SCOPE_NAME} attribute. */ @@ -38,6 +39,8 @@ public final class OtelIncubatingAttributes { /** * The version of the instrumentation scope - ({@code InstrumentationScope.Version} in OTLP). * + *

                + * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.OtelAttributes#OTEL_SCOPE_VERSION} attribute. */ @@ -45,8 +48,9 @@ public final class OtelIncubatingAttributes { public static final AttributeKey OTEL_SCOPE_VERSION = stringKey("otel.scope.version"); /** - * Name of the code, either "OK" or "ERROR". MUST NOT be set if the status - * code is UNSET. + * Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET. + * + *

                * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.OtelAttributes#OTEL_STATUS_CODE} attribute. @@ -57,6 +61,8 @@ public final class OtelIncubatingAttributes { /** * Description of the Status if it has a value, otherwise not set. * + *

                + * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.OtelAttributes#OTEL_STATUS_DESCRIPTION} attribute. */ @@ -69,7 +75,7 @@ public final class OtelIncubatingAttributes { * Values for {@link #OTEL_STATUS_CODE}. * * @deprecated deprecated in favor of stable {@link - * io.opentelemetry.semconv.OtelAttributes.OtelStatusCodeValues} attribute. + * io.opentelemetry.semconv.OtelAttributes.OtelStatusCodeValues}. */ @Deprecated public static final class OtelStatusCodeValues { diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/OtherIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/OtherIncubatingAttributes.java index 4634dca..2b93dc0 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/OtherIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/OtherIncubatingAttributes.java @@ -10,22 +10,23 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class OtherIncubatingAttributes { - /** * Deprecated, use {@code db.client.connection.state} instead. * - * @deprecated Deprecated, use `db.client.connection.state` instead. + *

                + * + * @deprecated Replaced by {@code db.client.connection.state}. */ @Deprecated public static final AttributeKey STATE = stringKey("state"); // Enum definitions /** - * Values for {@link #STATE}. + * Values for {@link #STATE} * - * @deprecated Deprecated, use `db.client.connection.state` instead. + * @deprecated Replaced by {@code db.client.connection.state}. */ @Deprecated public static final class StateValues { diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/PeerIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/PeerIncubatingAttributes.java index 785c454..34176a7 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/PeerIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/PeerIncubatingAttributes.java @@ -10,10 +10,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class PeerIncubatingAttributes { - /** * The {@code service.name} of the remote service. * SHOULD be equal to the actual {@code service.name} resource attribute of the remote service if @@ -21,5 +20,7 @@ public final class PeerIncubatingAttributes { */ public static final AttributeKey PEER_SERVICE = stringKey("peer.service"); + // Enum definitions + private PeerIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/PoolIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/PoolIncubatingAttributes.java index ae9c17a..c429114 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/PoolIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/PoolIncubatingAttributes.java @@ -10,16 +10,19 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class PoolIncubatingAttributes { - /** * Deprecated, use {@code db.client.connection.pool.name} instead. * - * @deprecated Deprecated, use `db.client.connection.pool.name` instead. + *

                + * + * @deprecated Replaced by {@code db.client.connection.pool.name}. */ @Deprecated public static final AttributeKey POOL_NAME = stringKey("pool.name"); + // Enum definitions + private PoolIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ProcessIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ProcessIncubatingAttributes.java index ffb0734..fc8312a 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ProcessIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ProcessIncubatingAttributes.java @@ -14,10 +14,9 @@ import java.util.List; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class ProcessIncubatingAttributes { - /** * The command used to launch the process (i.e. the command name). On Linux based systems, can be * set to the zeroth string in {@code proc/[pid]/cmdline}. On Windows, can be set to the first @@ -48,7 +47,9 @@ public final class ProcessIncubatingAttributes { /** * Deprecated, use {@code cpu.mode} instead. * - * @deprecated Deprecated, use `cpu.mode` instead. + *

                + * + * @deprecated Replaced by {@code cpu.mode} */ @Deprecated public static final AttributeKey PROCESS_CPU_STATE = stringKey("process.cpu.state"); @@ -149,11 +150,8 @@ public final class ProcessIncubatingAttributes { * *

                Notes: * - *

                  - *
                • The process ID within a PID namespace. This is not necessarily unique across all - * processes on the host but it is unique within the process namespace that the process - * exists within. - *
                + *

                The process ID within a PID namespace. This is not necessarily unique across all processes + * on the host but it is unique within the process namespace that the process exists within. */ public static final AttributeKey PROCESS_VPID = longKey("process.vpid"); @@ -170,9 +168,9 @@ private ProcessContextSwitchTypeValues() {} } /** - * Values for {@link #PROCESS_CPU_STATE}. + * Values for {@link #PROCESS_CPU_STATE} * - * @deprecated Deprecated, use `cpu.mode` instead. + * @deprecated Replaced by {@code cpu.mode} */ @Deprecated public static final class ProcessCpuStateValues { diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/RpcIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/RpcIncubatingAttributes.java index baad365..5e6bc84 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/RpcIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/RpcIncubatingAttributes.java @@ -14,10 +14,9 @@ import java.util.List; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class RpcIncubatingAttributes { - /** * The error codes of the Connect * request. Error codes are always string values. @@ -31,11 +30,9 @@ public final class RpcIncubatingAttributes { * *

                Notes: * - *

                  - *
                • Instrumentations SHOULD require an explicit configuration of which metadata values are to - * be captured. Including all request metadata values can be a security risk - explicit - * configuration helps avoid leaking sensitive information. - *
                + *

                Instrumentations SHOULD require an explicit configuration of which metadata values are to be + * captured. Including all request metadata values can be a security risk - explicit configuration + * helps avoid leaking sensitive information. */ public static final AttributeKeyTemplate> RPC_CONNECT_RPC_REQUEST_METADATA = stringArrayKeyTemplate("rpc.connect_rpc.request.metadata"); @@ -46,11 +43,9 @@ public final class RpcIncubatingAttributes { * *

                Notes: * - *

                  - *
                • Instrumentations SHOULD require an explicit configuration of which metadata values are to - * be captured. Including all response metadata values can be a security risk - explicit - * configuration helps avoid leaking sensitive information. - *
                + *

                Instrumentations SHOULD require an explicit configuration of which metadata values are to be + * captured. Including all response metadata values can be a security risk - explicit + * configuration helps avoid leaking sensitive information. */ public static final AttributeKeyTemplate> RPC_CONNECT_RPC_RESPONSE_METADATA = stringArrayKeyTemplate("rpc.connect_rpc.response.metadata"); @@ -61,11 +56,9 @@ public final class RpcIncubatingAttributes { * *

                Notes: * - *

                  - *
                • Instrumentations SHOULD require an explicit configuration of which metadata values are to - * be captured. Including all request metadata values can be a security risk - explicit - * configuration helps avoid leaking sensitive information. - *
                + *

                Instrumentations SHOULD require an explicit configuration of which metadata values are to be + * captured. Including all request metadata values can be a security risk - explicit configuration + * helps avoid leaking sensitive information. */ public static final AttributeKeyTemplate> RPC_GRPC_REQUEST_METADATA = stringArrayKeyTemplate("rpc.grpc.request.metadata"); @@ -76,11 +69,9 @@ public final class RpcIncubatingAttributes { * *

                Notes: * - *

                  - *
                • Instrumentations SHOULD require an explicit configuration of which metadata values are to - * be captured. Including all response metadata values can be a security risk - explicit - * configuration helps avoid leaking sensitive information. - *
                + *

                Instrumentations SHOULD require an explicit configuration of which metadata values are to be + * captured. Including all response metadata values can be a security risk - explicit + * configuration helps avoid leaking sensitive information. */ public static final AttributeKeyTemplate> RPC_GRPC_RESPONSE_METADATA = stringArrayKeyTemplate("rpc.grpc.response.metadata"); @@ -122,10 +113,7 @@ public final class RpcIncubatingAttributes { * *

                Notes: * - *

                  - *
                • This way we guarantee that the values will be consistent between different - * implementations. - *
                + *

                This way we guarantee that the values will be consistent between different implementations. */ public static final AttributeKey RPC_MESSAGE_ID = longKey("rpc.message.id"); @@ -142,12 +130,10 @@ public final class RpcIncubatingAttributes { * *

                Notes: * - *

                  - *
                • This is the logical name of the method from the RPC interface perspective, which can be - * different from the name of any implementing method/function. The {@code code.function} - * attribute may be used to store the latter (e.g., method actually executing the call on - * the server side, RPC client stub method on the client side). - *
                + *

                This is the logical name of the method from the RPC interface perspective, which can be + * different from the name of any implementing method/function. The {@code code.function} + * attribute may be used to store the latter (e.g., method actually executing the call on the + * server side, RPC client stub method on the client side). */ public static final AttributeKey RPC_METHOD = stringKey("rpc.method"); @@ -156,13 +142,11 @@ public final class RpcIncubatingAttributes { * *

                Notes: * - *

                  - *
                • This is the logical name of the service from the RPC interface perspective, which can be - * different from the name of any implementing class. The {@code code.namespace} attribute - * may be used to store the latter (despite the attribute name, it may include a class name; - * e.g., class with method actually executing the call on the server side, RPC client stub - * class on the client side). - *
                + *

                This is the logical name of the service from the RPC interface perspective, which can be + * different from the name of any implementing class. The {@code code.namespace} attribute may be + * used to store the latter (despite the attribute name, it may include a class name; e.g., class + * with method actually executing the call on the server side, RPC client stub class on the client + * side). */ public static final AttributeKey RPC_SERVICE = stringKey("rpc.service"); @@ -225,55 +209,55 @@ private RpcConnectRpcErrorCodeValues() {} /** Values for {@link #RPC_GRPC_STATUS_CODE}. */ public static final class RpcGrpcStatusCodeValues { - /** OK. */ + /** OK */ public static final long OK = 0; - /** CANCELLED. */ + /** CANCELLED */ public static final long CANCELLED = 1; - /** UNKNOWN. */ + /** UNKNOWN */ public static final long UNKNOWN = 2; - /** INVALID_ARGUMENT. */ + /** INVALID_ARGUMENT */ public static final long INVALID_ARGUMENT = 3; - /** DEADLINE_EXCEEDED. */ + /** DEADLINE_EXCEEDED */ public static final long DEADLINE_EXCEEDED = 4; - /** NOT_FOUND. */ + /** NOT_FOUND */ public static final long NOT_FOUND = 5; - /** ALREADY_EXISTS. */ + /** ALREADY_EXISTS */ public static final long ALREADY_EXISTS = 6; - /** PERMISSION_DENIED. */ + /** PERMISSION_DENIED */ public static final long PERMISSION_DENIED = 7; - /** RESOURCE_EXHAUSTED. */ + /** RESOURCE_EXHAUSTED */ public static final long RESOURCE_EXHAUSTED = 8; - /** FAILED_PRECONDITION. */ + /** FAILED_PRECONDITION */ public static final long FAILED_PRECONDITION = 9; - /** ABORTED. */ + /** ABORTED */ public static final long ABORTED = 10; - /** OUT_OF_RANGE. */ + /** OUT_OF_RANGE */ public static final long OUT_OF_RANGE = 11; - /** UNIMPLEMENTED. */ + /** UNIMPLEMENTED */ public static final long UNIMPLEMENTED = 12; - /** INTERNAL. */ + /** INTERNAL */ public static final long INTERNAL = 13; - /** UNAVAILABLE. */ + /** UNAVAILABLE */ public static final long UNAVAILABLE = 14; - /** DATA_LOSS. */ + /** DATA_LOSS */ public static final long DATA_LOSS = 15; - /** UNAUTHENTICATED. */ + /** UNAUTHENTICATED */ public static final long UNAUTHENTICATED = 16; private RpcGrpcStatusCodeValues() {} @@ -292,19 +276,19 @@ private RpcMessageTypeValues() {} /** Values for {@link #RPC_SYSTEM}. */ public static final class RpcSystemValues { - /** gRPC. */ + /** gRPC */ public static final String GRPC = "grpc"; - /** Java RMI. */ + /** Java RMI */ public static final String JAVA_RMI = "java_rmi"; - /** .NET WCF. */ + /** .NET WCF */ public static final String DOTNET_WCF = "dotnet_wcf"; - /** Apache Dubbo. */ + /** Apache Dubbo */ public static final String APACHE_DUBBO = "apache_dubbo"; - /** Connect RPC. */ + /** Connect RPC */ public static final String CONNECT_RPC = "connect_rpc"; private RpcSystemValues() {} diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ServerIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ServerIncubatingAttributes.java index 60f284b..bfb7eeb 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ServerIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ServerIncubatingAttributes.java @@ -11,21 +11,20 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class ServerIncubatingAttributes { - /** * Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix * domain socket name. * *

                Notes: * - *

                  - *
                • When observed from the client side, and when communicating through an intermediary, - * {@code server.address} SHOULD represent the server address behind any intermediaries, for - * example proxies, if it's available. - *
                + *

                When observed from the client side, and when communicating through an intermediary, {@code + * server.address} SHOULD represent the server address behind any intermediaries, for example + * proxies, if it's available. + * + *

                * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.ServerAttributes#SERVER_ADDRESS} attribute. @@ -37,16 +36,18 @@ public final class ServerIncubatingAttributes { * *

                Notes: * - *

                  - *
                • When observed from the client side, and when communicating through an intermediary, - * {@code server.port} SHOULD represent the server port behind any intermediaries, for - * example proxies, if it's available. - *
                + *

                When observed from the client side, and when communicating through an intermediary, {@code + * server.port} SHOULD represent the server port behind any intermediaries, for example proxies, + * if it's available. + * + *

                * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.ServerAttributes#SERVER_PORT} attribute. */ @Deprecated public static final AttributeKey SERVER_PORT = longKey("server.port"); + // Enum definitions + private ServerIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ServiceIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ServiceIncubatingAttributes.java index c15f0e2..26408fb 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ServiceIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ServiceIncubatingAttributes.java @@ -10,42 +10,43 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class ServiceIncubatingAttributes { - /** * The string ID of the service instance. * *

                Notes: * - *

                  - *
                • MUST be unique for each instance of the same {@code service.namespace,service.name} pair - * (in other words {@code service.namespace,service.name,service.instance.id} triplet MUST - * be globally unique). The ID helps to distinguish instances of the same service that exist - * at the same time (e.g. instances of a horizontally scaled service). - *
                • Implementations, such as SDKs, are recommended to generate a random Version 1 or Version - * 4 RFC 4122 UUID, but are free to use - * an inherent unique ID as the source of this value if stability is desirable. In that - * case, the ID SHOULD be used as source of a UUID Version 5 and SHOULD use the following - * UUID as the namespace: {@code 4d63009a-8d0f-11ee-aad7-4c796ed8e320}. - *
                • UUIDs are typically recommended, as only an opaque value for the purposes of identifying - * a service instance is needed. Similar to what can be seen in the man page for the {@code - * /etc/machine-id} file, the underlying data, such as pod name and namespace should be - * treated as confidential, being the user's choice to expose it or not via another resource - * attribute. - *
                • For applications running behind an application server (like unicorn), we do not recommend - * using one identifier for all processes participating in the application. Instead, it's - * recommended each division (e.g. a worker thread in unicorn) to have its own instance.id. - *
                • It's not recommended for a Collector to set {@code service.instance.id} if it can't - * unambiguously determine the service instance that is generating that telemetry. For - * instance, creating an UUID based on {@code pod.name} will likely be wrong, as the - * Collector might not know from which container within that pod the telemetry originated. - * However, Collectors can set the {@code service.instance.id} if they can unambiguously - * determine the service instance for that telemetry. This is typically the case for - * scraping receivers, as they know the target address and port. - *
                + *

                MUST be unique for each instance of the same {@code service.namespace,service.name} pair (in + * other words {@code service.namespace,service.name,service.instance.id} triplet MUST be globally + * unique). The ID helps to distinguish instances of the same service that exist at the same time + * (e.g. instances of a horizontally scaled service). + * + *

                Implementations, such as SDKs, are recommended to generate a random Version 1 or Version 4 + * RFC 4122 UUID, but are free to use an + * inherent unique ID as the source of this value if stability is desirable. In that case, the ID + * SHOULD be used as source of a UUID Version 5 and SHOULD use the following UUID as the + * namespace: {@code 4d63009a-8d0f-11ee-aad7-4c796ed8e320}. + * + *

                UUIDs are typically recommended, as only an opaque value for the purposes of identifying a + * service instance is needed. Similar to what can be seen in the man page for the {@code + * /etc/machine-id} file, the underlying data, such as pod name and namespace should be + * treated as confidential, being the user's choice to expose it or not via another resource + * attribute. + * + *

                For applications running behind an application server (like unicorn), we do not recommend + * using one identifier for all processes participating in the application. Instead, it's + * recommended each division (e.g. a worker thread in unicorn) to have its own instance.id. + * + *

                It's not recommended for a Collector to set {@code service.instance.id} if it can't + * unambiguously determine the service instance that is generating that telemetry. For instance, + * creating an UUID based on {@code pod.name} will likely be wrong, as the Collector might not + * know from which container within that pod the telemetry originated. However, Collectors can set + * the {@code service.instance.id} if they can unambiguously determine the service instance for + * that telemetry. This is typically the case for scraping receivers, as they know the target + * address and port. */ public static final AttributeKey SERVICE_INSTANCE_ID = stringKey("service.instance.id"); @@ -54,13 +55,13 @@ public final class ServiceIncubatingAttributes { * *

                Notes: * - *

                  - *
                • MUST be the same for all instances of horizontally scaled services. If the value was not - * specified, SDKs MUST fallback to {@code unknown_service:} concatenated with {@code process.executable.name}, e.g. {@code unknown_service:bash}. - * If {@code process.executable.name} is not available, the value MUST be set to {@code - * unknown_service}. - *
                + *

                MUST be the same for all instances of horizontally scaled services. If the value was not + * specified, SDKs MUST fallback to {@code unknown_service:} concatenated with {@code process.executable.name}, e.g. {@code unknown_service:bash}. If + * {@code process.executable.name} is not available, the value MUST be set to {@code + * unknown_service}. + * + *

                * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.ServiceAttributes#SERVICE_NAME} attribute. @@ -72,14 +73,12 @@ public final class ServiceIncubatingAttributes { * *

                Notes: * - *

                  - *
                • A string value having a meaning that helps to distinguish a group of services, for - * example the team name that owns a group of services. {@code service.name} is expected to - * be unique within the same namespace. If {@code service.namespace} is not specified in the - * Resource then {@code service.name} is expected to be unique for all services that have no - * explicit namespace defined (so the empty/unspecified namespace is simply one more valid - * namespace). Zero-length namespace string is assumed equal to unspecified namespace. - *
                + *

                A string value having a meaning that helps to distinguish a group of services, for example + * the team name that owns a group of services. {@code service.name} is expected to be unique + * within the same namespace. If {@code service.namespace} is not specified in the Resource then + * {@code service.name} is expected to be unique for all services that have no explicit namespace + * defined (so the empty/unspecified namespace is simply one more valid namespace). Zero-length + * namespace string is assumed equal to unspecified namespace. */ public static final AttributeKey SERVICE_NAMESPACE = stringKey("service.namespace"); @@ -87,11 +86,15 @@ public final class ServiceIncubatingAttributes { * The version string of the service API or implementation. The format is not defined by these * conventions. * + *

                + * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.ServiceAttributes#SERVICE_VERSION} attribute. */ @Deprecated public static final AttributeKey SERVICE_VERSION = stringKey("service.version"); + // Enum definitions + private ServiceIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/SessionIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/SessionIncubatingAttributes.java index 159faa4..3a667f7 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/SessionIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/SessionIncubatingAttributes.java @@ -10,15 +10,16 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class SessionIncubatingAttributes { - /** A unique id to identify a session. */ public static final AttributeKey SESSION_ID = stringKey("session.id"); /** The previous {@code session.id} for this user, when known. */ public static final AttributeKey SESSION_PREVIOUS_ID = stringKey("session.previous_id"); + // Enum definitions + private SessionIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/SourceIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/SourceIncubatingAttributes.java index 549ef97..6223e23 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/SourceIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/SourceIncubatingAttributes.java @@ -11,26 +11,25 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class SourceIncubatingAttributes { - /** * Source address - domain name if available without reverse DNS lookup; otherwise, IP address or * Unix domain socket name. * *

                Notes: * - *

                  - *
                • When observed from the destination side, and when communicating through an intermediary, - * {@code source.address} SHOULD represent the source address behind any intermediaries, for - * example proxies, if it's available. - *
                + *

                When observed from the destination side, and when communicating through an intermediary, + * {@code source.address} SHOULD represent the source address behind any intermediaries, for + * example proxies, if it's available. */ public static final AttributeKey SOURCE_ADDRESS = stringKey("source.address"); /** Source port number */ public static final AttributeKey SOURCE_PORT = longKey("source.port"); + // Enum definitions + private SourceIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/SystemIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/SystemIncubatingAttributes.java index 8033481..2a56cb9 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/SystemIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/SystemIncubatingAttributes.java @@ -11,10 +11,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class SystemIncubatingAttributes { - /** The logical CPU number [0..n-1] */ public static final AttributeKey SYSTEM_CPU_LOGICAL_NUMBER = longKey("system.cpu.logical_number"); @@ -22,7 +21,9 @@ public final class SystemIncubatingAttributes { /** * Deprecated, use {@code cpu.mode} instead. * - * @deprecated Deprecated, use `cpu.mode` instead. + *

                + * + * @deprecated Replaced by {@code cpu.mode} */ @Deprecated public static final AttributeKey SYSTEM_CPU_STATE = stringKey("system.cpu.state"); @@ -73,7 +74,9 @@ public final class SystemIncubatingAttributes { /** * Deprecated, use {@code system.process.status} instead. * - * @deprecated Deprecated, use `system.process.status` instead. + *

                + * + * @deprecated Replaced by {@code system.process.status}. */ @Deprecated public static final AttributeKey SYSTEM_PROCESSES_STATUS = @@ -81,9 +84,9 @@ public final class SystemIncubatingAttributes { // Enum definitions /** - * Values for {@link #SYSTEM_CPU_STATE}. + * Values for {@link #SYSTEM_CPU_STATE} * - * @deprecated Deprecated, use `cpu.mode` instead. + * @deprecated Replaced by {@code cpu.mode} */ @Deprecated public static final class SystemCpuStateValues { @@ -260,9 +263,9 @@ private SystemProcessStatusValues() {} } /** - * Values for {@link #SYSTEM_PROCESSES_STATUS}. + * Values for {@link #SYSTEM_PROCESSES_STATUS} * - * @deprecated Deprecated, use `system.process.status` instead. + * @deprecated Replaced by {@code system.process.status}. */ @Deprecated public static final class SystemProcessesStatusValues { diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/TelemetryIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/TelemetryIncubatingAttributes.java index c4be885..74be9d6 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/TelemetryIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/TelemetryIncubatingAttributes.java @@ -10,20 +10,17 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class TelemetryIncubatingAttributes { - /** * The name of the auto instrumentation agent or distribution, if used. * *

                Notes: * - *

                  - *
                • Official auto instrumentation agents and distributions SHOULD set the {@code - * telemetry.distro.name} attribute to a string starting with {@code opentelemetry-}, e.g. - * {@code opentelemetry-java-instrumentation}. - *
                + *

                Official auto instrumentation agents and distributions SHOULD set the {@code + * telemetry.distro.name} attribute to a string starting with {@code opentelemetry-}, e.g. {@code + * opentelemetry-java-instrumentation}. */ public static final AttributeKey TELEMETRY_DISTRO_NAME = stringKey("telemetry.distro.name"); @@ -35,6 +32,8 @@ public final class TelemetryIncubatingAttributes { /** * The language of the telemetry SDK. * + *

                + * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.TelemetryAttributes#TELEMETRY_SDK_LANGUAGE} attribute. */ @@ -47,15 +46,14 @@ public final class TelemetryIncubatingAttributes { * *

                Notes: * - *

                  - *
                • The OpenTelemetry SDK MUST set the {@code telemetry.sdk.name} attribute to {@code - * opentelemetry}. If another SDK, like a fork or a vendor-provided implementation, is used, - * this SDK MUST set the {@code telemetry.sdk.name} attribute to the fully-qualified class - * or module name of this SDK's main entry point or another suitable identifier depending on - * the language. The identifier {@code opentelemetry} is reserved and MUST NOT be used in - * this case. All custom identifiers SHOULD be stable across different versions of an - * implementation. - *
                + *

                The OpenTelemetry SDK MUST set the {@code telemetry.sdk.name} attribute to {@code + * opentelemetry}. If another SDK, like a fork or a vendor-provided implementation, is used, this + * SDK MUST set the {@code telemetry.sdk.name} attribute to the fully-qualified class or module + * name of this SDK's main entry point or another suitable identifier depending on the language. + * The identifier {@code opentelemetry} is reserved and MUST NOT be used in this case. All custom + * identifiers SHOULD be stable across different versions of an implementation. + * + *

                * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.TelemetryAttributes#TELEMETRY_SDK_NAME} attribute. @@ -66,6 +64,8 @@ public final class TelemetryIncubatingAttributes { /** * The version string of the telemetry SDK. * + *

                + * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.TelemetryAttributes#TELEMETRY_SDK_VERSION} attribute. */ @@ -78,7 +78,7 @@ public final class TelemetryIncubatingAttributes { * Values for {@link #TELEMETRY_SDK_LANGUAGE}. * * @deprecated deprecated in favor of stable {@link - * io.opentelemetry.semconv.TelemetryAttributes.TelemetrySdkLanguageValues} attribute. + * io.opentelemetry.semconv.TelemetryAttributes.TelemetrySdkLanguageValues}. */ @Deprecated public static final class TelemetrySdkLanguageValues { diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/TestIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/TestIncubatingAttributes.java index 778843a..faf2f57 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/TestIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/TestIncubatingAttributes.java @@ -10,10 +10,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class TestIncubatingAttributes { - /** * The fully qualified human readable name of the test case. @@ -36,10 +35,10 @@ public final class TestIncubatingAttributes { // Enum definitions /** Values for {@link #TEST_CASE_RESULT_STATUS}. */ public static final class TestCaseResultStatusValues { - /** pass. */ + /** pass */ public static final String PASS = "pass"; - /** fail. */ + /** fail */ public static final String FAIL = "fail"; private TestCaseResultStatusValues() {} @@ -47,22 +46,22 @@ private TestCaseResultStatusValues() {} /** Values for {@link #TEST_SUITE_RUN_STATUS}. */ public static final class TestSuiteRunStatusValues { - /** success. */ + /** success */ public static final String SUCCESS = "success"; - /** failure. */ + /** failure */ public static final String FAILURE = "failure"; - /** skipped. */ + /** skipped */ public static final String SKIPPED = "skipped"; - /** aborted. */ + /** aborted */ public static final String ABORTED = "aborted"; - /** timed_out. */ + /** timed_out */ public static final String TIMED_OUT = "timed_out"; - /** in_progress. */ + /** in_progress */ public static final String IN_PROGRESS = "in_progress"; private TestSuiteRunStatusValues() {} diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ThreadIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ThreadIncubatingAttributes.java index 413e843..e68d5e3 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ThreadIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/ThreadIncubatingAttributes.java @@ -11,15 +11,16 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class ThreadIncubatingAttributes { - - /** Current "managed" thread ID (as opposed to OS thread ID). */ + /** Current "managed" thread ID (as opposed to OS thread ID). */ public static final AttributeKey THREAD_ID = longKey("thread.id"); /** Current thread name. */ public static final AttributeKey THREAD_NAME = stringKey("thread.name"); + // Enum definitions + private ThreadIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/TlsIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/TlsIncubatingAttributes.java index 3ae4c25..487efbf 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/TlsIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/TlsIncubatingAttributes.java @@ -13,10 +13,9 @@ import java.util.List; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class TlsIncubatingAttributes { - /** * String indicating the cipher used during the @@ -24,12 +23,9 @@ public final class TlsIncubatingAttributes { * *

                Notes: * - *

                + *

                The values allowed for {@code tls.cipher} MUST be one of the {@code Descriptions} of the registered + * TLS Cipher Suits. */ public static final AttributeKey TLS_CIPHER = stringKey("tls.cipher"); @@ -90,7 +86,9 @@ public final class TlsIncubatingAttributes { /** * Deprecated, use {@code server.address} instead. * - * @deprecated Deprecated, use `server.address` instead. + *

                + * + * @deprecated Replaced by `server.address. */ @Deprecated public static final AttributeKey TLS_CLIENT_SERVER_NAME = diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/UrlIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/UrlIncubatingAttributes.java index 0af5919..3bc553f 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/UrlIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/UrlIncubatingAttributes.java @@ -11,22 +11,19 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class UrlIncubatingAttributes { - /** - * Domain extracted from the {@code url.full}, such as "opentelemetry.io". + * Domain extracted from the {@code url.full}, such as "opentelemetry.io". * *

                Notes: * - *

                  - *
                • In some cases a URL may refer to an IP and/or port directly, without a domain name. In - * this case, the IP address would go to the domain field. If the URL contains a literal IPv6 address enclosed - * by {@code [} and {@code ]}, the {@code [} and {@code ]} characters should also be - * captured in the domain field. - *
                + *

                In some cases a URL may refer to an IP and/or port directly, without a domain name. In this + * case, the IP address would go to the domain field. If the URL contains a literal IPv6 address enclosed by + * {@code [} and {@code ]}, the {@code [} and {@code ]} characters should also be captured in the + * domain field. */ public static final AttributeKey URL_DOMAIN = stringKey("url.domain"); @@ -35,17 +32,17 @@ public final class UrlIncubatingAttributes { * *

                Notes: * - *

                  - *
                • The file extension is only set if it exists, as not every url has a file extension. When - * the file name has multiple extensions {@code example.tar.gz}, only the last one should be - * captured {@code gz}, not {@code tar.gz}. - *
                + *

                The file extension is only set if it exists, as not every url has a file extension. When the + * file name has multiple extensions {@code example.tar.gz}, only the last one should be captured + * {@code gz}, not {@code tar.gz}. */ public static final AttributeKey URL_EXTENSION = stringKey("url.extension"); /** * The URI fragment component * + *

                + * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.UrlAttributes#URL_FRAGMENT} attribute. */ @@ -57,16 +54,16 @@ public final class UrlIncubatingAttributes { * *

                Notes: * - *

                  - *
                • For network calls, URL usually has {@code scheme://host[:port][path][?query][#fragment]} - * format, where the fragment is not transmitted over HTTP, but if it is known, it SHOULD be - * included nevertheless. {@code url.full} MUST NOT contain credentials passed via URL in - * form of {@code https://username:password@www.example.com/}. In such case username and - * password SHOULD be redacted and attribute's value SHOULD be {@code - * https://REDACTED:REDACTED@www.example.com/}. {@code url.full} SHOULD capture the absolute - * URL when it is available (or can be reconstructed). Sensitive content provided in {@code - * url.full} SHOULD be scrubbed when instrumentations can identify it. - *
                + *

                For network calls, URL usually has {@code scheme://host[:port][path][?query][#fragment]} + * format, where the fragment is not transmitted over HTTP, but if it is known, it SHOULD be + * included nevertheless. {@code url.full} MUST NOT contain credentials passed via URL in form of + * {@code https://username:password@www.example.com/}. In such case username and password SHOULD + * be redacted and attribute's value SHOULD be {@code https://REDACTED:REDACTED@www.example.com/}. + * {@code url.full} SHOULD capture the absolute URL when it is available (or can be + * reconstructed). Sensitive content provided in {@code url.full} SHOULD be scrubbed when + * instrumentations can identify it. + * + *

                * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.UrlAttributes#URL_FULL} attribute. @@ -78,13 +75,11 @@ public final class UrlIncubatingAttributes { * *

                Notes: * - *

                  - *
                • In network monitoring, the observed URL may be a full URL, whereas in access logs, the - * URL is often just represented as a path. This field is meant to represent the URL as it - * was observed, complete or not. {@code url.original} might contain credentials passed via - * URL in form of {@code https://username:password@www.example.com/}. In such case password - * and username SHOULD NOT be redacted and attribute's value SHOULD remain the same. - *
                + *

                In network monitoring, the observed URL may be a full URL, whereas in access logs, the URL + * is often just represented as a path. This field is meant to represent the URL as it was + * observed, complete or not. {@code url.original} might contain credentials passed via URL in + * form of {@code https://username:password@www.example.com/}. In such case password and username + * SHOULD NOT be redacted and attribute's value SHOULD remain the same. */ public static final AttributeKey URL_ORIGINAL = stringKey("url.original"); @@ -93,10 +88,10 @@ public final class UrlIncubatingAttributes { * *

                Notes: * - *

                  - *
                • Sensitive content provided in {@code url.path} SHOULD be scrubbed when instrumentations - * can identify it. - *
                + *

                Sensitive content provided in {@code url.path} SHOULD be scrubbed when instrumentations can + * identify it. + * + *

                * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.UrlAttributes#URL_PATH} attribute. @@ -111,10 +106,10 @@ public final class UrlIncubatingAttributes { * *

                Notes: * - *

                  - *
                • Sensitive content provided in {@code url.query} SHOULD be scrubbed when instrumentations - * can identify it. - *
                + *

                Sensitive content provided in {@code url.query} SHOULD be scrubbed when instrumentations can + * identify it. + * + *

                * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.UrlAttributes#URL_QUERY} attribute. @@ -126,12 +121,10 @@ public final class UrlIncubatingAttributes { * *

                Notes: * - *

                  - *
                • This value can be determined precisely with the public - * suffix list. For example, the registered domain for {@code foo.example.com} is {@code - * example.com}. Trying to approximate this by simply taking the last two labels will not - * work well for TLDs such as {@code co.uk}. - *
                + *

                This value can be determined precisely with the public + * suffix list. For example, the registered domain for {@code foo.example.com} is {@code + * example.com}. Trying to approximate this by simply taking the last two labels will not work + * well for TLDs such as {@code co.uk}. */ public static final AttributeKey URL_REGISTERED_DOMAIN = stringKey("url.registered_domain"); @@ -140,6 +133,8 @@ public final class UrlIncubatingAttributes { * The URI scheme component * identifying the used protocol. * + *

                + * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.UrlAttributes#URL_SCHEME} attribute. */ @@ -153,11 +148,9 @@ public final class UrlIncubatingAttributes { * *

                Notes: * - *

                  - *
                • The subdomain portion of {@code www.east.mydomain.co.uk} is {@code east}. If the domain - * has multiple levels of subdomain, such as {@code sub2.sub1.example.com}, the subdomain - * field should contain {@code sub2.sub1}, with no trailing period. - *
                + *

                The subdomain portion of {@code www.east.mydomain.co.uk} is {@code east}. If the domain has + * multiple levels of subdomain, such as {@code sub2.sub1.example.com}, the subdomain field should + * contain {@code sub2.sub1}, with no trailing period. */ public static final AttributeKey URL_SUBDOMAIN = stringKey("url.subdomain"); @@ -173,12 +166,12 @@ public final class UrlIncubatingAttributes { * *

                Notes: * - *

                + *

                This value can be determined precisely with the public + * suffix list. */ public static final AttributeKey URL_TOP_LEVEL_DOMAIN = stringKey("url.top_level_domain"); + // Enum definitions + private UrlIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/UserAgentIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/UserAgentIncubatingAttributes.java index 77f3e51..ea3e21c 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/UserAgentIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/UserAgentIncubatingAttributes.java @@ -10,22 +10,18 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class UserAgentIncubatingAttributes { - /** * Name of the user-agent extracted from original. Usually refers to the browser's name. * *

                Notes: * - *

                  - *
                • Example of extracting browser's name from - * original string. In the case of using a user-agent for non-browser products, such as - * microservices with multiple names/versions inside the {@code user_agent.original}, the - * most significant name SHOULD be selected. In such a scenario it should align with {@code - * user_agent.version} - *
                + *

                Example of extracting browser's name from original + * string. In the case of using a user-agent for non-browser products, such as microservices with + * multiple names/versions inside the {@code user_agent.original}, the most significant name + * SHOULD be selected. In such a scenario it should align with {@code user_agent.version} */ public static final AttributeKey USER_AGENT_NAME = stringKey("user_agent.name"); @@ -33,6 +29,8 @@ public final class UserAgentIncubatingAttributes { * Value of the HTTP * User-Agent header sent by the client. * + *

                + * * @deprecated deprecated in favor of stable {@link * io.opentelemetry.semconv.UserAgentAttributes#USER_AGENT_ORIGINAL} attribute. */ @@ -44,15 +42,15 @@ public final class UserAgentIncubatingAttributes { * *

                Notes: * - *

                  - *
                • Example of extracting browser's version from - * original string. In the case of using a user-agent for non-browser products, such as - * microservices with multiple names/versions inside the {@code user_agent.original}, the - * most significant version SHOULD be selected. In such a scenario it should align with - * {@code user_agent.name} - *
                + *

                Example of extracting browser's version from + * original string. In the case of using a user-agent for non-browser products, such as + * microservices with multiple names/versions inside the {@code user_agent.original}, the most + * significant version SHOULD be selected. In such a scenario it should align with {@code + * user_agent.name} */ public static final AttributeKey USER_AGENT_VERSION = stringKey("user_agent.version"); + // Enum definitions + private UserAgentIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/UserIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/UserIncubatingAttributes.java index 3330333..305bea1 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/UserIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/UserIncubatingAttributes.java @@ -12,10 +12,9 @@ import java.util.List; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class UserIncubatingAttributes { - /** User email address. */ public static final AttributeKey USER_EMAIL = stringKey("user.email"); @@ -27,10 +26,8 @@ public final class UserIncubatingAttributes { * *

                Notes: * - *

                  - *
                • Useful if {@code user.id} or {@code user.name} contain confidential information and - * cannot be used. - *
                + *

                Useful if {@code user.id} or {@code user.name} contain confidential information and cannot + * be used. */ public static final AttributeKey USER_HASH = stringKey("user.hash"); @@ -43,5 +40,7 @@ public final class UserIncubatingAttributes { /** Array of user roles at the time of the event. */ public static final AttributeKey> USER_ROLES = stringArrayKey("user.roles"); + // Enum definitions + private UserIncubatingAttributes() {} } diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/V8jsIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/V8jsIncubatingAttributes.java index 1d58ed4..6494c63 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/V8jsIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/V8jsIncubatingAttributes.java @@ -10,10 +10,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class V8jsIncubatingAttributes { - /** The type of garbage collection. */ public static final AttributeKey V8JS_GC_TYPE = stringKey("v8js.gc.type"); @@ -22,11 +21,9 @@ public final class V8jsIncubatingAttributes { * *

                Notes: * - *

                + *

                Value can be retrieved from value {@code space_name} of {@code + * v8.getHeapSpaceStatistics()} */ public static final AttributeKey V8JS_HEAP_SPACE_NAME = stringKey("v8js.heap.space.name"); diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/VcsIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/VcsIncubatingAttributes.java index f805b58..8ccfa64 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/VcsIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/VcsIncubatingAttributes.java @@ -10,10 +10,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class VcsIncubatingAttributes { - /** * The ID of the change (pull request/merge request) if applicable. This is usually a unique * (within repository) identifier generated by the VCS system. @@ -42,18 +41,15 @@ public final class VcsIncubatingAttributes { * *

                Notes: * - *

                  - *
                • The revision can be a full hash value (see - * glossary), of the recorded change to a ref within a repository pointing to a commit - * commit object. It does not necessarily - * have to be a hash; it can simply define a revision - * number which is an integer that is monotonically increasing. In cases where it is - * identical to the {@code ref.name}, it SHOULD still be included. It is up to the - * implementer to decide which value to set as the revision based on the VCS system and - * situational context. - *
                + *

                The revision can be a full hash value (see + * glossary), of the recorded change to a ref within a repository pointing to a commit commit object. It does not necessarily have to + * be a hash; it can simply define a revision number + * which is an integer that is monotonically increasing. In cases where it is identical to the + * {@code ref.name}, it SHOULD still be included. It is up to the implementer to decide which + * value to set as the revision based on the VCS system and situational context. */ public static final AttributeKey VCS_REPOSITORY_REF_REVISION = stringKey("vcs.repository.ref.revision"); @@ -76,11 +72,15 @@ public final class VcsIncubatingAttributes { /** Values for {@link #VCS_REPOSITORY_REF_TYPE}. */ public static final class VcsRepositoryRefTypeValues { /** - * [branch](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefbranchabranch). + * branch */ public static final String BRANCH = "branch"; - /** [tag](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddeftagatag). */ + /** + * tag + */ public static final String TAG = "tag"; private VcsRepositoryRefTypeValues() {} diff --git a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/WebengineIncubatingAttributes.java b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/WebengineIncubatingAttributes.java index 48d2ada..d4f2f1a 100644 --- a/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/WebengineIncubatingAttributes.java +++ b/semconv-incubating/src/main/java/io/opentelemetry/semconv/incubating/WebengineIncubatingAttributes.java @@ -10,10 +10,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 @SuppressWarnings("unused") public final class WebengineIncubatingAttributes { - /** Additional description of the web engine (e.g. detailed version and edition information). */ public static final AttributeKey WEBENGINE_DESCRIPTION = stringKey("webengine.description"); @@ -24,5 +23,7 @@ public final class WebengineIncubatingAttributes { /** The version of the web engine. */ public static final AttributeKey WEBENGINE_VERSION = stringKey("webengine.version"); + // Enum definitions + private WebengineIncubatingAttributes() {} } diff --git a/semconv/src/main/java/io/opentelemetry/semconv/ClientAttributes.java b/semconv/src/main/java/io/opentelemetry/semconv/ClientAttributes.java index f182ec5..c8b4273 100644 --- a/semconv/src/main/java/io/opentelemetry/semconv/ClientAttributes.java +++ b/semconv/src/main/java/io/opentelemetry/semconv/ClientAttributes.java @@ -11,21 +11,18 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/java/SemanticAttributes.java.j2 @SuppressWarnings("unused") public final class ClientAttributes { - /** * Client address - domain name if available without reverse DNS lookup; otherwise, IP address or * Unix domain socket name. * *

                Notes: * - *

                  - *
                • When observed from the server side, and when communicating through an intermediary, - * {@code client.address} SHOULD represent the client address behind any intermediaries, for - * example proxies, if it's available. - *
                + *

                When observed from the server side, and when communicating through an intermediary, {@code + * client.address} SHOULD represent the client address behind any intermediaries, for example + * proxies, if it's available. */ public static final AttributeKey CLIENT_ADDRESS = stringKey("client.address"); @@ -34,11 +31,9 @@ public final class ClientAttributes { * *

                Notes: * - *

                  - *
                • When observed from the server side, and when communicating through an intermediary, - * {@code client.port} SHOULD represent the client port behind any intermediaries, for - * example proxies, if it's available. - *
                + *

                When observed from the server side, and when communicating through an intermediary, {@code + * client.port} SHOULD represent the client port behind any intermediaries, for example proxies, + * if it's available. */ public static final AttributeKey CLIENT_PORT = longKey("client.port"); diff --git a/semconv/src/main/java/io/opentelemetry/semconv/ErrorAttributes.java b/semconv/src/main/java/io/opentelemetry/semconv/ErrorAttributes.java index e958c21..25357e6 100644 --- a/semconv/src/main/java/io/opentelemetry/semconv/ErrorAttributes.java +++ b/semconv/src/main/java/io/opentelemetry/semconv/ErrorAttributes.java @@ -10,28 +10,35 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/java/SemanticAttributes.java.j2 @SuppressWarnings("unused") public final class ErrorAttributes { - /** * Describes a class of error the operation ended with. * *

                Notes: * + *

                The {@code error.type} SHOULD be predictable, and SHOULD have low cardinality. + * + *

                When {@code error.type} is set to a type (e.g., an exception type), its canonical class name + * identifying the type within the artifact SHOULD be used. + * + *

                Instrumentations SHOULD document the list of errors they report. + * + *

                The cardinality of {@code error.type} within one instrumentation library SHOULD be low. + * Telemetry consumers that aggregate data from multiple instrumentation libraries and + * applications should be prepared for {@code error.type} to have high cardinality at query time + * when no additional filters are applied. + * + *

                If the operation has completed successfully, instrumentations SHOULD NOT set {@code + * error.type}. + * + *

                If a specific domain defines its own set of error identifiers (such as HTTP or gRPC status + * codes), it's RECOMMENDED to: + * + *

                + * *

                  - *
                • The {@code error.type} SHOULD be predictable, and SHOULD have low cardinality. - *
                • When {@code error.type} is set to a type (e.g., an exception type), its canonical class - * name identifying the type within the artifact SHOULD be used. - *
                • Instrumentations SHOULD document the list of errors they report. - *
                • The cardinality of {@code error.type} within one instrumentation library SHOULD be low. - * Telemetry consumers that aggregate data from multiple instrumentation libraries and - * applications should be prepared for {@code error.type} to have high cardinality at query - * time when no additional filters are applied. - *
                • If the operation has completed successfully, instrumentations SHOULD NOT set {@code - * error.type}. - *
                • If a specific domain defines its own set of error identifiers (such as HTTP or gRPC - * status codes), it's RECOMMENDED to: *
                • Use a domain-specific attribute *
                • Set {@code error.type} to capture all errors, regardless of whether they are defined * within the domain-specific set or not. @@ -39,12 +46,10 @@ public final class ErrorAttributes { */ public static final AttributeKey ERROR_TYPE = stringKey("error.type"); - // Enum definitions + // Enum definition /** Values for {@link #ERROR_TYPE}. */ public static final class ErrorTypeValues { - /** - * A fallback error value to be used when the instrumentation doesn't define a custom value. - */ + /** A fallback error value to be used when the instrumentation doesn't define a custom value. */ public static final String OTHER = "_OTHER"; private ErrorTypeValues() {} diff --git a/semconv/src/main/java/io/opentelemetry/semconv/ExceptionAttributes.java b/semconv/src/main/java/io/opentelemetry/semconv/ExceptionAttributes.java index ee05df2..9b200cc 100644 --- a/semconv/src/main/java/io/opentelemetry/semconv/ExceptionAttributes.java +++ b/semconv/src/main/java/io/opentelemetry/semconv/ExceptionAttributes.java @@ -11,32 +11,30 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/java/SemanticAttributes.java.j2 @SuppressWarnings("unused") public final class ExceptionAttributes { - /** * SHOULD be set to true if the exception event is recorded at a point where it is known that the * exception is escaping the scope of the span. * *

                  Notes: * - *

                    - *
                  • An exception is considered to have escaped (or left) the scope of a span, if that span is - * ended while the exception is still logically "in flight". This may be actually - * "in flight" in some languages (e.g. if the exception is passed to a Context - * manager's {@code __exit__} method in Python) but will usually be caught at the point of - * recording the exception in most languages. - *
                  • It is usually not possible to determine at the point where an exception is thrown whether - * it will escape the scope of a span. However, it is trivial to know that an exception will - * escape, if one checks for an active exception just before ending the span, as done in the - * example - * for recording span exceptions. - *
                  • It follows that an exception may still escape the scope of the span even if the {@code - * exception.escaped} attribute was not set or set to false, since the event might have been - * recorded at a time where it was not clear whether the exception will escape. - *
                  + *

                  An exception is considered to have escaped (or left) the scope of a span, if that span is + * ended while the exception is still logically "in flight". This may be actually "in flight" in + * some languages (e.g. if the exception is passed to a Context manager's {@code __exit__} method + * in Python) but will usually be caught at the point of recording the exception in most + * languages. + * + *

                  It is usually not possible to determine at the point where an exception is thrown whether it + * will escape the scope of a span. However, it is trivial to know that an exception will escape, + * if one checks for an active exception just before ending the span, as done in the example + * for recording span exceptions. + * + *

                  It follows that an exception may still escape the scope of the span even if the {@code + * exception.escaped} attribute was not set or set to false, since the event might have been + * recorded at a time where it was not clear whether the exception will escape. */ public static final AttributeKey EXCEPTION_ESCAPED = booleanKey("exception.escaped"); diff --git a/semconv/src/main/java/io/opentelemetry/semconv/HttpAttributes.java b/semconv/src/main/java/io/opentelemetry/semconv/HttpAttributes.java index f2af6b9..1296c59 100644 --- a/semconv/src/main/java/io/opentelemetry/semconv/HttpAttributes.java +++ b/semconv/src/main/java/io/opentelemetry/semconv/HttpAttributes.java @@ -13,26 +13,22 @@ import java.util.List; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/java/SemanticAttributes.java.j2 @SuppressWarnings("unused") public final class HttpAttributes { - /** * HTTP request headers, {@code } being the normalized HTTP Header name (lowercase), the * value being the header values. * *

                  Notes: * - *

                    - *
                  • Instrumentations SHOULD require an explicit configuration of which headers are to be - * captured. Including all request headers can be a security risk - explicit configuration - * helps avoid leaking sensitive information. The {@code User-Agent} header is already - * captured in the {@code user_agent.original} attribute. Users MAY explicitly configure - * instrumentations to capture them even though it is not recommended. The attribute value - * MUST consist of either multiple header values as an array of strings or a single-item - * array containing a possibly comma-concatenated string, depending on the way the HTTP - * library provides access to headers. - *
                  + *

                  Instrumentations SHOULD require an explicit configuration of which headers are to be + * captured. Including all request headers can be a security risk - explicit configuration helps + * avoid leaking sensitive information. The {@code User-Agent} header is already captured in the + * {@code user_agent.original} attribute. Users MAY explicitly configure instrumentations to + * capture them even though it is not recommended. The attribute value MUST consist of either + * multiple header values as an array of strings or a single-item array containing a possibly + * comma-concatenated string, depending on the way the HTTP library provides access to headers. */ public static final AttributeKeyTemplate> HTTP_REQUEST_HEADER = stringArrayKeyTemplate("http.request.header"); @@ -42,25 +38,26 @@ public final class HttpAttributes { * *

                  Notes: * - *

                    - *
                  • HTTP request method value SHOULD be "known" to the instrumentation. By default, - * this convention defines "known" methods as the ones listed in RFC9110 and the PATCH - * method defined in RFC5789. - *
                  • If the HTTP request method is not known to instrumentation, it MUST set the {@code - * http.request.method} attribute to {@code _OTHER}. - *
                  • If the HTTP instrumentation could end up converting valid HTTP request methods to {@code - * _OTHER}, then it MUST provide a way to override the list of known HTTP methods. If this - * override is done via environment variable, then the environment variable MUST be named - * OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of - * case-sensitive known HTTP methods (this list MUST be a full override of the default known - * method, it is not a list of known methods in addition to the defaults). - *
                  • HTTP method names are case-sensitive and {@code http.request.method} attribute value MUST - * match a known HTTP method name exactly. Instrumentations for specific web frameworks that - * consider HTTP methods to be case insensitive, SHOULD populate a canonical equivalent. - * Tracing instrumentations that do so, MUST also set {@code http.request.method_original} - * to the original value. - *
                  + *

                  HTTP request method value SHOULD be "known" to the instrumentation. By default, this + * convention defines "known" methods as the ones listed in RFC9110 and the PATCH + * method defined in RFC5789. + * + *

                  If the HTTP request method is not known to instrumentation, it MUST set the {@code + * http.request.method} attribute to {@code _OTHER}. + * + *

                  If the HTTP instrumentation could end up converting valid HTTP request methods to {@code + * _OTHER}, then it MUST provide a way to override the list of known HTTP methods. If this + * override is done via environment variable, then the environment variable MUST be named + * OTEL_INSTRUMENTATION_HTTP_KNOWN_METHODS and support a comma-separated list of case-sensitive + * known HTTP methods (this list MUST be a full override of the default known method, it is not a + * list of known methods in addition to the defaults). + * + *

                  HTTP method names are case-sensitive and {@code http.request.method} attribute value MUST + * match a known HTTP method name exactly. Instrumentations for specific web frameworks that + * consider HTTP methods to be case insensitive, SHOULD populate a canonical equivalent. Tracing + * instrumentations that do so, MUST also set {@code http.request.method_original} to the original + * value. */ public static final AttributeKey HTTP_REQUEST_METHOD = stringKey("http.request.method"); @@ -73,11 +70,9 @@ public final class HttpAttributes { * *

                  Notes: * - *

                    - *
                  • The resend count SHOULD be updated each time an HTTP request gets resent by the client, - * regardless of what was the cause of the resending (e.g. redirection, authorization - * failure, 503 Server Unavailable, network issues, or any other). - *
                  + *

                  The resend count SHOULD be updated each time an HTTP request gets resent by the client, + * regardless of what was the cause of the resending (e.g. redirection, authorization failure, 503 + * Server Unavailable, network issues, or any other). */ public static final AttributeKey HTTP_REQUEST_RESEND_COUNT = longKey("http.request.resend_count"); @@ -88,15 +83,12 @@ public final class HttpAttributes { * *

                  Notes: * - *

                    - *
                  • Instrumentations SHOULD require an explicit configuration of which headers are to be - * captured. Including all response headers can be a security risk - explicit configuration - * helps avoid leaking sensitive information. Users MAY explicitly configure - * instrumentations to capture them even though it is not recommended. The attribute value - * MUST consist of either multiple header values as an array of strings or a single-item - * array containing a possibly comma-concatenated string, depending on the way the HTTP - * library provides access to headers. - *
                  + *

                  Instrumentations SHOULD require an explicit configuration of which headers are to be + * captured. Including all response headers can be a security risk - explicit configuration helps + * avoid leaking sensitive information. Users MAY explicitly configure instrumentations to capture + * them even though it is not recommended. The attribute value MUST consist of either multiple + * header values as an array of strings or a single-item array containing a possibly + * comma-concatenated string, depending on the way the HTTP library provides access to headers. */ public static final AttributeKeyTemplate> HTTP_RESPONSE_HEADER = stringArrayKeyTemplate("http.response.header"); @@ -111,16 +103,14 @@ public final class HttpAttributes { * *

                  Notes: * - *

                    - *
                  • MUST NOT be populated when this is not supported by the HTTP server framework as the - * route attribute should have low-cardinality and the URI path can NOT substitute it. - * SHOULD include the application - * root if there is one. - *
                  + *

                  MUST NOT be populated when this is not supported by the HTTP server framework as the route + * attribute should have low-cardinality and the URI path can NOT substitute it. SHOULD include + * the application root if there is + * one. */ public static final AttributeKey HTTP_ROUTE = stringKey("http.route"); - // Enum definitions + // Enum definition /** Values for {@link #HTTP_REQUEST_METHOD}. */ public static final class HttpRequestMethodValues { /** CONNECT method. */ diff --git a/semconv/src/main/java/io/opentelemetry/semconv/JvmAttributes.java b/semconv/src/main/java/io/opentelemetry/semconv/JvmAttributes.java index f9bc571..0e9c720 100644 --- a/semconv/src/main/java/io/opentelemetry/semconv/JvmAttributes.java +++ b/semconv/src/main/java/io/opentelemetry/semconv/JvmAttributes.java @@ -11,19 +11,16 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/java/SemanticAttributes.java.j2 @SuppressWarnings("unused") public final class JvmAttributes { - /** * Name of the garbage collector action. * *

                  Notes: * - *

                  + *

                  Garbage collector action is generally obtained via GarbageCollectionNotificationInfo#getGcAction(). */ public static final AttributeKey JVM_GC_ACTION = stringKey("jvm.gc.action"); @@ -32,10 +29,8 @@ public final class JvmAttributes { * *

                  Notes: * - *

                  + *

                  Garbage collector name is generally obtained via GarbageCollectionNotificationInfo#getGcName(). */ public static final AttributeKey JVM_GC_NAME = stringKey("jvm.gc.name"); @@ -44,10 +39,8 @@ public final class JvmAttributes { * *

                  Notes: * - *

                  + *

                  Pool names are generally obtained via MemoryPoolMXBean#getName(). */ public static final AttributeKey JVM_MEMORY_POOL_NAME = stringKey("jvm.memory.pool.name"); @@ -60,18 +53,19 @@ public final class JvmAttributes { /** State of the thread. */ public static final AttributeKey JVM_THREAD_STATE = stringKey("jvm.thread.state"); - // Enum definitions + // Enum definition /** Values for {@link #JVM_MEMORY_TYPE}. */ public static final class JvmMemoryTypeValues { /** Heap memory. */ public static final String HEAP = "heap"; - /** Non-heap memory. */ + /** Non-heap memory */ public static final String NON_HEAP = "non_heap"; private JvmMemoryTypeValues() {} } + // Enum definition /** Values for {@link #JVM_THREAD_STATE}. */ public static final class JvmThreadStateValues { /** A thread that has not yet started is in this state. */ diff --git a/semconv/src/main/java/io/opentelemetry/semconv/NetworkAttributes.java b/semconv/src/main/java/io/opentelemetry/semconv/NetworkAttributes.java index 7c9fe09..f75f0a6 100644 --- a/semconv/src/main/java/io/opentelemetry/semconv/NetworkAttributes.java +++ b/semconv/src/main/java/io/opentelemetry/semconv/NetworkAttributes.java @@ -11,10 +11,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/java/SemanticAttributes.java.j2 @SuppressWarnings("unused") public final class NetworkAttributes { - /** Local address of the network connection - IP address or Unix domain socket name. */ public static final AttributeKey NETWORK_LOCAL_ADDRESS = stringKey("network.local.address"); @@ -34,9 +33,7 @@ public final class NetworkAttributes { * *

                  Notes: * - *

                    - *
                  • The value SHOULD be normalized to lowercase. - *
                  + *

                  The value SHOULD be normalized to lowercase. */ public static final AttributeKey NETWORK_PROTOCOL_NAME = stringKey("network.protocol.name"); @@ -46,12 +43,10 @@ public final class NetworkAttributes { * *

                  Notes: * - *

                    - *
                  • If protocol version is subject to negotiation (for example using ALPN), this attribute SHOULD be - * set to the negotiated version. If the actual protocol version is not known, this - * attribute SHOULD NOT be set. - *
                  + *

                  If protocol version is subject to negotiation (for example using ALPN), this attribute SHOULD be set to + * the negotiated version. If the actual protocol version is not known, this attribute SHOULD NOT + * be set. */ public static final AttributeKey NETWORK_PROTOCOL_VERSION = stringKey("network.protocol.version"); @@ -63,12 +58,11 @@ public final class NetworkAttributes { * *

                  Notes: * - *

                    - *
                  • The value SHOULD be normalized to lowercase. - *
                  • Consider always setting the transport when setting a port number, since a port number is - * ambiguous without knowing the transport. For example different processes could be - * listening on TCP port 12345 and UDP port 12345. - *
                  + *

                  The value SHOULD be normalized to lowercase. + * + *

                  Consider always setting the transport when setting a port number, since a port number is + * ambiguous without knowing the transport. For example different processes could be listening on + * TCP port 12345 and UDP port 12345. */ public static final AttributeKey NETWORK_TRANSPORT = stringKey("network.transport"); @@ -77,39 +71,38 @@ public final class NetworkAttributes { * *

                  Notes: * - *

                    - *
                  • The value SHOULD be normalized to lowercase. - *
                  + *

                  The value SHOULD be normalized to lowercase. */ public static final AttributeKey NETWORK_TYPE = stringKey("network.type"); - // Enum definitions + // Enum definition /** Values for {@link #NETWORK_TRANSPORT}. */ public static final class NetworkTransportValues { - /** TCP. */ + /** TCP */ public static final String TCP = "tcp"; - /** UDP. */ + /** UDP */ public static final String UDP = "udp"; /** Named or anonymous pipe. */ public static final String PIPE = "pipe"; - /** Unix domain socket. */ + /** Unix domain socket */ public static final String UNIX = "unix"; - /** QUIC. */ + /** QUIC */ public static final String QUIC = "quic"; private NetworkTransportValues() {} } + // Enum definition /** Values for {@link #NETWORK_TYPE}. */ public static final class NetworkTypeValues { - /** IPv4. */ + /** IPv4 */ public static final String IPV4 = "ipv4"; - /** IPv6. */ + /** IPv6 */ public static final String IPV6 = "ipv6"; private NetworkTypeValues() {} diff --git a/semconv/src/main/java/io/opentelemetry/semconv/OtelAttributes.java b/semconv/src/main/java/io/opentelemetry/semconv/OtelAttributes.java index f4003d7..01283e0 100644 --- a/semconv/src/main/java/io/opentelemetry/semconv/OtelAttributes.java +++ b/semconv/src/main/java/io/opentelemetry/semconv/OtelAttributes.java @@ -10,27 +10,23 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/java/SemanticAttributes.java.j2 @SuppressWarnings("unused") public final class OtelAttributes { - /** The name of the instrumentation scope - ({@code InstrumentationScope.Name} in OTLP). */ public static final AttributeKey OTEL_SCOPE_NAME = stringKey("otel.scope.name"); /** The version of the instrumentation scope - ({@code InstrumentationScope.Version} in OTLP). */ public static final AttributeKey OTEL_SCOPE_VERSION = stringKey("otel.scope.version"); - /** - * Name of the code, either "OK" or "ERROR". MUST NOT be set if the status - * code is UNSET. - */ + /** Name of the code, either "OK" or "ERROR". MUST NOT be set if the status code is UNSET. */ public static final AttributeKey OTEL_STATUS_CODE = stringKey("otel.status_code"); /** Description of the Status if it has a value, otherwise not set. */ public static final AttributeKey OTEL_STATUS_DESCRIPTION = stringKey("otel.status_description"); - // Enum definitions + // Enum definition /** Values for {@link #OTEL_STATUS_CODE}. */ public static final class OtelStatusCodeValues { /** diff --git a/semconv/src/main/java/io/opentelemetry/semconv/ServerAttributes.java b/semconv/src/main/java/io/opentelemetry/semconv/ServerAttributes.java index 076d78f..eb1b6b5 100644 --- a/semconv/src/main/java/io/opentelemetry/semconv/ServerAttributes.java +++ b/semconv/src/main/java/io/opentelemetry/semconv/ServerAttributes.java @@ -11,21 +11,18 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/java/SemanticAttributes.java.j2 @SuppressWarnings("unused") public final class ServerAttributes { - /** * Server domain name if available without reverse DNS lookup; otherwise, IP address or Unix * domain socket name. * *

                  Notes: * - *

                    - *
                  • When observed from the client side, and when communicating through an intermediary, - * {@code server.address} SHOULD represent the server address behind any intermediaries, for - * example proxies, if it's available. - *
                  + *

                  When observed from the client side, and when communicating through an intermediary, {@code + * server.address} SHOULD represent the server address behind any intermediaries, for example + * proxies, if it's available. */ public static final AttributeKey SERVER_ADDRESS = stringKey("server.address"); @@ -34,11 +31,9 @@ public final class ServerAttributes { * *

                  Notes: * - *

                    - *
                  • When observed from the client side, and when communicating through an intermediary, - * {@code server.port} SHOULD represent the server port behind any intermediaries, for - * example proxies, if it's available. - *
                  + *

                  When observed from the client side, and when communicating through an intermediary, {@code + * server.port} SHOULD represent the server port behind any intermediaries, for example proxies, + * if it's available. */ public static final AttributeKey SERVER_PORT = longKey("server.port"); diff --git a/semconv/src/main/java/io/opentelemetry/semconv/ServiceAttributes.java b/semconv/src/main/java/io/opentelemetry/semconv/ServiceAttributes.java index 1d71eb1..16bf114 100644 --- a/semconv/src/main/java/io/opentelemetry/semconv/ServiceAttributes.java +++ b/semconv/src/main/java/io/opentelemetry/semconv/ServiceAttributes.java @@ -10,22 +10,19 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/java/SemanticAttributes.java.j2 @SuppressWarnings("unused") public final class ServiceAttributes { - /** * Logical name of the service. * *

                  Notes: * - *

                    - *
                  • MUST be the same for all instances of horizontally scaled services. If the value was not - * specified, SDKs MUST fallback to {@code unknown_service:} concatenated with {@code process.executable.name}, e.g. {@code unknown_service:bash}. - * If {@code process.executable.name} is not available, the value MUST be set to {@code - * unknown_service}. - *
                  + *

                  MUST be the same for all instances of horizontally scaled services. If the value was not + * specified, SDKs MUST fallback to {@code unknown_service:} concatenated with {@code process.executable.name}, e.g. {@code unknown_service:bash}. If + * {@code process.executable.name} is not available, the value MUST be set to {@code + * unknown_service}. */ public static final AttributeKey SERVICE_NAME = stringKey("service.name"); diff --git a/semconv/src/main/java/io/opentelemetry/semconv/TelemetryAttributes.java b/semconv/src/main/java/io/opentelemetry/semconv/TelemetryAttributes.java index 535cdfb..b09e106 100644 --- a/semconv/src/main/java/io/opentelemetry/semconv/TelemetryAttributes.java +++ b/semconv/src/main/java/io/opentelemetry/semconv/TelemetryAttributes.java @@ -10,10 +10,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/java/SemanticAttributes.java.j2 @SuppressWarnings("unused") public final class TelemetryAttributes { - /** The language of the telemetry SDK. */ public static final AttributeKey TELEMETRY_SDK_LANGUAGE = stringKey("telemetry.sdk.language"); @@ -23,15 +22,12 @@ public final class TelemetryAttributes { * *

                  Notes: * - *

                    - *
                  • The OpenTelemetry SDK MUST set the {@code telemetry.sdk.name} attribute to {@code - * opentelemetry}. If another SDK, like a fork or a vendor-provided implementation, is used, - * this SDK MUST set the {@code telemetry.sdk.name} attribute to the fully-qualified class - * or module name of this SDK's main entry point or another suitable identifier depending on - * the language. The identifier {@code opentelemetry} is reserved and MUST NOT be used in - * this case. All custom identifiers SHOULD be stable across different versions of an - * implementation. - *
                  + *

                  The OpenTelemetry SDK MUST set the {@code telemetry.sdk.name} attribute to {@code + * opentelemetry}. If another SDK, like a fork or a vendor-provided implementation, is used, this + * SDK MUST set the {@code telemetry.sdk.name} attribute to the fully-qualified class or module + * name of this SDK's main entry point or another suitable identifier depending on the language. + * The identifier {@code opentelemetry} is reserved and MUST NOT be used in this case. All custom + * identifiers SHOULD be stable across different versions of an implementation. */ public static final AttributeKey TELEMETRY_SDK_NAME = stringKey("telemetry.sdk.name"); @@ -39,7 +35,7 @@ public final class TelemetryAttributes { public static final AttributeKey TELEMETRY_SDK_VERSION = stringKey("telemetry.sdk.version"); - // Enum definitions + // Enum definition /** Values for {@link #TELEMETRY_SDK_LANGUAGE}. */ public static final class TelemetrySdkLanguageValues { /** cpp. */ diff --git a/semconv/src/main/java/io/opentelemetry/semconv/UrlAttributes.java b/semconv/src/main/java/io/opentelemetry/semconv/UrlAttributes.java index c04d5e5..0acf3d3 100644 --- a/semconv/src/main/java/io/opentelemetry/semconv/UrlAttributes.java +++ b/semconv/src/main/java/io/opentelemetry/semconv/UrlAttributes.java @@ -10,10 +10,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/java/SemanticAttributes.java.j2 @SuppressWarnings("unused") public final class UrlAttributes { - /** The URI fragment component */ public static final AttributeKey URL_FRAGMENT = stringKey("url.fragment"); @@ -23,16 +22,14 @@ public final class UrlAttributes { * *

                  Notes: * - *

                    - *
                  • For network calls, URL usually has {@code scheme://host[:port][path][?query][#fragment]} - * format, where the fragment is not transmitted over HTTP, but if it is known, it SHOULD be - * included nevertheless. {@code url.full} MUST NOT contain credentials passed via URL in - * form of {@code https://username:password@www.example.com/}. In such case username and - * password SHOULD be redacted and attribute's value SHOULD be {@code - * https://REDACTED:REDACTED@www.example.com/}. {@code url.full} SHOULD capture the absolute - * URL when it is available (or can be reconstructed). Sensitive content provided in {@code - * url.full} SHOULD be scrubbed when instrumentations can identify it. - *
                  + *

                  For network calls, URL usually has {@code scheme://host[:port][path][?query][#fragment]} + * format, where the fragment is not transmitted over HTTP, but if it is known, it SHOULD be + * included nevertheless. {@code url.full} MUST NOT contain credentials passed via URL in form of + * {@code https://username:password@www.example.com/}. In such case username and password SHOULD + * be redacted and attribute's value SHOULD be {@code https://REDACTED:REDACTED@www.example.com/}. + * {@code url.full} SHOULD capture the absolute URL when it is available (or can be + * reconstructed). Sensitive content provided in {@code url.full} SHOULD be scrubbed when + * instrumentations can identify it. */ public static final AttributeKey URL_FULL = stringKey("url.full"); @@ -41,10 +38,8 @@ public final class UrlAttributes { * *

                  Notes: * - *

                    - *
                  • Sensitive content provided in {@code url.path} SHOULD be scrubbed when instrumentations - * can identify it. - *
                  + *

                  Sensitive content provided in {@code url.path} SHOULD be scrubbed when instrumentations can + * identify it. */ public static final AttributeKey URL_PATH = stringKey("url.path"); @@ -53,10 +48,8 @@ public final class UrlAttributes { * *

                  Notes: * - *

                    - *
                  • Sensitive content provided in {@code url.query} SHOULD be scrubbed when instrumentations - * can identify it. - *
                  + *

                  Sensitive content provided in {@code url.query} SHOULD be scrubbed when instrumentations can + * identify it. */ public static final AttributeKey URL_QUERY = stringKey("url.query"); diff --git a/semconv/src/main/java/io/opentelemetry/semconv/UserAgentAttributes.java b/semconv/src/main/java/io/opentelemetry/semconv/UserAgentAttributes.java index 0bb59ac..fc9a973 100644 --- a/semconv/src/main/java/io/opentelemetry/semconv/UserAgentAttributes.java +++ b/semconv/src/main/java/io/opentelemetry/semconv/UserAgentAttributes.java @@ -10,10 +10,9 @@ import io.opentelemetry.api.common.AttributeKey; // DO NOT EDIT, this is an Auto-generated file from -// buildscripts/templates/SemanticAttributes.java.j2 +// buildscripts/templates/registry/java/SemanticAttributes.java.j2 @SuppressWarnings("unused") public final class UserAgentAttributes { - /** * Value of the HTTP * User-Agent header sent by the client.