[WIP] V2 Resolved Schema

crates/weaver_forge/expected_output/semconv_jq_fn/semconv_metrics.json

@@ -193,6 +193,9 @@
               "source_group": "registry.url"
             }
           },
+          "includes_group": [
+            "http.client.server_and_port"
+          ],
           "provenance": {
             "path": "data/http.yaml",
             "registry_id": "default"
@@ -438,6 +441,7 @@
               "source_group": "attributes.jvm.memory"
             }
           },
+          "extends_group": "attributes.jvm.memory",
           "provenance": {
             "path": "data/jvm-metrics.yaml",
             "registry_id": "default"
@@ -557,6 +561,7 @@
               "source_group": "attributes.jvm.memory"
             }
           },
+          "extends_group": "attributes.jvm.memory",
           "provenance": {
             "path": "data/jvm-metrics.yaml",
             "registry_id": "default"
@@ -680,6 +685,7 @@
               "source_group": "attributes.jvm.memory"
             }
           },
+          "extends_group": "attributes.jvm.memory",
           "provenance": {
             "path": "data/jvm-metrics.yaml",
             "registry_id": "default"
@@ -775,6 +781,7 @@
               "source_group": "attributes.jvm.memory"
             }
           },
+          "extends_group": "attributes.jvm.memory",
           "provenance": {
             "path": "data/jvm-metrics.yaml",
             "registry_id": "default"

crates/weaver_forge/expected_output/semconv_jq_fn/semconv_metrics_not_deprecated.json

@@ -193,6 +193,9 @@
               "source_group": "registry.url"
             }
           },
+          "includes_group": [
+            "http.client.server_and_port"
+          ],
           "provenance": {
             "path": "data/http.yaml",
             "registry_id": "default"
@@ -428,6 +431,7 @@
               "source_group": "attributes.jvm.memory"
             }
           },
+          "extends_group": "attributes.jvm.memory",
           "provenance": {
             "path": "data/jvm-metrics.yaml",
             "registry_id": "default"
@@ -513,6 +517,7 @@
               "source_group": "attributes.jvm.memory"
             }
           },
+          "extends_group": "attributes.jvm.memory",
           "provenance": {
             "path": "data/jvm-metrics.yaml",
             "registry_id": "default"
@@ -615,6 +620,7 @@
               "source_group": "attributes.jvm.memory"
             }
           },
+          "extends_group": "attributes.jvm.memory",
           "provenance": {
             "path": "data/jvm-metrics.yaml",
             "registry_id": "default"
@@ -700,6 +706,7 @@
               "source_group": "attributes.jvm.memory"
             }
           },
+          "extends_group": "attributes.jvm.memory",
           "provenance": {
             "path": "data/jvm-metrics.yaml",
             "registry_id": "default"

crates/weaver_forge/src/lib.rs

@@ -42,6 +42,7 @@ mod filter;
 mod formats;
 pub mod jq;
 pub mod registry;
+pub mod v2;
 
 /// Name of the Weaver configuration file.
 pub const WEAVER_YAML: &str = "weaver.yaml";

crates/weaver_forge/src/registry.rs

@@ -297,6 +297,7 @@ mod tests {
                     body: None,
                     entity_associations: vec![],
                     annotations: None,
+                    visibility: None,
                 },
                 Group {
                     id: "apple.group".to_owned(),
@@ -319,6 +320,7 @@ mod tests {
                     body: None,
                     entity_associations: vec![],
                     annotations: None,
+                    visibility: None,
                 },
                 Group {
                     id: "middle.group".to_owned(),
@@ -341,6 +343,7 @@ mod tests {
                     body: None,
                     entity_associations: vec![],
                     annotations: None,
+                    visibility: None,
                 },
             ],
         };

crates/weaver_forge/src/v2/attribute.rs

@@ -0,0 +1,31 @@
+//! Attribute definitions for template schema.
+
+use schemars::JsonSchema;
+use serde::{Deserialize, Serialize};
+use weaver_semconv::{
+    attribute::{AttributeType, Examples},
+    v2::CommonFields,
+};
+
+/// The definition of an Attribute.
+#[derive(Serialize, Deserialize, Debug, Clone, JsonSchema, PartialEq, Hash, Eq)]
+#[serde(deny_unknown_fields)]
+#[serde(rename_all = "snake_case")]
+pub struct Attribute {
+    /// String that uniquely identifies the attribute.
+    pub key: String,
+    /// Either a string literal denoting the type as a primitive or an
+    /// array type, a template type or an enum definition.
+    pub r#type: AttributeType,
+    /// Sequence of example values for the attribute or single example
+    /// value. They are required only for string and string array
+    /// attributes. Example values must be of the same type of the
+    /// attribute. If only a single example is provided, it can directly
+    /// be reported without encapsulating it into a sequence/dictionary.
+    #[serde(default)]
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub examples: Option<Examples>,
+    /// Common fields (like brief, note, attributes).
+    #[serde(flatten)]
+    pub common: CommonFields,
+}

crates/weaver_forge/src/v2/attribute_group.rs

@@ -0,0 +1,20 @@
+//! Version two of attribute groups.
+
+use schemars::JsonSchema;
+use serde::{Deserialize, Serialize};
+use weaver_semconv::v2::{signal_id::SignalId, CommonFields};
+
+use crate::v2::attribute::Attribute;
+
+/// Public attribute group.
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, JsonSchema)]
+#[serde(deny_unknown_fields)]
+pub struct AttributeGroup {
+    /// The name of the attribute group, must be unique.
+    pub id: SignalId,
+    /// List of attributes.
+    pub attributes: Vec<Attribute>,
+    /// Common fields (like brief, note, annotations).
+    #[serde(flatten)]
+    pub common: CommonFields,
+}

