pub struct EmbeddedTelemetryRuntime { /* private fields */ }Expand description
One-owner embedded runtime suitable for a local node telemetry deployment.
Opening the runtime performs all WAL, index, catalog, and metric-accumulator
recovery synchronously. Call Self::mark_ready only after the host has
attached its exporters, then call Self::drain before dropping the last
runtime reference during shutdown.
Implementations§
Source§impl EmbeddedTelemetryRuntime
impl EmbeddedTelemetryRuntime
Sourcepub fn open(config: EmbeddedTelemetryConfig) -> Result<Self, LokiApiError>
pub fn open(config: EmbeddedTelemetryConfig) -> Result<Self, LokiApiError>
Opens and recovers the local durable store. The data directory remains exclusively owned until this runtime and all store clones are dropped.
Sourcepub fn attach<T>(
&self,
attach: impl FnOnce() -> Result<T, LokiApiError>,
) -> Result<T, LokiApiError>
pub fn attach<T>( &self, attach: impl FnOnce() -> Result<T, LokiApiError>, ) -> Result<T, LokiApiError>
Runs an exporter-attachment operation while the runtime is not yet ready.
A failed operation leaves the runtime unavailable, so callers cannot accidentally start a partially attached embedded node.
Sourcepub fn mark_ready(&self) -> Result<(), LokiApiError>
pub fn mark_ready(&self) -> Result<(), LokiApiError>
Marks the recovered, fully attached runtime ready for host traffic.
Sourcepub fn state(&self) -> EmbeddedTelemetryState
pub fn state(&self) -> EmbeddedTelemetryState
Returns the current lifecycle state.
Sourcepub fn query_native(
&self,
query: &NativeQuery,
) -> Result<Vec<LokiEntry>, LokiApiError>
pub fn query_native( &self, query: &NativeQuery, ) -> Result<Vec<LokiEntry>, LokiApiError>
Queries the recovered embedded log index without exposing a writable store handle that could bypass this runtime’s drain gate.
Sourcepub fn query_traces(
&self,
query: &TraceQuery,
) -> Result<Vec<DurableSpan>, LokiApiError>
pub fn query_traces( &self, query: &TraceQuery, ) -> Result<Vec<DurableSpan>, LokiApiError>
Queries the recovered embedded trace index without exposing writable ingestion APIs outside the lifecycle gate.
Sourcepub fn query_metrics(
&self,
query: &MetricQuery,
) -> Result<Vec<DurableMetricPoint>, LokiApiError>
pub fn query_metrics( &self, query: &MetricQuery, ) -> Result<Vec<DurableMetricPoint>, LokiApiError>
Queries the recovered embedded metric index without exposing writable ingestion APIs outside the lifecycle gate.
Sourcepub fn query_lifetime_metric_rollups(
&self,
tenant: &str,
name: Option<&str>,
) -> Result<Vec<LifetimeMetricRollup>, LokiApiError>
pub fn query_lifetime_metric_rollups( &self, tenant: &str, name: Option<&str>, ) -> Result<Vec<LifetimeMetricRollup>, LokiApiError>
Returns durable lifetime metric outcomes without reading evicted raw records or contacting the configured object tier.
Sourcepub fn append_log_events(
&self,
tenant: &str,
events: Vec<OtlpLogEvent>,
wait_for_index: bool,
) -> Result<NativeTelemetryAppendAck, LokiApiError>
pub fn append_log_events( &self, tenant: &str, events: Vec<OtlpLogEvent>, wait_for_index: bool, ) -> Result<NativeTelemetryAppendAck, LokiApiError>
Directly appends normalized logs to this process’s embedded store.
This is an in-process fast path: it performs signal routing and the required WAL-envelope encoding, but does not create a native protocol frame, serialize a native batch, open a socket, or decode the same data again. Call it from a bounded exporter worker, not from an application logging call site.
Sourcepub fn append_trace_events(
&self,
events: Vec<OtlpSpanEvent>,
wait_for_index: bool,
) -> Result<NativeTelemetryAppendAck, LokiApiError>
pub fn append_trace_events( &self, events: Vec<OtlpSpanEvent>, wait_for_index: bool, ) -> Result<NativeTelemetryAppendAck, LokiApiError>
Directly appends normalized spans to this process’s embedded store.
The spans have already passed OTLP validation. This path routes them by trace identity and writes their durable envelopes without a local protocol round trip. Invoke it from a bounded exporter worker rather than an application tracing call site.
Sourcepub fn append_metric_point(
&self,
point: DurableMetricPoint,
wait_for_index: bool,
) -> Result<NativeTelemetryAppendAck, LokiApiError>
pub fn append_metric_point( &self, point: DurableMetricPoint, wait_for_index: bool, ) -> Result<NativeTelemetryAppendAck, LokiApiError>
Directly appends normalized metrics to this process’s embedded store.
The metric points retain their native labels, histograms, resource, and
scope identity without an OTLP or native-protocol round trip. It is the
intended target for periodic fast-telemetry snapshot export; counter
and histogram updates themselves must remain independent of this call.
Sourcepub fn append_metric_points(
&self,
points: Vec<DurableMetricPoint>,
wait_for_index: bool,
) -> Result<NativeTelemetryAppendAck, LokiApiError>
pub fn append_metric_points( &self, points: Vec<DurableMetricPoint>, wait_for_index: bool, ) -> Result<NativeTelemetryAppendAck, LokiApiError>
Directly appends normalized metrics to this process’s embedded store.
The metric points retain their native labels, histograms, resource, and
scope identity without an OTLP or native-protocol round trip. It is the
intended target for periodic fast-telemetry snapshot export; counter
and histogram updates themselves must remain independent of this call.
Sourcepub fn compact_retention(&self) -> Result<RetentionReport, LokiApiError>
pub fn compact_retention(&self) -> Result<RetentionReport, LokiApiError>
Flushes pending local blocks and reclaims complete WAL/object groups older than the configured retention window.
Logical queries enforce the cutoff immediately. Hosts should call this periodically (for example, once per minute for a 5–60 minute window) so physical SSD usage tracks that logical window.
Sourcepub fn drain(&self) -> Result<(), LokiApiError>
pub fn drain(&self) -> Result<(), LokiApiError>
Stops new host work and flushes every current durable boundary.
The caller remains responsible for stopping its producers before this method, because producer ownership is intentionally outside this generic runtime.
Trait Implementations§
Auto Trait Implementations§
impl !Freeze for EmbeddedTelemetryRuntime
impl !RefUnwindSafe for EmbeddedTelemetryRuntime
impl !UnwindSafe for EmbeddedTelemetryRuntime
impl Send for EmbeddedTelemetryRuntime
impl Sync for EmbeddedTelemetryRuntime
impl Unpin for EmbeddedTelemetryRuntime
impl UnsafeUnpin for EmbeddedTelemetryRuntime
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> FutureExt for T
impl<T> FutureExt for T
Source§fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
Source§fn with_current_context(self) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a tonic::Request