Semantic Conventions - Multi-Registry Proposal

docs/specs/multi-registry/registries/acme-http-server-lib/metric.yaml

@@ -0,0 +1,16 @@
+imports:
+  - schema_url: https://opentelemetry.io/schemas/1.27.0
+    name: otel
+
+groups:
+  - ref: otel:http.server.request.duration
+    attributes:
+      - ref: otel:http.request.method
+        requirement_level: required
+      - ref: otel:client.address
+        requirement_level: required
+      - ref: otel:client.port
+        requirement_level: required
+      - ref: otel:thread.id
+        requirement_level: required
+      - ref: route.name

docs/specs/multi-registry/registries/acme-http-server-lib/registry/attributes.yaml

@@ -0,0 +1,28 @@
+groups:
+  - id: registry.acme_http_server
+    type: attribute_group
+    display_name: Custom attributes for ACME HTTP Server
+    brief: 'A set of specific attributes for ACME HTTP Server.'
+    attributes:
+      # The ACME HTTP server author does not use the standard `http.route` for an unknown reason.
+      # Unfortunately, we cannot avoid this. In the future, we could enhance Weaver to detect these
+      # types of similarities and report them as advice messages.
+      - id: route.name
+        brief: 'The name of the route.'
+        stability: stable
+        requirement_level: required
+        type: string
+      - id: rate_limiter.type
+        brief: 'The type of rate limiter.'
+        stability: stable
+        requirement_level: required
+        type:
+          members:
+            - id: sliding
+              value: "SLIDING"
+              brief: 'SLIDING policy.'
+              stability: stable
+            - id: token
+              value: "TOKEN"
+              brief: 'TOKEN policy.'
+              stability: stable

docs/specs/multi-registry/registries/acme-http-server-lib/trace.yaml

@@ -0,0 +1,23 @@
+imports:
+  - schema_url: https://opentelemetry.io/schemas/1.27.0
+    name: otel
+
+groups:
+  - ref: otel:trace.http.server
+    brief: 'Trace reported by ACME HTTP Server library.'
+    attributes:
+      # The `requirement_level` of the following attributes is promoted to `required`
+      # Note: These 3 attributes are already attached to `trace.http.server`
+      - ref: otel:http.request.method
+        requirement_level: required
+      - ref: otel:client.address
+        requirement_level: required
+      - ref: otel:client.port
+        requirement_level: required
+      # A standard OTEL attribute is attached to the `trace.http.server`
+      # This attribute is not part of the OTEL definition of a `trace.http.server`
+      - ref: otel:thread.id
+        requirement_level: required
+      # Two locally defined attributes (see the attribute registry)
+      - ref: route.name
+      - ref: rate_limiter.type

docs/specs/multi-registry/registries/app/app.yaml

@@ -0,0 +1,29 @@
+imports:
+  - schema_url: https://opentelemetry.io/schemas/1.27.0
+    name: otel
+  - schema_url: https://github.com/acme-http-server-lib/schema_v0.7.1.yaml
+    name: acme
+
+groups:
+  - id: endpoint.error
+    type: event
+    name: endpoint.error
+    brief: "An endpoint error event."
+    stability: stable
+    attributes:
+      - ref: otel:user.roles
+        requirement_level: required
+      - ref: otel:client.address
+        requirement_level: required
+      - ref: otel:client.port
+        requirement_level: required
+      - ref: otel:http.request.method
+        requirement_level: required
+      - ref: otel:error.type
+        requirement_level: required
+      - ref: otel:thread.id
+        requirement_level: required
+      - ref: acme:route.name
+      - ref: tenant.id
+
+

docs/specs/multi-registry/registries/app/registry/attributes.yaml

@@ -0,0 +1,11 @@
+groups:
+  - id: registry.app
+    type: attribute_group
+    display_name: Enterprise Application Attributes
+    brief: 'A set of enterprise application attributes.'
+    attributes:
+      - id: tenant.id
+        brief: 'The customer tenant id.'
+        stability: stable
+        requirement_level: required
+        type: string

