apollo-router 3.0.0-alpha.2

A configurable, high-performance routing runtime for Apollo Federation 🚀
Documentation 
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
85
86

use schemars::JsonSchema;
use serde::Deserialize;

use super::connector::spans::ConnectorSpans;
use super::http_client::spans::HttpClientSpans;
use super::router::spans::RouterSpans;
use super::subgraph::spans::SubgraphSpans;
use super::supergraph::spans::SupergraphSpans;
use crate::plugins::telemetry::config_new::DefaultForLevel;
use crate::plugins::telemetry::config_new::attributes::DefaultAttributeRequirementLevel;
use crate::plugins::telemetry::otlp::TelemetryDataKind;

#[derive(Deserialize, JsonSchema, Clone, Default, Debug)]
#[serde(deny_unknown_fields, default)]
pub(crate) struct Spans {
    /// The attributes to include by default in spans based on their level as specified in the otel semantic conventions and Apollo documentation.
    pub(crate) default_attribute_requirement_level: DefaultAttributeRequirementLevel,

    /// Configuration of router spans.
    /// Log events inherit attributes from the containing span, so attributes configured here will be included on log events for a request.
    /// Router spans contain http request and response information and therefore contain http specific attributes.
    pub(crate) router: RouterSpans,

    /// Configuration of supergraph spans.
    /// Supergraph spans contain information about the graphql request and response and therefore contain graphql specific attributes.
    pub(crate) supergraph: SupergraphSpans,

    /// Attributes to include on the subgraph span.
    /// Subgraph spans contain information about the subgraph request and response and therefore contain subgraph specific attributes.
    pub(crate) subgraph: SubgraphSpans,

    /// Attributes to include on the connector span.
    /// Connector spans contain information about the connector request and response and therefore contain connector specific attributes.
    pub(crate) connector: ConnectorSpans,

    /// Attributes to include on the HTTP client span.
    /// HTTP client spans contain information about HTTP requests made to subgraphs, including any changes made by Rhai scripts.
    pub(crate) http_client: HttpClientSpans,
}

impl Spans {
    /// Update the defaults for spans configuration regarding the `default_attribute_requirement_level`
    pub(crate) fn update_defaults(&mut self) {
        self.router.defaults_for_levels(
            self.default_attribute_requirement_level,
            TelemetryDataKind::Traces,
        );
        self.supergraph.defaults_for_levels(
            self.default_attribute_requirement_level,
            TelemetryDataKind::Traces,
        );
        self.subgraph.defaults_for_levels(
            self.default_attribute_requirement_level,
            TelemetryDataKind::Traces,
        );
        self.http_client.defaults_for_levels(
            self.default_attribute_requirement_level,
            TelemetryDataKind::Traces,
        );
    }

    pub(crate) fn validate(&self) -> Result<(), String> {
        for (name, custom) in &self.router.attributes.custom {
            custom
                .validate()
                .map_err(|err| format!("error for router span attribute {name:?}: {err}"))?;
        }
        for (name, custom) in &self.supergraph.attributes.custom {
            custom
                .validate()
                .map_err(|err| format!("error for supergraph span attribute {name:?}: {err}"))?;
        }
        for (name, custom) in &self.subgraph.attributes.custom {
            custom
                .validate()
                .map_err(|err| format!("error for subgraph span attribute {name:?}: {err}"))?;
        }
        for (name, custom) in &self.http_client.attributes.custom {
            custom
                .validate()
                .map_err(|err| format!("error for http_client span attribute {name:?}: {err}"))?;
        }

        Ok(())
    }
}