Skip to content

Generate stable metric constants #506

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jack-berg wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Generate stable metric constants #506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 1 addition & 7 deletions buildscripts/templates/registry/incubating_java/IncubatingSemanticMetrics.java.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
{%- set my_class_name = ctx.root_namespace | pascal_case ~ "IncubatingMetrics" -%}
{# Uncomment when stable metric constants are enabled in buildscripts/templates/registry/java/weaver.yaml:
{%- set stable_class_name = ctx.root_namespace | pascal_case ~ "Metrics" -%}
#}

/*
* Copyright The OpenTelemetry Authors
Expand All @@ -13,9 +11,7 @@ package io.opentelemetry.semconv.incubating;
@SuppressWarnings("unused")
public final class {{ my_class_name }} {
{%- for metric in ctx.metrics -%}
{# When stable metric constants are enabled, change `metric is experimental or metric is stable`
to `metric is experimental` and uncomment the elif block below. #}
{%- if metric is experimental or metric is stable -%}
{%- if metric is experimental -%}
{%- if metric is deprecated -%}
{%- if metric.deprecated.note == "Uncategorized." -%}
{%- set deprecated_javadoc = "@deprecated" -%}
Expand All @@ -40,7 +36,6 @@ public final class {{ my_class_name }} {
@Deprecated
{% endif %}
public static final String {{ metric.metric_name | replace(".", "_") | screaming_snake_case }}_DESCRIPTION = "{{ metric.brief | replace('\n', ' ') | replace('"', '\\"') }}";
{# Uncomment when stable metric constants are enabled in buildscripts/templates/registry/java/weaver.yaml:
{%- elif metric is stable -%}
{%- set field_prefix = metric.metric_name | replace(".", "_") | screaming_snake_case -%}
{%- set stable_link = "io.opentelemetry.semconv." ~ stable_class_name ~ "#" -%}
Expand All @@ -50,7 +45,6 @@ public final class {{ my_class_name }} {
@Deprecated public static final String {{ field_prefix }}_UNIT = "{{ metric.unit }}";
{{ ["Description of the {@code " ~ metric.metric_name ~ "} metric.", "@deprecated deprecated in favor of stable {@link " ~ stable_link ~ field_prefix ~ "_DESCRIPTION} constant."] | comment }}
@Deprecated public static final String {{ field_prefix }}_DESCRIPTION = "{{ metric.brief | replace('\n', ' ') | replace('"', '\\"') }}";
#}
{%- endif %}
{%- endfor %}

Expand Down
22 changes: 11 additions & 11 deletions buildscripts/templates/registry/java/weaver.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,17 @@ templates:
})
application_mode: each
file_name: "{{ctx.root_namespace | pascal_case}}Attributes.java"
# - pattern: SemanticMetrics.java.j2
# filter: >
# semconv_grouped_metrics({
# "exclude_root_namespace": $excluded_namespaces,
# "exclude_stability": ["experimental", "deprecated"]
# }) | map({
# root_namespace: .root_namespace,
# metrics: .metrics
# })
# application_mode: each
# file_name: "{{ctx.root_namespace | pascal_case}}Metrics.java"
- pattern: SemanticMetrics.java.j2
filter: >
semconv_grouped_metrics({
"exclude_root_namespace": $excluded_namespaces,
"exclude_stability": ["experimental", "deprecated"]
}) | map({
root_namespace: .root_namespace,
metrics: .metrics
})
application_mode: each
file_name: "{{ctx.root_namespace | pascal_case}}Metrics.java"
text_maps:
java_enum_type:
int: long
Expand Down
82 changes: 81 additions & 1 deletion docs/apidiffs/current_vs_latest/opentelemetry-semconv.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,82 @@
Comparing source compatibility of opentelemetry-semconv-1.42.0-SNAPSHOT.jar against opentelemetry-semconv-1.42.0.jar
No changes.
+++ NEW CLASS: PUBLIC(+) FINAL(+) io.opentelemetry.semconv.DbMetrics (not serializable)
+++ CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+++ NEW SUPERCLASS: java.lang.Object
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String DB_CLIENT_OPERATION_DURATION_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String DB_CLIENT_OPERATION_DURATION_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String DB_CLIENT_OPERATION_DURATION_DESCRIPTION
+++ NEW CLASS: PUBLIC(+) FINAL(+) io.opentelemetry.semconv.HttpMetrics (not serializable)
+++ CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+++ NEW SUPERCLASS: java.lang.Object
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String HTTP_CLIENT_REQUEST_DURATION_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String HTTP_SERVER_REQUEST_DURATION_DESCRIPTION
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String HTTP_SERVER_REQUEST_DURATION_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String HTTP_CLIENT_REQUEST_DURATION_DESCRIPTION
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String HTTP_SERVER_REQUEST_DURATION_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String HTTP_CLIENT_REQUEST_DURATION_UNIT
+++ NEW CLASS: PUBLIC(+) FINAL(+) io.opentelemetry.semconv.JvmMetrics (not serializable)
+++ CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+++ NEW SUPERCLASS: java.lang.Object
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_CLASS_UNLOADED_DESCRIPTION
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_MEMORY_USED_AFTER_LAST_GC_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_CLASS_UNLOADED_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_GC_DURATION_DESCRIPTION
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_MEMORY_USED_AFTER_LAST_GC_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_CLASS_LOADED_DESCRIPTION
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_GC_DURATION_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_CLASS_UNLOADED_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_CPU_RECENT_UTILIZATION_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_CLASS_LOADED_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_CPU_RECENT_UTILIZATION_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_CLASS_COUNT_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_MEMORY_USED_AFTER_LAST_GC_DESCRIPTION
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_MEMORY_LIMIT_DESCRIPTION
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_THREAD_COUNT_DESCRIPTION
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_CLASS_LOADED_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_THREAD_COUNT_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_CLASS_COUNT_DESCRIPTION
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_MEMORY_COMMITTED_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_CLASS_COUNT_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_CPU_COUNT_DESCRIPTION
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_CPU_TIME_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_CPU_COUNT_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_GC_DURATION_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_CPU_TIME_DESCRIPTION
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_MEMORY_COMMITTED_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_CPU_TIME_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_MEMORY_COMMITTED_DESCRIPTION
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_CPU_COUNT_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_MEMORY_USED_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_CPU_RECENT_UTILIZATION_DESCRIPTION
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_MEMORY_USED_DESCRIPTION
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_THREAD_COUNT_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_MEMORY_LIMIT_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_MEMORY_LIMIT_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String JVM_MEMORY_USED_NAME
+++ NEW CLASS: PUBLIC(+) FINAL(+) io.opentelemetry.semconv.KestrelMetrics (not serializable)
+++ CLASS FILE FORMAT VERSION: 52.0 <- n.a.
+++ NEW SUPERCLASS: java.lang.Object
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_ACTIVE_TLS_HANDSHAKES_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_TLS_HANDSHAKE_DURATION_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_QUEUED_REQUESTS_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_UPGRADED_CONNECTIONS_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_ACTIVE_CONNECTIONS_DESCRIPTION
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_ACTIVE_TLS_HANDSHAKES_DESCRIPTION
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_CONNECTION_DURATION_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_QUEUED_CONNECTIONS_DESCRIPTION
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_UPGRADED_CONNECTIONS_DESCRIPTION
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_QUEUED_REQUESTS_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_UPGRADED_CONNECTIONS_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_REJECTED_CONNECTIONS_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_QUEUED_CONNECTIONS_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_TLS_HANDSHAKE_DURATION_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_REJECTED_CONNECTIONS_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_QUEUED_CONNECTIONS_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_ACTIVE_TLS_HANDSHAKES_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_CONNECTION_DURATION_DESCRIPTION
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_CONNECTION_DURATION_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_ACTIVE_CONNECTIONS_NAME
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_QUEUED_REQUESTS_DESCRIPTION
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_TLS_HANDSHAKE_DURATION_DESCRIPTION
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_ACTIVE_CONNECTIONS_UNIT
+++ NEW FIELD: PUBLIC(+) STATIC(+) FINAL(+) java.lang.String KESTREL_REJECTED_CONNECTIONS_DESCRIPTION
25 changes: 21 additions & 4 deletions ...onv-incubating/src/main/java/io/opentelemetry/semconv/incubating/DbIncubatingMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -372,13 +372,30 @@ public final class DbIncubatingMetrics {
public static final String DB_CLIENT_COSMOSDB_OPERATION_REQUEST_CHARGE_DESCRIPTION =
"Deprecated, use `azure.cosmosdb.client.operation.request_charge` instead.";

/** Name of the {@code db.client.operation.duration} metric. */
/**
* Name of the {@code db.client.operation.duration} metric.
*
* @deprecated deprecated in favor of stable {@link
* io.opentelemetry.semconv.DbMetrics#DB_CLIENT_OPERATION_DURATION_NAME} constant.
*/
@Deprecated
public static final String DB_CLIENT_OPERATION_DURATION_NAME = "db.client.operation.duration";

/** Unit of the {@code db.client.operation.duration} metric. */
public static final String DB_CLIENT_OPERATION_DURATION_UNIT = "s";
/**
* Unit of the {@code db.client.operation.duration} metric.
*
* @deprecated deprecated in favor of stable {@link
* io.opentelemetry.semconv.DbMetrics#DB_CLIENT_OPERATION_DURATION_UNIT} constant.
*/
@Deprecated public static final String DB_CLIENT_OPERATION_DURATION_UNIT = "s";

/** Description of the {@code db.client.operation.duration} metric. */
/**
* Description of the {@code db.client.operation.duration} metric.
*
* @deprecated deprecated in favor of stable {@link
* io.opentelemetry.semconv.DbMetrics#DB_CLIENT_OPERATION_DURATION_DESCRIPTION} constant.
*/
@Deprecated
public static final String DB_CLIENT_OPERATION_DURATION_DESCRIPTION =
"Duration of database client operations.";

Expand Down
54 changes: 44 additions & 10 deletions ...v-incubating/src/main/java/io/opentelemetry/semconv/incubating/HttpIncubatingMetrics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,30 @@ public final class HttpIncubatingMetrics {
public static final String HTTP_CLIENT_REQUEST_BODY_SIZE_DESCRIPTION =
"Size of HTTP client request bodies.";

/** Name of the {@code http.client.request.duration} metric. */
/**
* Name of the {@code http.client.request.duration} metric.
*
* @deprecated deprecated in favor of stable {@link
* io.opentelemetry.semconv.HttpMetrics#HTTP_CLIENT_REQUEST_DURATION_NAME} constant.
*/
@Deprecated
public static final String HTTP_CLIENT_REQUEST_DURATION_NAME = "http.client.request.duration";

/** Unit of the {@code http.client.request.duration} metric. */
public static final String HTTP_CLIENT_REQUEST_DURATION_UNIT = "s";

/** Description of the {@code http.client.request.duration} metric. */
/**
* Unit of the {@code http.client.request.duration} metric.
*
* @deprecated deprecated in favor of stable {@link
* io.opentelemetry.semconv.HttpMetrics#HTTP_CLIENT_REQUEST_DURATION_UNIT} constant.
*/
@Deprecated public static final String HTTP_CLIENT_REQUEST_DURATION_UNIT = "s";

/**
* Description of the {@code http.client.request.duration} metric.
*
* @deprecated deprecated in favor of stable {@link
* io.opentelemetry.semconv.HttpMetrics#HTTP_CLIENT_REQUEST_DURATION_DESCRIPTION} constant.
*/
@Deprecated
public static final String HTTP_CLIENT_REQUEST_DURATION_DESCRIPTION =
"Duration of HTTP client requests.";

Expand Down Expand Up @@ -90,13 +107,30 @@ public final class HttpIncubatingMetrics {
public static final String HTTP_SERVER_REQUEST_BODY_SIZE_DESCRIPTION =
"Size of HTTP server request bodies.";

/** Name of the {@code http.server.request.duration} metric. */
/**
* Name of the {@code http.server.request.duration} metric.
*
* @deprecated deprecated in favor of stable {@link
* io.opentelemetry.semconv.HttpMetrics#HTTP_SERVER_REQUEST_DURATION_NAME} constant.
*/
@Deprecated
public static final String HTTP_SERVER_REQUEST_DURATION_NAME = "http.server.request.duration";

/** Unit of the {@code http.server.request.duration} metric. */
public static final String HTTP_SERVER_REQUEST_DURATION_UNIT = "s";

/** Description of the {@code http.server.request.duration} metric. */
/**
* Unit of the {@code http.server.request.duration} metric.
*
* @deprecated deprecated in favor of stable {@link
* io.opentelemetry.semconv.HttpMetrics#HTTP_SERVER_REQUEST_DURATION_UNIT} constant.
*/
@Deprecated public static final String HTTP_SERVER_REQUEST_DURATION_UNIT = "s";

/**
* Description of the {@code http.server.request.duration} metric.
*
* @deprecated deprecated in favor of stable {@link
* io.opentelemetry.semconv.HttpMetrics#HTTP_SERVER_REQUEST_DURATION_DESCRIPTION} constant.
*/
@Deprecated
public static final String HTTP_SERVER_REQUEST_DURATION_DESCRIPTION =
"Duration of HTTP server requests.";

Expand Down
Loading
Loading