init4_bin_base/
lib.rs

1//! Shared utilities for Signet services.
2
3#![warn(
4    missing_copy_implementations,
5    missing_debug_implementations,
6    missing_docs,
7    unreachable_pub,
8    clippy::missing_const_for_fn,
9    rustdoc::all
10)]
11#![cfg_attr(not(test), warn(unused_crate_dependencies))]
12#![deny(unused_must_use, rust_2018_idioms)]
13#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
14
15#[cfg(feature = "perms")]
16/// Permissioning and authorization utilities for Signet builders.
17pub mod perms;
18
19/// Signet utilities.
20pub mod utils {
21    /// Slot calculator for determining the current slot and timepoint within a
22    /// slot.
23    pub mod calc;
24
25    /// [`FromEnv`], [`FromEnvVar`] traits and related utilities.
26    ///
27    /// [`FromEnv`]: from_env::FromEnv
28    /// [`FromEnvVar`]: from_env::FromEnvVar
29    pub mod from_env;
30
31    /// Prometheus metrics utilities.
32    pub mod metrics;
33
34    /// OpenTelemetry utilities.
35    pub mod otlp;
36
37    #[cfg(feature = "alloy")]
38    /// Signer using a local private key or AWS KMS key.
39    pub mod signer;
40
41    /// Tracing utilities.
42    pub mod tracing;
43}
44
45/// Re-exports of common dependencies.
46pub mod deps {
47    pub use metrics;
48    pub use opentelemetry;
49    pub use opentelemetry_otlp;
50    pub use opentelemetry_sdk;
51    pub use tracing;
52    pub use tracing_core;
53    pub use tracing_opentelemetry;
54    pub use tracing_subscriber;
55}
56
57/// Init metrics and tracing, including OTLP if enabled.
58///
59/// This will perform the following:
60/// - Read environment configuration for tracing
61/// - Determine whether to enable OTLP
62/// - Install a global tracing subscriber, using the OTLP provider if enabled
63/// - Read environment configuration for metrics
64/// - Install a global metrics recorder and serve it over HTTP on 0.0.0.0
65///
66/// See [`init_tracing`] and [`init_metrics`] for more
67/// details on specific actions taken and env vars read.
68///
69/// # Returns
70///
71/// The OpenTelemetry guard, if OTLP is enabled. This guard should be kept alive
72/// for the lifetime of the program to ensure the exporter continues to send
73/// data to the remote API.
74///
75/// [`init_tracing`]: utils::tracing::init_tracing
76/// [`init_metrics`]: utils::metrics::init_metrics
77pub fn init4() -> Option<utils::otlp::OtelGuard> {
78    let guard = utils::tracing::init_tracing();
79    utils::metrics::init_metrics();
80    guard
81}
init4_bin_base/lib.rs

init4_bin_base/
lib.rs
