Skip to main content

ClickHouseMetricsBackend

Struct ClickHouseMetricsBackend 

Source
pub struct ClickHouseMetricsBackend(/* private fields */);
Expand description

Remote ClickHouse metrics storage.

connect opens the ClickHouse client and creates the Spectra metrics table when needed. A running Spectra instance requires both this backend and ClickHouseEventsBackend; remote storage does not use .embedded().

§Examples

Facade wiring through Spectra::builder() (requires the spectra crate with the clickhouse feature):

use std::sync::Arc;
use spectra::{ClickHouseEventsBackend, ClickHouseMetricsBackend, Spectra};

let url = "http://127.0.0.1:8123";
let spectra = Spectra::builder()
    .metrics_backend(Arc::new(ClickHouseMetricsBackend::connect(url).await?))
    .events_backend(Arc::new(ClickHouseEventsBackend::connect(url).await?))
    .build()?;

Implementations§

Source§

impl ClickHouseMetricsBackend

Source

pub async fn connect(url: &str) -> Result<ClickHouseMetricsBackend, Error>

Connect to ClickHouse over HTTP or native protocol and ensure metrics tables exist.

url is typically http://host:8123. The call is async and executes DDL, so the ClickHouse credentials need table-creation permission.

§Examples
use spectra_backend_clickhouse::ClickHouseMetricsBackend;

let backend = ClickHouseMetricsBackend::connect("http://127.0.0.1:8123").await?;
Source

pub fn in_memory_stub() -> ClickHouseMetricsBackend

In-memory stub that preserves the ClickHouse engine type for storage-contract tests.

§Examples
use spectra_backend_clickhouse::ClickHouseMetricsBackend;
use spectra_core::{MetricsStorageBackend, StorageEngineType};

let backend = ClickHouseMetricsBackend::in_memory_stub();
assert_eq!(backend.engine_type(), StorageEngineType::ClickHouse);

Trait Implementations§

Source§

impl MetricsStorageBackend for ClickHouseMetricsBackend

Source§

fn engine_type(&self) -> StorageEngineType

Returns the engine type for this backend.
Source§

fn record_counter<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, name: &'life1 str, labels: &'life2 Value, delta: i64, ts: DateTime<Utc>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, ClickHouseMetricsBackend: 'async_trait,

Records a counter increment.
Source§

fn record_gauge<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, name: &'life1 str, labels: &'life2 Value, value: f64, ts: DateTime<Utc>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, ClickHouseMetricsBackend: 'async_trait,

Records a gauge sample.
Source§

fn record_metrics_batch<'life0, 'life1, 'async_trait>( &'life0 self, rows: &'life1 [MetricWriteRow], ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, ClickHouseMetricsBackend: 'async_trait,

Batch write metrics (default: per-row dispatch).
Source§

fn query_range<'life0, 'async_trait>( &'life0 self, query: MetricsQueryRange, ) -> Pin<Box<dyn Future<Output = Result<Vec<MetricPoint>, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, ClickHouseMetricsBackend: 'async_trait,

Queries a time range of metric points.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<U> As for U

Source§

fn as_<T>(self) -> T
where T: CastFrom<U>, U: Sized,

Casts self to type T. The semantics of numeric casting with the as operator are followed, so <T as As>::as_::<U> can be used in the same way as T as U for numeric conversions. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Is for T
where T: ?Sized,

Source§

type EqTo = T

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more