crates/weaver_forge/src/v2/entity.rs

@@ -0,0 +1,47 @@
+//! Event related definitions structs.
+
+use schemars::JsonSchema;
+use serde::{Deserialize, Serialize};
+use weaver_semconv::{
+    attribute::RequirementLevel,
+    v2::{signal_id::SignalId, CommonFields},
+};
+
+use crate::v2::attribute::Attribute;
+
+/// The definition of an entity signal.
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, JsonSchema)]
+#[serde(deny_unknown_fields)]
+pub struct Entity {
+    /// The type of the entity.
+    pub r#type: SignalId,
+
+    /// List of attributes that identify this entity.
+    #[serde(default)]
+    #[serde(skip_serializing_if = "Vec::is_empty")]
+    pub identity: Vec<EntityAttribute>,
+
+    /// List of attributes that describe to this entity.
+    #[serde(default)]
+    #[serde(skip_serializing_if = "Vec::is_empty")]
+    pub description: Vec<EntityAttribute>,
+
+    /// Common fields (like brief, note, annotations).
+    #[serde(flatten)]
+    pub common: CommonFields,
+}
+
+/// A special type of reference to attributes that remembers entity-specicific information.
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, JsonSchema)]
+#[serde(deny_unknown_fields)]
+pub struct EntityAttribute {
+    /// Base attribute definitions.
+    #[serde(flatten)]
+    pub base: Attribute,
+    /// Specifies if the attribute is mandatory. Can be "required",
+    /// "conditionally_required", "recommended" or "opt_in". When omitted,
+    /// the attribute is "recommended". When set to
+    /// "conditionally_required", the string provided as <condition> MUST
+    /// specify the conditions under which the attribute is required.
+    pub requirement_level: RequirementLevel,
+}

crates/weaver_forge/src/v2/event.rs

@@ -0,0 +1,69 @@
+//! Event related definitions structs.
+
+use schemars::JsonSchema;
+use serde::{Deserialize, Serialize};
+use weaver_semconv::{
+    attribute::RequirementLevel,
+    v2::{signal_id::SignalId, CommonFields},
+};
+
+use crate::v2::attribute::Attribute;
+
+/// The definition of an event signal.
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, JsonSchema)]
+#[serde(deny_unknown_fields)]
+pub struct Event {
+    /// The name of the event.
+    pub name: SignalId,
+
+    /// List of attributes that belong to this event.
+    #[serde(default)]
+    #[serde(skip_serializing_if = "Vec::is_empty")]
+    pub attributes: Vec<EventAttribute>,
+
+    /// Which resources this event should be associated with.
+    ///
+    /// This list is an "any of" list, where a event may be associated with one or more entities, but should
+    /// be associated with at least one in this list.
+    #[serde(default)]
+    #[serde(skip_serializing_if = "Vec::is_empty")]
+    pub entity_associations: Vec<String>,
+
+    /// Common fields (like brief, note, annotations).
+    #[serde(flatten)]
+    pub common: CommonFields,
+}
+
+/// A special type of reference to attributes that remembers event-specicific information.
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, JsonSchema)]
+#[serde(deny_unknown_fields)]
+pub struct EventAttribute {
+    /// Base attribute definitions.
+    #[serde(flatten)]
+    pub base: Attribute,
+    /// Specifies if the attribute is mandatory. Can be "required",
+    /// "conditionally_required", "recommended" or "opt_in". When omitted,
+    /// the attribute is "recommended". When set to
+    /// "conditionally_required", the string provided as <condition> MUST
+    /// specify the conditions under which the attribute is required.
+    pub requirement_level: RequirementLevel,
+}
+
+/// A refinement of an event signal, for use in code generation or specific library application.
+///
+/// A refinement represents a "view" of an Event that is highly optimised for a particular implementation.
+/// e.g. for HTTP events, there may be a refinement that provides only the necessary information for dealing with Java's HTTP
+/// client library, and drops optional or extraneous information from the underlying http event.
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, JsonSchema)]
+pub struct EventRefinement {
+    /// The identity of the refinement.
+    pub id: SignalId,
+
+    // TODO - This is a lazy way of doing this.  We use `type` to refer
+    // to the underlying event definition, but override all fields here.
+    // We probably should copy-paste all the "event" attributes here
+    // including the `name`.
+    /// The definition of the event refinement.
+    #[serde(flatten)]
+    pub event: Event,
+}

