pub struct ArclyObservabilityPlugin {
pub service_name: &'static str,
pub service_version: &'static str,
pub otlp_endpoint: &'static str,
}Expand description
Drop-in observability plugin. Add to App::launch_with_plugins to get
structured logs, Prometheus metrics, OTLP traces, and health endpoints
with zero changes to handler code.
Fields§
§service_name: &'static str§service_version: &'static str§otlp_endpoint: &'static strgRPC endpoint of the OTLP collector.
Example: "http://localhost:4317"
Trait Implementations§
Source§impl ArclyPlugin for ArclyObservabilityPlugin
impl ArclyPlugin for ArclyObservabilityPlugin
fn name(&self) -> &'static str
Source§fn on_init<'a>(
&'a mut self,
ctx: &'a mut ArclyPluginContext,
) -> BoxFuture<'a, Result<(), PluginError>>
fn on_init<'a>( &'a mut self, ctx: &'a mut ArclyPluginContext, ) -> BoxFuture<'a, Result<(), PluginError>>
Pre-bind. Register providers, routes, interceptors, openapi mutators.
The container is built AFTER every plugin’s
on_init returns.Source§fn on_shutdown<'a>(
&'a self,
_container: Arc<FrozenDiContainer>,
) -> BoxFuture<'a, Result<(), PluginError>>
fn on_shutdown<'a>( &'a self, _container: Arc<FrozenDiContainer>, ) -> BoxFuture<'a, Result<(), PluginError>>
Graceful shutdown. Invoked after the HTTP server has stopped
accepting new connections and all in-flight requests have drained.
Wrapped by
App in a per-plugin timeout (default 5s, configurable
via LaunchConfig::drain_budget) so a hung plugin can never wedge
the process or starve other plugins’ shutdown. Read moreSource§fn on_draining<'a>(
&'a self,
container: Arc<FrozenDiContainer>,
) -> BoxFuture<'a, Result<(), PluginError>>
fn on_draining<'a>( &'a self, container: Arc<FrozenDiContainer>, ) -> BoxFuture<'a, Result<(), PluginError>>
Drain started. Fired as soon as a shutdown signal is received,
concurrently with the HTTP in-flight drain (it does not delay the
listener closing). Stop accepting new work here — pause message-queue
consumers, schedulers, pollers — so plugin workloads quiesce while
HTTP connections drain. Cleanup itself belongs in
on_shutdown.Source§fn on_start<'a>(
&'a self,
container: Arc<FrozenDiContainer>,
) -> BoxFuture<'a, Result<(), PluginError>>
fn on_start<'a>( &'a self, container: Arc<FrozenDiContainer>, ) -> BoxFuture<'a, Result<(), PluginError>>
Post-bind. Listener is live and accepting. Background tasks spawn
here.
container resolves any provider — including ones the plugin
itself registered in on_init.Auto Trait Implementations§
impl Freeze for ArclyObservabilityPlugin
impl RefUnwindSafe for ArclyObservabilityPlugin
impl Send for ArclyObservabilityPlugin
impl Sync for ArclyObservabilityPlugin
impl Unpin for ArclyObservabilityPlugin
impl UnsafeUnpin for ArclyObservabilityPlugin
impl UnwindSafe for ArclyObservabilityPlugin
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
Mutably borrows from an owned value. Read more
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> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T in a tonic::Request