fswtch 0.1.8

Rust bindings and helpers for writing FreeSWITCH modules
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

use std::{
    collections::HashMap,
    sync::{LazyLock, Mutex},
};

static METRICS: LazyLock<Mutex<HashMap<String, u64>>> =
    LazyLock::new(|| Mutex::new(HashMap::new()));
const MAX_METRICS: usize = 1024;

fswtch::module_exports! {
    module = mod_metrics,
    load = switch_module_load,
}

fswtch::api_callback! {
    fn hit_api(cmd, _session, stream) {
        fswtch::log_info("mod_metrics", "rust_metrics_hit invoked");
        let Some(name) = cmd else {
            let status = stream.write("usage: rust_metrics_hit <name>\n");
            return fswtch::false_on_success(status);
        };

        let mut metrics = METRICS
            .lock()
            .unwrap_or_else(|poisoned| poisoned.into_inner());
        let key = metric_key(&name);
        if !metrics.contains_key(&key) && metrics.len() >= MAX_METRICS {
            fswtch::log_error("mod_metrics", "metric cardinality limit reached");
            return stream.write("metric cardinality limit reached\n");
        }
        let count = metrics.entry(key.clone()).or_default();
        *count += 1;
        fswtch::log_info(
            "mod_metrics",
            format!("incremented metric={key} count={count}"),
        );
        stream.write(&format!("metric={key} count={count}\n"))
    }
}

fswtch::api_callback! {
    fn show_api(_cmd, _session, stream) {
        fswtch::log_info("mod_metrics", "rust_metrics_show invoked");
        let metrics = METRICS
            .lock()
            .unwrap_or_else(|poisoned| poisoned.into_inner());
        let mut lines = String::from(
            "# HELP fswtch_example_events_total Example module event counter\n# TYPE fswtch_example_events_total counter\n",
        );
        for (name, count) in metrics.iter() {
            lines.push_str(&format!(
                "fswtch_example_events_total{{name=\"{name}\"}} {count}\n"
            ));
        }
        stream.write(&lines)
    }
}

fswtch::module_load! {
    fn switch_module_load(module) for "mod_metrics" {
        fswtch::log_info("mod_metrics", "loading module");
        module
            .api(
                "rust_metrics_hit",
                "increments a named example counter",
                "rust_metrics_hit <name>",
                hit_api,
            )
            .and_then(|module| {
                module.api(
                    "rust_metrics_show",
                    "prints example counters in Prometheus text format",
                    "rust_metrics_show",
                    show_api,
                )
            })
    }
}

fn metric_key(name: &str) -> String {
    name.chars()
        .map(|ch| {
            if ch.is_ascii_alphanumeric() || ch == '_' || ch == '-' {
                ch
            } else {
                '_'
            }
        })
        .collect()
}