crates/weaver_forge/src/v2/metric.rs

@@ -0,0 +1,81 @@
+//! Metric related definitions structs.
+
+use crate::v2::attribute::Attribute;
+use schemars::JsonSchema;
+use serde::{Deserialize, Serialize};
+use weaver_semconv::{
+    attribute::RequirementLevel,
+    group::InstrumentSpec,
+    v2::{signal_id::SignalId, CommonFields},
+};
+
+/// The definition of a metric signal.
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, JsonSchema)]
+#[serde(deny_unknown_fields)]
+pub struct Metric {
+    /// The name of the metric.
+    pub name: SignalId,
+    /// The instrument type that should be used to record the metric. Note that
+    /// the semantic conventions must be written using the names of the
+    /// synchronous instrument types (counter, gauge, updowncounter and
+    /// histogram).
+    /// For more details: [Metrics semantic conventions - Instrument types](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/metrics/semantic_conventions#instrument-types).
+    pub instrument: InstrumentSpec,
+    /// The unit in which the metric is measured, which should adhere to the
+    /// [guidelines](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/metrics/semantic_conventions#instrument-units).
+    pub unit: String,
+    /// List of attributes that should be included on this metric.
+    #[serde(default)]
+    #[serde(skip_serializing_if = "Vec::is_empty")]
+    pub attributes: Vec<MetricAttribute>,
+    // TODO - Should Entity Associations be "strong" links?
+    /// Which resources this metric should be associated with.
+    ///
+    /// This list is an "any of" list, where a metric may be associated with one or more entities, but should
+    /// be associated with at least one in this list.
+    #[serde(default)]
+    #[serde(skip_serializing_if = "Vec::is_empty")]
+    pub entity_associations: Vec<String>,
+
+    /// Common fields (like brief, note, annotations).
+    #[serde(flatten)]
+    pub common: CommonFields,
+}
+
+/// A special type of reference to attributes that remembers metric-specific information.
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, JsonSchema)]
+#[serde(deny_unknown_fields)]
+pub struct MetricAttribute {
+    /// Base attribute definitions.
+    #[serde(flatten)]
+    pub base: Attribute,
+    /// Specifies if the attribute is mandatory. Can be "required",
+    /// "conditionally_required", "recommended" or "opt_in". When omitted,
+    /// the attribute is "recommended". When set to
+    /// "conditionally_required", the string provided as <condition> MUST
+    /// specify the conditions under which the attribute is required.
+    ///
+    /// Note: For attributes that are "recommended" or "opt-in" - not all metric source will
+    /// create timeseries with these attributes, but for any given timeseries instance, the attributes that *were* present
+    /// should *remain* present. That is - a metric timeseries cannot drop attributes during its lifetime.
+    pub requirement_level: RequirementLevel,
+}
+
+/// A refinement of a metric signal, for use in code-gen or specific library application.
+///
+/// A refinement represents a "view" of a Metric that is highly optimised for a particular implementation.
+/// e.g. for HTTP metrics, there may be a refinement that provides only the necessary information for dealing with Java's HTTP
+/// client library, and drops optional or extraneous information from the underlying http metric.
+#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, JsonSchema)]
+pub struct MetricRefinement {
+    /// The identity of the refinement.
+    pub id: SignalId,
+
+    // TODO - This is a lazy way of doing this.  We use `type` to refer
+    // to the underlying metric definition, but override all fields here.
+    // We probably should copy-paste all the "metric" attributes here
+    // including the `ty`
+    /// The definition of the metric refinement.
+    #[serde(flatten)]
+    pub metric: Metric,
+}

crates/weaver_forge/src/v2/mod.rs

@@ -0,0 +1,9 @@
+//! Version two of weaver model.
+
+pub mod attribute;
+pub mod attribute_group;
+pub mod entity;
+pub mod event;
+pub mod metric;
+pub mod registry;
+pub mod span;