Skip to content

Commit aabb2e9

Browse files
committed
refactor(coprocessor): align OTEL runtime naming
1 parent b140ece commit aabb2e9

File tree

8 files changed

+35
-35
lines changed

8 files changed

+35
-35
lines changed

coprocessor/fhevm-engine/fhevm-engine-common/src/telemetry.rs

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ use tracing::{debug, info, warn};
2121
pub const TXN_ID_ATTR_KEY: &str = "txn_id";
2222

2323
/// Calls provider shutdown exactly once when dropped.
24-
pub struct OtlpShutdownGuard {
24+
pub struct TracerProviderGuard {
2525
provider: Option<SdkTracerProvider>,
2626
}
2727

28-
impl OtlpShutdownGuard {
28+
impl TracerProviderGuard {
2929
fn new(provider: SdkTracerProvider) -> Self {
3030
Self {
3131
provider: Some(provider),
@@ -41,22 +41,22 @@ impl OtlpShutdownGuard {
4141
}
4242
}
4343

44-
impl Drop for OtlpShutdownGuard {
44+
impl Drop for TracerProviderGuard {
4545
fn drop(&mut self) {
4646
self.shutdown_once();
4747
}
4848
}
4949

5050
/// Runtime OTLP handles that must stay alive for the process lifetime.
51-
pub struct OtlpRuntime {
51+
pub struct OtelGuard {
5252
tracer: Option<opentelemetry_sdk::trace::Tracer>,
53-
_shutdown_guard: OtlpShutdownGuard,
53+
_shutdown_guard: TracerProviderGuard,
5454
}
5555

56-
impl OtlpRuntime {
56+
impl OtelGuard {
5757
fn new(
5858
tracer: Option<opentelemetry_sdk::trace::Tracer>,
59-
shutdown_guard: OtlpShutdownGuard,
59+
shutdown_guard: TracerProviderGuard,
6060
) -> Self {
6161
Self {
6262
tracer,
@@ -87,38 +87,38 @@ pub(crate) static ZKPROOF_TXN_LATENCY_HISTOGRAM: LazyLock<Histogram> = LazyLock:
8787
)
8888
});
8989

90-
pub fn init_otlp(
90+
pub fn init_otel(
9191
service_name: &str,
92-
) -> Result<Option<OtlpRuntime>, Box<dyn std::error::Error + Send + Sync + 'static>> {
92+
) -> Result<Option<OtelGuard>, Box<dyn std::error::Error + Send + Sync + 'static>> {
9393
if service_name.is_empty() {
9494
return Ok(None);
9595
}
9696

97-
let (_tracer, trace_provider) = build_otlp_tracer_and_provider(service_name, "otlp-layer")?;
98-
install_global_otel(trace_provider.clone());
99-
Ok(Some(OtlpRuntime::new(
97+
let (_tracer, trace_provider) = build_tracer_provider(service_name, "otlp-layer")?;
98+
install_global_tracer_provider(trace_provider.clone());
99+
Ok(Some(OtelGuard::new(
100100
None,
101-
OtlpShutdownGuard::new(trace_provider),
101+
TracerProviderGuard::new(trace_provider),
102102
)))
103103
}
104104

105-
pub fn init_otlp_tracing(
105+
pub fn init_otel_tracing(
106106
service_name: &str,
107107
tracer_name: &'static str,
108-
) -> Result<Option<OtlpRuntime>, Box<dyn std::error::Error + Send + Sync + 'static>> {
108+
) -> Result<Option<OtelGuard>, Box<dyn std::error::Error + Send + Sync + 'static>> {
109109
if service_name.is_empty() {
110110
return Ok(None);
111111
}
112112

113-
let (tracer, trace_provider) = build_otlp_tracer_and_provider(service_name, tracer_name)?;
114-
install_global_otel(trace_provider.clone());
115-
Ok(Some(OtlpRuntime::new(
113+
let (tracer, trace_provider) = build_tracer_provider(service_name, tracer_name)?;
114+
install_global_tracer_provider(trace_provider.clone());
115+
Ok(Some(OtelGuard::new(
116116
Some(tracer),
117-
OtlpShutdownGuard::new(trace_provider),
117+
TracerProviderGuard::new(trace_provider),
118118
)))
119119
}
120120

121-
fn build_otlp_tracer_and_provider(
121+
fn build_tracer_provider(
122122
service_name: &str,
123123
tracer_name: &'static str,
124124
) -> Result<
@@ -146,7 +146,7 @@ fn build_otlp_tracer_and_provider(
146146
Ok((tracer, trace_provider))
147147
}
148148

149-
fn install_global_otel(trace_provider: SdkTracerProvider) {
149+
fn install_global_tracer_provider(trace_provider: SdkTracerProvider) {
150150
opentelemetry::global::set_tracer_provider(trace_provider);
151151
}
152152

@@ -611,9 +611,9 @@ mod tests {
611611
use super::*;
612612

613613
#[test]
614-
fn otlp_shutdown_guard_shutdown_once_disarms_provider() {
614+
fn tracer_provider_guard_shutdown_once_disarms_provider() {
615615
let provider = SdkTracerProvider::builder().build();
616-
let mut guard = OtlpShutdownGuard::new(provider);
616+
let mut guard = TracerProviderGuard::new(provider);
617617
assert!(guard.provider.is_some());
618618

619619
guard.shutdown_once();
@@ -625,18 +625,18 @@ mod tests {
625625
}
626626

627627
#[test]
628-
fn otlp_runtime_keeps_tracer_when_present() {
628+
fn otel_guard_keeps_tracer_when_present() {
629629
let provider = SdkTracerProvider::builder().build();
630630
let tracer = provider.tracer("test-tracer");
631-
let runtime = OtlpRuntime::new(Some(tracer), OtlpShutdownGuard::new(provider));
631+
let runtime = OtelGuard::new(Some(tracer), TracerProviderGuard::new(provider));
632632

633633
assert!(runtime.tracer().is_some());
634634
}
635635

636636
#[test]
637-
fn otlp_runtime_handles_absent_tracer() {
637+
fn otel_guard_handles_absent_tracer() {
638638
let provider = SdkTracerProvider::builder().build();
639-
let runtime = OtlpRuntime::new(None, OtlpShutdownGuard::new(provider));
639+
let runtime = OtelGuard::new(None, TracerProviderGuard::new(provider));
640640

641641
assert!(runtime.tracer().is_none());
642642
}

coprocessor/fhevm-engine/gw-listener/src/bin/gw_listener.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ async fn main() -> anyhow::Result<()> {
108108
.with_max_level(conf.log_level)
109109
.init();
110110

111-
let _otlp_runtime = match telemetry::init_otlp(&conf.service_name) {
111+
let _otel_guard = match telemetry::init_otel(&conf.service_name) {
112112
Ok(runtime) => runtime,
113113
Err(err) => {
114114
error!(error = %err, "Failed to setup OTLP");

coprocessor/fhevm-engine/host-listener/src/cmd/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1024,7 +1024,7 @@ pub async fn main(args: Args) -> anyhow::Result<()> {
10241024
)
10251025
};
10261026

1027-
let _otlp_runtime = match telemetry::init_otlp(&args.service_name) {
1027+
let _otel_guard = match telemetry::init_otel(&args.service_name) {
10281028
Ok(runtime) => runtime,
10291029
Err(err) => {
10301030
error!(error = %err, "Failed to setup OTLP");

coprocessor/fhevm-engine/host-listener/src/poller/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ pub struct PollerConfig {
9090
}
9191

9292
pub async fn run_poller(config: PollerConfig) -> Result<()> {
93-
let _otlp_runtime = match telemetry::init_otlp(&config.service_name) {
93+
let _otel_guard = match telemetry::init_otel(&config.service_name) {
9494
Ok(runtime) => runtime,
9595
Err(err) => {
9696
warn!(error = %err, "Failed to setup OTLP");

coprocessor/fhevm-engine/sns-worker/src/bin/sns_worker.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ async fn main() {
6969

7070
let mut otlp_setup_error: Option<String> = None;
7171

72-
let otlp_runtime = match telemetry::init_otlp_tracing(&config.service_name, "otlp-layer") {
72+
let otel_guard = match telemetry::init_otel_tracing(&config.service_name, "otlp-layer") {
7373
Ok(runtime) => runtime,
7474
Err(err) => {
7575
otlp_setup_error = Some(err.to_string());
@@ -93,7 +93,7 @@ async fn main() {
9393
.with(level_filter)
9494
.with(fmt_layer);
9595

96-
if let Some(tracer) = otlp_runtime.as_ref().and_then(|runtime| runtime.tracer()) {
96+
if let Some(tracer) = otel_guard.as_ref().and_then(|runtime| runtime.tracer()) {
9797
let otel_layer = tracing_opentelemetry::layer().with_tracer(tracer);
9898
base.with(otel_layer).init();
9999
} else {

coprocessor/fhevm-engine/tfhe-worker/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ pub async fn async_main(
6565
let cancel_token = CancellationToken::new();
6666
info!(target: "async_main", args = ?args, "Starting runtime with args");
6767

68-
let _otlp_runtime = match telemetry::init_otlp(&args.service_name) {
68+
let _otel_guard = match telemetry::init_otel(&args.service_name) {
6969
Ok(runtime) => runtime,
7070
Err(err) => {
7171
error!(error = %err, "Failed to setup OTLP");

coprocessor/fhevm-engine/transaction-sender/src/bin/transaction_sender.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ async fn main() -> anyhow::Result<()> {
308308
}
309309
};
310310

311-
let _otlp_runtime = match telemetry::init_otlp(&conf.service_name) {
311+
let _otel_guard = match telemetry::init_otel(&conf.service_name) {
312312
Ok(runtime) => runtime,
313313
Err(err) => {
314314
error!(error = %err, "Failed to setup OTLP");

coprocessor/fhevm-engine/zkproof-worker/src/bin/zkproof_worker.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ async fn main() {
103103
pg_auto_explain_with_min_duration: args.pg_auto_explain_with_min_duration,
104104
};
105105

106-
let _otlp_runtime = match telemetry::init_otlp(&args.service_name) {
106+
let _otel_guard = match telemetry::init_otel(&args.service_name) {
107107
Ok(runtime) => runtime,
108108
Err(err) => {
109109
error!(error = %err, "Failed to setup OTLP");

0 commit comments

Comments
 (0)