Warn against using allow_custom_values (#514)

* warn against using allow_custom_values * changelog * remove prefix debug
open-telemetry · Dec 9, 2024 · 0ecdee2 · 0ecdee2
1 parent 9769b3a
commit 0ecdee2
Show file tree

Hide file tree

Showing 47 changed files with 1,423 additions and 563 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,7 @@ What's changed
   * `experimental` is still accepted when parsing but aliased to `development`.
   * The minijinja test, `experimental`, now returns true for any variant other than `stable`.
   * EBNF and JSON schema updated to define the new enum without the `experimental` variant.
+* Issue [#301](https://github.com/open-telemetry/weaver/issues/301) - Warn against usage of `allow_custom_values`. ([#514](https://github.com/open-telemetry/weaver/pull/514) by @jerbly).
 
 ## [0.11.0] - 2024-12-05
 

diff --git a/crates/weaver_forge/data/jvm-metrics.yaml b/crates/weaver_forge/data/jvm-metrics.yaml
@@ -6,7 +6,6 @@ groups:
       - id: jvm.memory.type
         stability: stable
         type:
-          allow_custom_values: false
           members:
             - id: heap
               value: 'heap'
@@ -106,7 +105,6 @@ groups:
         stability: stable
         requirement_level: recommended
         type:
-          allow_custom_values: false
           members:
             - id: new
               value: 'new'

diff --git a/crates/weaver_forge/data/registry-db.yaml b/crates/weaver_forge/data/registry-db.yaml
@@ -87,7 +87,6 @@ groups:
         tag: tech-specific-cosmosdb
       - id: db.cosmosdb.connection_mode
         type:
-          allow_custom_values: false
           members:
             - id: gateway
               value: 'gateway'
@@ -104,7 +103,6 @@ groups:
         tag: tech-specific-cosmosdb
       - id: db.cosmosdb.operation_type
         type:
-          allow_custom_values: true
           members:
             - id: invalid
               value: 'Invalid'
@@ -256,7 +254,6 @@ groups:
       - id: db.system
         brief: An identifier for the database management system (DBMS) product being used. See below for a list of well-known identifiers.
         type:
-          allow_custom_values: true
           members:
             - id: other_sql
               value: 'other_sql'

diff --git a/crates/weaver_forge/data/registry-http.yaml b/crates/weaver_forge/data/registry-http.yaml
@@ -30,7 +30,6 @@ groups:
       - id: http.request.method
         stability: stable
         type:
-          allow_custom_values: true
           members:
             - id: connect
               value: "CONNECT"

diff --git a/crates/weaver_forge/data/registry-network.yaml b/crates/weaver_forge/data/registry-network.yaml
@@ -22,7 +22,6 @@ groups:
         examples: "sprint"
       - id: network.connection.subtype
         type:
-          allow_custom_values: true
           members:
             - id: gprs
               brief: GPRS
@@ -91,7 +90,6 @@ groups:
         examples: 'LTE'
       - id: network.connection.type
         type:
-          allow_custom_values: true
           members:
             - id: wifi
               value: "wifi"
@@ -143,7 +141,6 @@ groups:
       - id: network.transport
         stability: stable
         type:
-          allow_custom_values: true
           members:
             - id: tcp
               value: 'tcp'
@@ -170,7 +167,6 @@ groups:
       - id: network.type
         stability: stable
         type:
-          allow_custom_values: true
           members:
             - id: ipv4
               value: 'ipv4'
@@ -183,7 +179,6 @@ groups:
         examples: ['ipv4', 'ipv6']
       - id: network.io.direction
         type:
-          allow_custom_values: false
           members:
             - id: transmit
               value: 'transmit'

diff --git a/crates/weaver_forge/expected_output/semconv_jq_fn/semconv_attributes.json b/crates/weaver_forge/expected_output/semconv_jq_fn/semconv_attributes.json
diff --git a/crates/weaver_forge/expected_output/semconv_jq_fn/semconv_grouped_attributes.json b/crates/weaver_forge/expected_output/semconv_jq_fn/semconv_grouped_attributes.json
diff --git a/..._forge/expected_output/semconv_jq_fn/semconv_grouped_attributes_without_experimental.json b/..._forge/expected_output/semconv_jq_fn/semconv_grouped_attributes_without_experimental.json
diff --git a/crates/weaver_forge/expected_output/semconv_jq_fn/semconv_metrics.json b/crates/weaver_forge/expected_output/semconv_jq_fn/semconv_metrics.json
diff --git a/crates/weaver_forge/src/extensions/otel.rs b/crates/weaver_forge/src/extensions/otel.rs
@@ -1382,7 +1382,7 @@ mod tests {
             .collect();
 
         AttributeType::Enum {
-            allow_custom_values: true,
+            allow_custom_values: Some(true),
             members,
         }
     }

diff --git a/...eaver_resolver/data/registry-test-10-duplicate-attr-name/registry/registry-messaging.yaml b/...eaver_resolver/data/registry-test-10-duplicate-attr-name/registry/registry-messaging.yaml
@@ -118,7 +118,6 @@ groups:
         examples: 1439
       - id: messaging.operation
         type:
-          allow_custom_values: true
           members:
             - id: publish
               value: "publish"
@@ -155,7 +154,6 @@ groups:
         examples: "myConsumerGroup"
       - id: messaging.rocketmq.consumption_model
         type:
-          allow_custom_values: false
           members:
             - id: clustering
               value: "clustering"
@@ -192,7 +190,6 @@ groups:
         examples: tagA
       - id: messaging.rocketmq.message.type
         type:
-          allow_custom_values: false
           members:
             - id: normal
               value: "normal"
@@ -222,7 +219,6 @@ groups:
         brief: >
           An identifier for the messaging system being used. See below for a list of well-known identifiers.
         type:
-          allow_custom_values: true
           members:
             - id: activemq
               value: "activemq"

diff --git a/...weaver_resolver/data/registry-test-12-duplicate-group-id/registry/registry-messaging.yaml b/...weaver_resolver/data/registry-test-12-duplicate-group-id/registry/registry-messaging.yaml
@@ -118,7 +118,6 @@ groups:
         examples: 1439
       - id: operation
         type:
-          allow_custom_values: true
           members:
             - id: publish
               value: "publish"
@@ -155,7 +154,6 @@ groups:
         examples: "myConsumerGroup"
       - id: rocketmq.consumption_model
         type:
-          allow_custom_values: false
           members:
             - id: clustering
               value: "clustering"
@@ -192,7 +190,6 @@ groups:
         examples: tagA
       - id: rocketmq.message.type
         type:
-          allow_custom_values: false
           members:
             - id: normal
               value: "normal"
@@ -222,7 +219,6 @@ groups:
         brief: >
           An identifier for the messaging system being used. See below for a list of well-known identifiers.
         type:
-          allow_custom_values: true
           members:
             - id: activemq
               value: "activemq"

diff --git a/crates/weaver_resolver/data/registry-test-13-duplicate-metric-name/registry/faas-common.yaml b/crates/weaver_resolver/data/registry-test-13-duplicate-metric-name/registry/faas-common.yaml
@@ -6,7 +6,6 @@ groups:
       - id: faas.trigger
         brief: 'Type of the trigger which caused this function invocation.'
         type:
-          allow_custom_values: false
           members:
             - id: datasource
               value: 'datasource'
@@ -34,7 +33,6 @@ groups:
         examples: 'my-function'
       - id: faas.invoked_provider
         type:
-          allow_custom_values: true
           members:
             - id: 'alibaba_cloud'
               value: 'alibaba_cloud'