fast-telemetry 0.8.0

High-performance, cache-friendly telemetry primitives and export formats for 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

//! Fast, thread-sharded counters and histograms for high-performance telemetry.
//!
//! OpenTelemetry counters use atomic operations with global synchronization,
//! which causes cache-line bouncing across cores. This crate provides
//! thread-local sharded counters that:
//!
//! - Increment with no cross-thread contention (just a thread-local write)
//! - Are cache-line padded to avoid false sharing (using crossbeam's CachePadded)
//! - Aggregate on read (sum all shards)
//!
//! # Labeled Metrics
//!
//! For dimensional metrics (counters/gauges/histograms broken down by label),
//! use the `Labeled*` types with a `LabelEnum` implementation. These provide
//! O(1) lookup via array indexing instead of HashMap lookups.
//!
//! ```ignore
//! use fast_telemetry::{LabeledCounter, LabelEnum};
//!
//! #[derive(Copy, Clone, Debug)]
//! enum HttpMethod { Get, Post, Put, Delete }
//!
//! impl LabelEnum for HttpMethod { /* ... */ }
//!
//! let counter: LabeledCounter<HttpMethod> = LabeledCounter::new(4);
//! counter.inc(HttpMethod::Get);  // O(1) array index, no hashing
//! ```

mod export;
pub(crate) mod internal;
mod metric;
#[cfg(feature = "runtime")]
mod runtime;
pub mod span;
mod temporality;

pub use export::text::{DogStatsDExport, PrometheusExport};

// These helpers are public only because the ExportMetrics proc macro generates
// code that calls them. They are not part of the public API and may change
// without notice.
#[doc(hidden)]
pub mod __macro_support {
    pub use crate::export::text::{
        __write_dogstatsd, __write_dogstatsd_distribution, __write_dogstatsd_distribution_delta,
        __write_dogstatsd_distribution_delta_dynamic,
        __write_dogstatsd_distribution_delta_dynamic_pairs, __write_dogstatsd_distribution_dynamic,
        __write_dogstatsd_dynamic, __write_dogstatsd_dynamic_pairs, __write_dogstatsd_with_label,
        FastFormat,
    };
}
pub use metric::ExportMetrics;
pub use metric::{
    Counter, CounterSet, CounterSetBuffer, Distribution, DistributionSnapshot, DynamicCounter,
    DynamicCounterSeries, DynamicCounterSet, DynamicCounterSetSeries, DynamicDistribution,
    DynamicDistributionSeries, DynamicGauge, DynamicGaugeI64, DynamicGaugeI64Series,
    DynamicGaugeSeries, DynamicHistogram, DynamicHistogramSeries, DynamicHistogramSeriesView,
    DynamicLabelSet, Gauge, GaugeF64, Histogram, HistogramSnapshot, LabelEnum, LabeledCounter,
    LabeledGauge, LabeledHistogram, LabeledSampledTimer, MaxGauge, MaxGaugeF64, MetricKind,
    MetricLabel, MetricLabels, MetricLabelsIter, MetricMeta, MetricVisitor, MinGauge, MinGaugeF64,
    SampledTimer, SampledTimerGuard,
};
#[cfg(feature = "eviction")]
pub use metric::{advance_cycle, current_cycle};
#[cfg(feature = "runtime")]
pub use runtime::{MetricScope, RegisteredMetrics, Runtime, RuntimeConfig};
pub use span::{
    CompletedSpan, Span, SpanAttribute, SpanCollector, SpanEvent, SpanId, SpanKind, SpanStatus,
    SpanValue, TraceId, current_span_id, current_trace_id,
};
pub use temporality::Temporality;

#[cfg(feature = "otlp")]
pub use export::otlp::OtlpExport;

#[cfg(feature = "clickhouse")]
pub use export::clickhouse::{ClickHouseExport, ClickHouseMetricBatch};

#[cfg(feature = "macros")]
pub use fast_telemetry_macros::{ExportMetrics, LabelEnum as DeriveLabel};

// Internal compatibility aliases for moved modules.
pub(crate) use internal::exp_buckets;
pub(crate) use internal::thread_id;
pub(crate) use metric::label;

#[cfg(feature = "otlp")]
pub mod otlp {
    pub use crate::export::otlp::*;
}

#[cfg(feature = "clickhouse")]
pub mod clickhouse {
    pub use crate::export::clickhouse::*;
}