Remove unused Units, Scope, and MetricGroup conventions (#309)

semantic-conventions/CHANGELOG.md

@@ -4,7 +4,10 @@ Please update the changelog as part of any significant pull request.
 
 ## Unreleased
 
-## 0.24.0
+- BREAKING: Remove unused semantic convention types: `UnitSemanticConvention`, `MetricGroupSemanticConvention` and `ScopeSemanticConvention`
+  ([#309](https://github.com/open-telemetry/build-tools/pull/309))
+
+## v0.24.0
 
 - BREAKING: Add `stability` (required) and `deprecated` (optional) properties to `EnumMember`
   ([#267](https://github.com/open-telemetry/build-tools/pull/267))

semantic-conventions/semconv.schema.json

@@ -54,9 +54,7 @@
 						"span",
 						"resource",
 						"metric",
-						"metric_group",
 						"event",
-						"scope",
 						"attribute_group"
 					],
 					"description": "The (signal) type of the semantic convention"
@@ -173,16 +171,6 @@
 				{"required": ["name"]}
 			]
 		},
-		"MetricGroupSemanticConvention": {
-			"allOf": [{ "$ref": "#/definitions/SemanticConventionBase" }],
-			"required": ["type"],
-			"properties": {
-				"type": {
-					"type": "string",
-					"const": "metric_group"
-				}
-			}
-		},
 		"MetricSemanticConvention": {
 			"allOf": [{ "$ref": "#/definitions/SemanticConventionBase" }],
 			"required": [

semantic-conventions/src/opentelemetry/semconv/model/semantic_convention.py

@@ -27,7 +27,6 @@
     RequirementLevel,
     SemanticAttribute,
 )
-from opentelemetry.semconv.model.unit_member import UnitMember
 from opentelemetry.semconv.model.utils import (
     ValidatableYamlNode,
     ValidationContext,
@@ -199,10 +198,6 @@ class ResourceSemanticConvention(BaseSemanticConvention):
     GROUP_TYPE_NAME = "resource"
 
 
-class ScopeSemanticConvention(BaseSemanticConvention):
-    GROUP_TYPE_NAME = "scope"
-
-
 class AttributeGroupConvention(BaseSemanticConvention):
     GROUP_TYPE_NAME = "attribute_group"
 
@@ -240,26 +235,7 @@ def __init__(self, group, validation_ctx):
             )
 
 
-class UnitSemanticConvention(BaseSemanticConvention):
-    GROUP_TYPE_NAME = "units"
-
-    allowed_keys = (  # We completely override base semantic keys here.
-        "id",
-        "type",
-        "brief",
-        "members",
-    )
-
-    def __init__(self, group, validation_ctx):
-        super().__init__(group, validation_ctx)
-        self.members = UnitMember.parse(group.get("members"), validation_ctx)
-
-
-class MetricGroupSemanticConvention(BaseSemanticConvention):
-    GROUP_TYPE_NAME = "metric_group"
-
-
-class MetricSemanticConvention(MetricGroupSemanticConvention):
+class MetricSemanticConvention(BaseSemanticConvention):
     GROUP_TYPE_NAME = "metric"
 
     allowed_keys: Tuple[str, ...] = BaseSemanticConvention.allowed_keys + (
@@ -601,10 +577,7 @@ def attribute_templates(self):
         SpanSemanticConvention,
         ResourceSemanticConvention,
         EventSemanticConvention,
-        MetricGroupSemanticConvention,
         MetricSemanticConvention,
-        UnitSemanticConvention,
-        ScopeSemanticConvention,
         AttributeGroupConvention,
     )
 }

semantic-conventions/src/opentelemetry/semconv/templating/markdown/__init__.py

@@ -34,7 +34,6 @@
     EventSemanticConvention,
     MetricSemanticConvention,
     SemanticConventionSet,
-    UnitSemanticConvention,
 )
 from opentelemetry.semconv.model.utils import ID_RE
 from opentelemetry.semconv.templating.markdown.options import MarkdownOptions
@@ -56,7 +55,6 @@ def __init__(self):
         self.group_key = ""
         self.enums = []
         self.notes = []
-        self.units = []
         self.current_md = ""
         self.current_semconv = None
 
@@ -301,17 +299,6 @@ def to_creation_time_attributes(
             for attr in sampling_relevant_attrs:
                 output.write("* " + self.render_fqn_for_attribute(attr) + "\n")
 
-    @staticmethod
-    def to_markdown_unit_table(members, output: io.StringIO):
-        output.write("\n")
-        output.write(
-            "| Name        | Kind of Quantity         | Unit String   |\n"
-            "| ------------| ----------------         | -----------   |"
-        )
-        for member in members.values():
-            output.write(f"\n| {member.id} | {member.brief} | `{member.value}` |")
-        output.write("\n")
-
     def to_markdown_enum(self, output: io.StringIO):
         """Renders enum types after a Semantic Convention Table
         :return:
@@ -531,9 +518,6 @@ def _render_group(self, semconv, parameters, output):
                 self.to_markdown_constraint(cnst, output)
         self.to_markdown_enum(output)
 
-        if isinstance(semconv, UnitSemanticConvention):
-            self.to_markdown_unit_table(semconv.members, output)
-
         output.write("<!-- endsemconv -->")
 
     def _render_stability(

semantic-conventions/src/tests/data/jinja/metrics/expected_trim_whitespace_enabled.java

@@ -1,22 +1,19 @@
 package io.opentelemetry.instrumentation.api.metric;
 
-class Units {
-
-    /**
-    * Use this unit for Metric Instruments recording values
-    * representing fraction of a total.
-    **/
-    public static final String PERCENT = "%";
-
+class AllMetrics {
     /**
-    * Use this unit for Metric Instruments recording values
-    * representing time.
-    **/
-    public static final String NANOSECOND = "NS";
+     * first metric description
+     * Unit: {one}
+     * Instrument: counter
+     * Experimental: False
+     */
+    public static final String FIRST_METRIC = "first.metric";
 
     /**
-    * Use this unit for Metric Instruments recording values
-    * representing connections.
-    **/
-    public static final String CONNECTIONS = "{connections}";
-}
+     * second metric description
+     * Unit: s
+     * Instrument: histogram
+     * Experimental: True
+     */
+    public static final String SECOND_GROUP_METRIC = "second_group.metric";
+}

semantic-conventions/src/tests/data/jinja/metrics/metrics_template_trim_whitespace_enabled

@@ -0,0 +1,14 @@
+package io.opentelemetry.instrumentation.api.metric;
+
+class AllMetrics {
+    {%- for metric in metrics %}
+
+    /**
+     * {{metric.brief | to_doc_brief}}
+     * Unit: {{ metric.unit }}
+     * Instrument: {{ metric.instrument }}
+     * Experimental: {{ metric | is_experimental }}
+     */
+    public static final String {{ metric.metric_name | to_const_name }} = "{{metric.metric_name}}";
+{% endfor %}
+}

semantic-conventions/src/tests/data/yaml/metrics.yaml

@@ -1,7 +1,7 @@
 groups:
   - id: metric.foo
     prefix: bar
-    type: metric_group
+    type: attribute_group
     stability: experimental
     brief: "This document defines foo."
     note: >

semantic-conventions/src/tests/semconv/model/test_correct_parse.py

@@ -790,24 +790,6 @@ def semantic_convention_check(self, s, expected):
         self.assertEqual(expected["n_constraints"], len(s.constraints))
         self.assertEqual(expected["attributes"], [a.fqn for a in s.attributes])
 
-    def test_scope_attribute(self):
-        semconv = SemanticConventionSet(debug=False)
-        semconv.parse(self.load_file("yaml/scope.yaml"))
-        self.assertEqual(len(semconv.models), 1)
-
-        expected = {
-            "id": "scope-id",
-            "prefix": "",
-            "type": "scope",
-            "extends": "",
-            "brief": "Instrumentation Scope attributes",
-            "n_constraints": 0,
-            "attributes": [
-                "short_name",
-            ],
-        }
-        self.semantic_convention_check(list(semconv.models.values())[0], expected)
-
     _TEST_DIR = os.path.dirname(__file__)
 
     def load_file(self, filename):