surrealdb-server 3.0.5

A scalable, distributed, collaborative, document-graph database, for the realtime web
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

pub mod ds;
pub mod http;
pub mod ws;

use opentelemetry_sdk::metrics::{
	Aggregation, Instrument, PeriodicReader, SdkMeterProvider, Stream,
};

pub use self::http::tower_layer::HttpMetricsLayer;
use super::OTEL_DEFAULT_RESOURCE;
use crate::cnf::{TELEMETRY_DISABLE_METRICS, TELEMETRY_PROVIDER};

// Histogram buckets in milliseconds
static HISTOGRAM_BUCKETS_MS: &[f64] = &[
	5.0, 10.0, 20.0, 50.0, 75.0, 100.0, 150.0, 200.0, 250.0, 300.0, 500.0, 750.0, 1000.0, 1500.0,
	2000.0, 2500.0, 5000.0, 10000.0, 15000.0, 30000.0,
];

// Histogram buckets in bytes
const KB: f64 = 1024.0;
const MB: f64 = 1024.0 * KB;
const HISTOGRAM_BUCKETS_BYTES: &[f64] = &[
	1.0 * KB,
	2.0 * KB,
	5.0 * KB,
	10.0 * KB,
	100.0 * KB,
	500.0 * KB,
	1.0 * MB,
	2.5 * MB,
	5.0 * MB,
	10.0 * MB,
	25.0 * MB,
	50.0 * MB,
	100.0 * MB,
];

// Returns a metrics configuration based on the SURREAL_TELEMETRY_PROVIDER
// environment variable
pub fn init() -> anyhow::Result<Option<SdkMeterProvider>> {
	match TELEMETRY_PROVIDER.trim() {
		// The OTLP telemetry provider has been specified
		s if s.eq_ignore_ascii_case("otlp") && !*TELEMETRY_DISABLE_METRICS => {
			// Create a new metrics exporter using OTLP with tonic transport
			let exporter = opentelemetry_otlp::MetricExporter::builder()
				.with_tonic()
				.with_temporality(opentelemetry_sdk::metrics::Temporality::Cumulative)
				.build()?;
			let reader = PeriodicReader::builder(exporter)
				.with_interval(std::time::Duration::from_secs(60))
				.build();
			// Create view for histogram durations with custom buckets
			let duration_view = |instrument: &Instrument| -> Option<Stream> {
				if instrument.name().ends_with(".duration") {
					Stream::builder()
						.with_aggregation(Aggregation::ExplicitBucketHistogram {
							boundaries: HISTOGRAM_BUCKETS_MS.to_vec(),
							record_min_max: true,
						})
						.build()
						.ok()
				} else {
					None
				}
			};
			// Create view for histogram sizes with custom buckets
			let size_view = |instrument: &Instrument| -> Option<Stream> {
				if instrument.name().ends_with(".size") {
					Stream::builder()
						.with_aggregation(Aggregation::ExplicitBucketHistogram {
							boundaries: HISTOGRAM_BUCKETS_BYTES.to_vec(),
							record_min_max: true,
						})
						.build()
						.ok()
				} else {
					None
				}
			};
			// Create the new metrics provider
			Ok(Some(
				SdkMeterProvider::builder()
					.with_reader(reader)
					.with_resource(OTEL_DEFAULT_RESOURCE.clone())
					.with_view(duration_view)
					.with_view(size_view)
					.build(),
			))
		}
		// No matching telemetry provider was found
		_ => Ok(None),
	}
}