wyrd-spec 0.1.1

Wyrd foundation types: Card envelope, SpecKinds, and pure data contracts.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

//! OTel `InstrumentationScope` -- the SDK or library that produced the span.
//!
//! (Proto: `opentelemetry.proto.common.v1.InstrumentationScope`.)
//!
//! This is distinct from [`Resource`](crate::vala::trace::Resource). Resource
//! is "what entity is running"; scope is "what library inside that entity
//! emitted the span".

use serde::{Deserialize, Serialize};

use crate::error::WyrdError;

/// OTel-canonical instrumentation scope.
///
/// Fields:
///
/// - `name` -- instrumentation library name, such as `wyrd-tracing` or
///   `opentelemetry-instrumentation-requests`.
/// - `version` -- optional library version string.
/// - `attributes` -- rare scope-level attributes.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, schemars::JsonSchema)]
#[serde(deny_unknown_fields)]
pub struct InstrumentationScope {
    /// Instrumentation library name.
    pub name: String,
    /// Instrumentation library version, when known.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub version: Option<String>,
    /// Scope-level attribute bag.
    #[serde(default)]
    pub attributes: serde_json::Map<String, serde_json::Value>,
}

impl InstrumentationScope {
    /// Validate the scope-level invariants.
    ///
    /// Enforces:
    ///
    /// - `name` is non-empty and no longer than 256 characters.
    /// - `version` is no longer than 64 characters when present.
    /// - `attributes` contains no more than 32 entries.
    ///
    /// # Errors
    /// Returns [`WyrdError::Validation`] when the scope violates one of these
    /// invariants.
    pub fn validate(&self) -> Result<(), WyrdError> {
        if self.name.is_empty() {
            return Err(WyrdError::Validation {
                message: "instrumentation_scope.name must be non-empty".to_string(),
                details: serde_json::Value::Null,
            });
        }
        if self.name.len() > 256 {
            return Err(WyrdError::Validation {
                message: format!(
                    "instrumentation_scope.name length must be <= 256, got {}",
                    self.name.len()
                ),
                details: serde_json::Value::Null,
            });
        }
        if let Some(v) = &self.version
            && v.len() > 64
        {
            return Err(WyrdError::Validation {
                message: format!(
                    "instrumentation_scope.version length must be <= 64, got {}",
                    v.len()
                ),
                details: serde_json::Value::Null,
            });
        }
        if self.attributes.len() > 32 {
            return Err(WyrdError::Validation {
                message: format!(
                    "instrumentation_scope.attributes count must be <= 32, got {}",
                    self.attributes.len()
                ),
                details: serde_json::Value::Null,
            });
        }
        Ok(())
    }
}