docs/specs/multi-registry/registries/waf-vendor/registry/waf_attributes.yaml

@@ -0,0 +1,30 @@
+groups:
+  - id: registry.waf
+    type: attribute_group
+    display_name: WAF Attributes
+    brief: 'A set of specific WAF attributes.'
+    attributes:
+      - id: waf.signature
+        brief: "The WAF signature"
+        type: string
+      - id: waf.action.type
+        brief: "The WAF action type."
+        stability: stable
+        type:
+          members:
+            - id: alarmed
+              value: "ALARMED"
+              brief: 'ALARMED action.'
+              stability: stable
+            - id: blocked
+              value: "BLOCKED"
+              brief: 'BLOCKED action.'
+              stability: stable
+            - id: legal
+              value: "LEGAL"
+              brief: 'LEGAL action.'
+              stability: stable
+            - id: dropped
+              value: "DROPPED"
+              brief: 'DROPPED action.'
+              stability: stable

docs/specs/multi-registry/registries/waf-vendor/trace.yaml

@@ -0,0 +1,30 @@
+# New optional section to define external registries to import in the current registry.
+# Note: Unused imports will be detected by Weaver and reported as warnings by default.
+imports:
+  # Importing an external registry involves specifying the schema URL associated with that registry.
+  # The current schema file structure needs to be updated, either by adding a reference to a
+  # self-contained and fully resolved semantic convention or by directly integrating its content into the schema.
+  # This approach is also well aligned with the OpenTelemetry Protocol specification,
+  # which already specifies a schema URL at the resource and scope levels.
+  - schema_url: https://opentelemetry.io/schemas/1.27.0
+    # A short and local name used to reference signals and attributes from the imported registry.
+    name: otel
+
+groups:
+  # The following declaration overrides the definition of the `otel:trace.http.server` span group and changes
+  # the requirement level of few attributes to `required`.
+  # This override does not affect the original definition in the imported registry.
+  # Note: Similar to attribute references, group references cannot change the group type.
+  - ref: otel:trace.http.server
+    attributes:
+      # References to attributes from the imported registry must always be prefixed with the imported name and a colon.
+      # Local references do not require any prefix.
+      - ref: otel:http.request.method
+        requirement_level: required
+      - ref: otel:client.address
+        requirement_level: required
+      - ref: otel:client.port
+        requirement_level: required
+      # Locally defined attributes can be added to the imported group.
+      - ref: waf.action.type
+        requirement_level: required

docs/specs/multi-registry/registries/waf-vendor/waf_action.yaml

@@ -0,0 +1,36 @@
+# New optional section to define external registries to import in the current registry.
+# Note: Unused imports will be detected by Weaver and reported as warnings by default.
+imports:
+  # Importing an external registry involves specifying the schema URL associated with that registry.
+  # The current schema file structure needs to be updated, either by adding a reference to a
+  # self-contained and fully resolved semantic convention or by directly integrating its content into the schema.
+  # This approach is also well aligned with the OpenTelemetry Protocol specification,
+  # which already specifies a schema URL at the resource and scope levels.
+  - schema_url: https://opentelemetry.io/schemas/1.27.0
+    # A short and local name used to reference signals and attributes from the imported registry.
+    # We use `my_otel` here just to show that it can be any name and that different aliases can be used for the same
+    # schema URL across different semconv files in the same registry.
+    name: my_otel
+
+groups:
+  # Locally defined metric group can both extend a locally defined attribute group and
+  # reference imported individual attributes.
+  - id: metric.waf.action.hit.count
+    type: metric
+    metric_name: waf.action.hit.count
+    brief: "The number of times the action was hit."
+    instrument: counter
+    unit: "{count}"
+    stability: stable
+    extends: registry.waf
+    attributes:
+      - ref: my_otel:http.request.method
+        requirement_level: required
+      - ref: my_otel:client.address
+        requirement_level: required
+      - ref: my_otel:client.port
+        requirement_level: required
+      - ref: waf.signature
+        requirement_level: required
+      - ref: waf.action.type
+        requirement_level: required