E5FD Handle mix of stable and unstable enum values by trask · Pull Request #220 · open-telemetry/semantic-conventions-java · GitHub
[go: up one dir, main page]

Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,19 @@ public final class {{ my_class_name }} {
{% endif %}
{% endfor %}
// Enum definitions
{% for attribute in ctx.attributes | select("enum") | rejectattr("name", "in", ctx.excluded_attributes) %}
{%- if attribute is stable -%}
{% for attribute in ctx.attributes | select("enum") | rejectattr("name", "in", ctx.excluded_attributes) %}
{% set enum_deprecated_in_favor_of_stable = namespace(value=false) %}
{% if attribute is stable %}
{%- set enum_deprecated_in_favor_of_stable.value = true -%}
{%- endif -%}
{%- for member in attribute.type.members %}
{% if member is experimental %}
{% if not member is deprecated %}
{%- set enum_deprecated_in_favor_of_stable.value = false -%}
{%- endif -%}
{%- endif -%}
{%- endfor %}
{%- if enum_deprecated_in_favor_of_stable.value -%}
{%- set stable_class_link = "io.opentelemetry.semconv." ~ stable_class_name ~ "." ~ (attribute.name | pascal_case) ~ "Values" -%}
/**
* Values for {@link #{{ attribute.name | screaming_snake_case }}}.
Expand All @@ -62,11 +73,16 @@ public final class {{ my_class_name }} {
{%- else -%}
/** Values for {@link #{{ attribute.name | screaming_snake_case }}}. */
{%- endif -%}
{% if attribute is stable or attribute is deprecated %}@Deprecated{% endif %}
{% if enum_deprecated_in_favor_of_stable.value or attribute is deprecated %}@Deprecated{% endif %}
public static final class {{ attribute.name | pascal_case }}IncubatingValues {
{%- 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 }};
{% if member is experimental or enum_deprecated_in_favor_of_stable.value %}{{ [member.brief or (member.id ~ '.')] | comment(indent=4) }}
{% if member is deprecated %}@Deprecated{% endif %} public static final {{ attribute.type | instantiated_type | map_text("java_enum_type") }} {{ member.id | screaming_snake_case }} = {{ member.value | print_member_value }};
{% elif member is stable %}
{%- set stable_class_link = "io.opentelemetry.semconv." ~ stable_class_name ~ "." ~ (attribute.name | pascal_case) ~ "Values#" ~ (member.id | screaming_snake_case) -%}
{{ [member.brief or (member.id ~ '.'), "@deprecated deprecated in favor of stable {@link " ~ stable_class_link ~ "} value."] | comment(indent=4) }}
@Deprecated public static final {{ attribute.type | instantiated_type | map_text("java_enum_type") }} {{ member.id | screaming_snake_case }} = {{ member.value | print_member_value }};
{%- endif -%}
{%- endfor %}
private {{ attribute.name | pascal_case }}IncubatingValues() {}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,10 @@ public final class {{ my_class_name }} {
/** Values for {@link #{{ attribute.name | screaming_snake_case }}}. */
public static final class {{ attribute.name | pascal_case }}Values {
{%- for member in attribute.type.members %}
{% if member is stable %}
{{ [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 }};
{%- endif -%}
{%- endfor %}
private {{ attribute.name | pascal_case }}Values() {}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ public final class AndroidIncubatingAttributes {
@Deprecated public static final AttributeKey<String> ANDROID_STATE = stringKey("android.state");

// Enum definitions

/** Values for {@link #ANDROID_APP_STATE}. */
public static final class AndroidAppStateIncubatingValues {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -342,6 +342,7 @@ public final class AwsIncubatingAttributes {
public static final AttributeKey<String> AWS_S3_UPLOAD_ID = stringKey("aws.s3.upload_id");

// Enum definitions

/** Values for {@link #AWS_ECS_LAUNCHTYPE}. */
public static final class AwsEcsLaunchtypeIncubatingValues {
/** ec2. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ public final class AzureIncubatingAttributes {
longKey("azure.cosmosdb.response.sub_status_code");

// Enum definitions

/** Values for {@link #AZURE_COSMOSDB_CONNECTION_MODE}. */
public static final class AzureCosmosdbConnectionModeIncubatingValues {
/** Gateway (HTTP) connection. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ public final class CassandraIncubatingAttributes {
longKey("cassandra.speculative_execution.count");

// Enum definitions

/** Values for {@link #CASSANDRA_CONSISTENCY_LEVEL}. */
public static final class CassandraConsistencyLevelIncubatingValues {
/** all. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ public final class CicdIncubatingAttributes {
public static final AttributeKey<String> CICD_WORKER_STATE = stringKey("cicd.worker.state");

// Enum definitions

/** Values for {@link #CICD_PIPELINE_RESULT}. */
public static final class CicdPipelineResultIncubatingValues {
/** The pipeline run finished successfully. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ public final class CloudIncubatingAttributes {
public static final AttributeKey<String> CLOUD_RESOURCE_ID = stringKey("cloud.resource_id");

// Enum definitions

/** Values for {@link #CLOUD_PLATFORM}. */
public static final class Clo 33D9 udPlatformIncubatingValues {
/** Alibaba Cloud Elastic Compute Service */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ public final class ContainerIncubatingAttributes {
public static final AttributeKey<String> CONTAINER_RUNTIME = stringKey("container.runtime");

// Enum definitions

/**
* Values for {@link #CONTAINER_CPU_STATE}
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ public final class CpuIncubatingAttributes {
public static final AttributeKey<String> CPU_MODE = stringKey("cpu.mode");

// Enum definitions

/** Values for {@link #CPU_MODE}. */
public static final class CpuModeIncubatingValues {
/** user. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ public final class CpythonIncubatingAttributes {
public static final AttributeKey<Long> CPYTHON_GC_GENERATION = longKey("cpython.gc.generation");

// Enum definitions

/** Values for {@link #CPYTHON_GC_GENERATION}. */
public static final class CpythonGcGenerationIncubatingValues {
/** Generation 0 */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -491,6 +491,7 @@ public final class DbIncubatingAttributes {
@Deprecated public static final AttributeKey<String> DB_USER = stringKey("db.user");

// Enum definitions

/**
* Values for {@link #DB_CASSANDRA_CONSISTENCY_LEVEL}
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ public final class DeploymentIncubatingAttributes {
public static final AttributeKey<String> DEPLOYMENT_STATUS = stringKey("deployment.status");

// Enum definitions

/** Values for {@link #DEPLOYMENT_STATUS}. */
public static final class DeploymentStatusIncubatingValues {
/** failed */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ public final class DiskIncubatingAttributes {
public static final AttributeKey<String> DISK_IO_DIRECTION = stringKey("disk.io.direction");

// Enum definitions

/** Values for {@link #DISK_IO_DIRECTION}. */
public static final class DiskIoDirectionIncubatingValues {
/** read. */
Expand Down
D9D3
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ public final class ErrorIncubatingAttributes {
@Deprecated public static final AttributeKey<String> ERROR_TYPE = stringKey("error.type");

// Enum definitions

/**
* Values for {@link #ERROR_TYPE}.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ public final class FaasIncubatingAttributes {
public static final AttributeKey<String> FAAS_VERSION = stringKey("faas.version");

// Enum definitions

/** Values for {@link #FAAS_DOCUMENT_OPERATION}. */
public static final class FaasDocumentOperationIncubatingValues {
/** When a new object is created. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ public final class FeatureFlagIncubatingAttributes {
public static final AttributeKey<String> FEATURE_FLAG_VERSION = stringKey("feature_flag.version");

// Enum definitions

/**
* Values for {@link #FEATURE_FLAG_EVALUATION_REASON}
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ public final class GcpIncubatingAttributes {
stringKey("gcp.gce.instance.name");

// Enum definitions

/** Values for {@link #GCP_APPHUB_SERVICE_CRITICALITY_TYPE}. */
public static final class GcpApphubServiceCriticalityTypeIncubatingValues {
/** Mission critical service. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,7 @@ public final class GenAiIncubatingAttributes {
longKey("gen_ai.usage.prompt_tokens");

// Enum definitions

/**
* Values for {@link #GEN_AI_OPENAI_REQUEST_RESPONSE_FORMAT}
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ public final class GeoIncubatingAttributes {
public static final AttributeKey<String> GEO_REGION_ISO_CODE = stringKey("geo.region.iso_code");

// Enum definitions

/** Values for {@link #GEO_CONTINENT_CODE}. */
public static final class GeoContinentCodeIncubatingValues {
/** Africa */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ public final class GoIncubatingAttributes {
public static final AttributeKey<String> GO_MEMORY_TYPE = stringKey("go.memory.type");

// Enum definitions

/** Values for {@link #GO_MEMORY_TYPE}. */
public static final class GoMemoryTypeIncubatingValues {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ public final class GraphqlIncubatingAttributes {
stringKey("graphql.operation.type");

// Enum definitions

/** Values for {@link #GRAPHQL_OPERATION_TYPE}. */
public static final class GraphqlOperationTypeIncubatingValues {
/** GraphQL query */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ public final class HostIncubatingAttributes {
public static final AttributeKey<String> HOST_TYPE = stringKey("host.type");

// Enum definitions

/** Values for {@link #HOST_ARCH}. */
public static final class HostArchIncubatingValues {
/** AMD64 */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,7 @@ public final class HttpIncubatingAttributes {
public static final AttributeKey<String> HTTP_USER_AGENT = stringKey("http.user_agent");

// Enum definitions

/** Values for {@link #HTTP_CONNECTION_STATE}. */
public static final class HttpConnectionStateIncubatingValues {
/** active state. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ public final class HwIncubatingAttributes {
public static final AttributeKey<String> HW_TYPE = stringKey("hw.type");

// Enum definitions

/** Values for {@link #HW_STATE}. */
public static final class HwStateIncubatingValues {
/** Ok */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ public final class JvmIncubatingAttributes {
public static final AttributeKey<String> JVM_THREAD_STATE = stringKey("jvm.thread.state");

// Enum definitions

/**
* Values for {@link #JVM_MEMORY_TYPE}.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ public final class K8sIncubatingAttributes {
public static final AttributeKey<String> K8S_VOLUME_TYPE = stringKey("k8s.volume.type");

// Enum definitions

/** Values for {@link #K8S_NAMESPACE_PHASE}. */
public static final class K8sNamespacePhaseIncubatingValues {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ public final class LinuxIncubatingAttributes {
stringKey("linux.memory.slab.state");

// Enum definitions

/** Values for {@link #LINUX_MEMORY_SLAB_STATE}. */
public static final class LinuxMemorySlabStateIncubatingValues {
/** reclaimable. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ public final class LogIncubatingAttributes {
public static final AttributeKey<String> LOG_RECORD_UID = stringKey("log.record.uid");

// Enum definitions

/** Values for {@link #LOG_IOSTREAM}. */
public static final class LogIostreamIncubatingValues {
/** Logs from stdout stream */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ public final class MessageIncubatingAttributes {
longKey("message.uncompressed_size");

// Enum definitions

/**
* Values for {@link #MESSAGE_TYPE}
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,7 @@ public final class MessagingIncubatingAttributes {
public static final AttributeKey<String> MESSAGING_SYSTEM = stringKey("messaging.system");

// Enum definitions

/** Values for {@link #MESSAGING_OPERATION_TYPE}. */
public static final class MessagingOperationTypeIncubatingValues {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ public final class NetIncubatingAttributes {
@Deprecated public static final AttributeKey<String> NET_TRANSPORT = stringKey("net.transport");

// Enum definitions

/**
* Values for {@link #NET_SOCK_FAMILY}
*
Expand Down
< 59B3 tr data-hunk="0b7f2d5bec333b4ee1912b4b0da8ed21426dd2677b069a8d50404aef859e98bd" class="show-top-border">
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,7 @@ public final class NetworkIncubatingAttributes {
@Deprecated public static final AttributeKey<String> NETWORK_TYPE = stringKey("network.type");

// Enum definitions

/** Values for {@link #NETWORK_CONNECTION_STATE}. */
public static final class NetworkConnectionStateIncubatingValues {
/** closed. */
Expand Down Expand Up @@ -293,25 +294,39 @@ public static final class NetworkIoDirectionIncubatingValues {
private NetworkIoDirectionIncubatingValues() {}
}

/**
* Values for {@link #NETWORK_TRANSPORT}.
*
* @deprecated deprecated in favor of stable {@link
* io.opentelemetry.semconv.NetworkAttributes.NetworkTransportValues}.
*/
@Deprecated
/** Values for {@link #NETWORK_TRANSPORT}. */
public static final class NetworkTransportIncubatingValues {
/** TCP */
public static final String TCP = "tcp";

/** UDP */
public static final String UDP = "udp";

/** Named or anonymous pipe. */
public static final String PIPE = "pipe";

/** Unix domain socket */
public static final String UNIX = "unix";
/**
* TCP
*
* @deprecated deprecated in favor of stable {@link
* io.opentelemetry.semconv.NetworkAttributes.NetworkTransportValues#TCP} value.
*/
@Deprecated public static final String TCP = "tcp";

/**
* UDP
*
* @deprecated deprecated in favor of stable {@link
* io.opentelemetry.semconv.NetworkAttributes.NetworkTransportValues#UDP} value.
*/
@Deprecated public static final String UDP = "udp";

/**
* Named or anonymous pipe.
*
* @deprecated deprecated in favor of stable {@link
* io.opentelemetry.semconv.NetworkAttributes.NetworkTransportValues#PIPE} value.
*/
@Deprecated public static final String PIPE = "pipe";

/**
* Unix domain socket
*
* @deprecated deprecated in favor of stable {@link
* io.opentelemetry.semconv.NetworkAttributes.NetworkTransportValues#UNIX} value.
*/
@Deprecated public static final String UNIX = "unix";

/** QUIC */
public static final String QUIC = "quic";
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ public final class NodejsIncubatingAttributes {
stringKey("nodejs.eventloop.state");

// Enum definitions

/** Values for {@link #NODEJS_EVENTLOOP_STATE}. */
public static final class NodejsEventloopStateIncubatingValues {
/** Active time. */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ public final class OpentracingIncubatingAttributes {
public static final AttributeKey<String> OPENTRACING_REF_TYPE = stringKey("opentracing.ref_type");

// Enum definitions

/** Values for {@link #OPENTRACING_REF_TYPE}. */
public static final class OpentracingRefTypeIncubatingValues {
/** The parent Span depends on the child Span in some capacity */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ public final class OsIncubatingAttributes {
public static final AttributeKey<String> OS_VERSION = stringKey("os.version");

// Enum definitions

/** Values for {@link #OS_TYPE}. */
public static final class OsTypeIncubatingValues {
/** Microsoft Windows */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ public final class OtelIncubatingAttributes {
stringKey("otel.status_description");

// Enum definitions

/** Values for {@link #OTEL_COMPONENT_TYPE}. */
public static final class OtelComponentTypeIncubatingValues {
/** The builtin SDK Batching Span Processor */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ public final class OtherIncubatingAttributes {
@Deprecated public static final AttributeKey<String> STATE = stringKey("state");

// Enum definitions

/**
* Values for {@link #STATE}
*
Expand Down
Loading
Loading
0