rocketmq-observability 1.0.0

Observability support for rocketmq-rust
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
87
88
89
90
91
92
93
94
95
96
97
98

// Copyright 2023 The RocketMQ Rust Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#[cfg(any(feature = "otel-metrics", feature = "otel-traces", feature = "otel-logs", test))]
use crate::config::ObservabilityConfig;

#[cfg(any(feature = "otel-metrics", feature = "otel-traces", feature = "otel-logs", test))]
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ResourceAttribute {
    pub key: String,
    pub value: String,
}

#[cfg(any(feature = "otel-metrics", feature = "otel-traces", feature = "otel-logs", test))]
pub fn build_resource_attributes(config: &ObservabilityConfig) -> Vec<ResourceAttribute> {
    let mut attributes = vec![
        ResourceAttribute::new("service.name", &config.service_name),
        ResourceAttribute::new("service.namespace", &config.service_namespace),
        ResourceAttribute::new("service.version", &config.service_version),
        ResourceAttribute::new("deployment.environment.name", &config.environment),
        ResourceAttribute::new("rocketmq.cluster", &config.cluster),
        ResourceAttribute::new("rocketmq.node.type", &config.node_type),
    ];

    if !config.service_instance_id.is_empty() {
        attributes.push(ResourceAttribute::new(
            "service.instance.id",
            &config.service_instance_id,
        ));
    }

    if !config.node_id.is_empty() {
        attributes.push(ResourceAttribute::new("rocketmq.node.id", &config.node_id));
    }

    attributes.extend(
        config
            .resource_attributes
            .iter()
            .map(|(key, value)| ResourceAttribute::new(key, value)),
    );
    attributes
}

#[cfg(any(feature = "otel-metrics", feature = "otel-traces", feature = "otel-logs", test))]
impl ResourceAttribute {
    fn new(key: impl Into<String>, value: impl Into<String>) -> Self {
        Self {
            key: key.into(),
            value: value.into(),
        }
    }
}

#[cfg(any(feature = "otel-metrics", feature = "otel-traces", feature = "otel-logs"))]
pub fn build_key_values(config: &ObservabilityConfig) -> Vec<opentelemetry::KeyValue> {
    build_resource_attributes(config)
        .into_iter()
        .map(|attribute| opentelemetry::KeyValue::new(attribute.key, attribute.value))
        .collect()
}

#[cfg(any(feature = "otel-metrics", feature = "otel-traces", feature = "otel-logs"))]
pub fn build_resource(config: &ObservabilityConfig) -> opentelemetry_sdk::Resource {
    opentelemetry_sdk::Resource::builder()
        .with_service_name(config.service_name.clone())
        .with_attributes(build_key_values(config))
        .build()
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn includes_core_resource_attributes() {
        let config = ObservabilityConfig::default();
        let attributes = build_resource_attributes(&config);

        assert!(attributes
            .iter()
            .any(|attribute| attribute.key == "service.name" && attribute.value == "rocketmq-rust"));
        assert!(attributes
            .iter()
            .any(|attribute| attribute.key == "rocketmq.cluster" && attribute.value == "DefaultCluster"));
    }
}