Skip to content

Commit 9457bc9

Browse files
committed
editoast, gateway, osrdyne: remove custom configuration code for service name
Let's use the standard `OTEL_SERVICE_NAME`. Let's also put that configuration variable directly in the `Dockerfile`. Finally, remove the `enable` which is a leftover from b154bad. Signed-off-by: Jean SIMARD <woshilapin@tuziwo.info>
1 parent dec04f3 commit 9457bc9

12 files changed

+14
-45
lines changed

docker-compose.yml

-4
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,6 @@ services:
133133
OSRDYNE_API_URL: "http://osrd-osrdyne:4242/"
134134
TELEMETRY_KIND: "opentelemetry"
135135
TELEMETRY_ENDPOINT: "http://jaeger:4317"
136-
OTEL_SERVICE_NAME: "osrd-editoast"
137136
OSRD_MQ_URL: "amqp://osrd:password@osrd-rabbitmq:5672/%2f"
138137
command:
139138
- /bin/sh
@@ -154,8 +153,6 @@ services:
154153
args:
155154
OSRD_GIT_DESCRIBE: ${OSRD_GIT_DESCRIBE}
156155
CARGO_PROFILE: dev
157-
environment:
158-
OTEL_SERVICE_NAME: "osrd-gateway"
159156
volumes:
160157
- "./docker/gateway.dev.simple.toml:/gateway.toml"
161158
restart: unless-stopped
@@ -188,7 +185,6 @@ services:
188185
environment:
189186
RUST_LOG: "info"
190187
OSRDYNE__OPENTELEMETRY__ENDPOINT: "http://osrd-jaeger:4317"
191-
OSRDYNE__OPENTELEMETRY__SERVICE_NAME: "osrdyne"
192188

193189
jaeger:
194190
image: jaegertracing/jaeger:latest

docker/docker-compose.host.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,8 @@ services:
2828
volumes:
2929
- "./docker/gateway.dev.host.toml:/gateway.toml"
3030
environment:
31-
GATEWAY__TELEMETRY__TRACING__ENDPOINT: "http://localhost:4317"
32-
GATEWAY__TELEMETRY__TRACING__SERVICE_NAME: "osrd-gateway"
3331
GATEWAY__TELEMETRY__TRACING__TYPE: "Otlp"
32+
GATEWAY__TELEMETRY__TRACING__ENDPOINT: "http://localhost:4317"
3433

3534
osrd-images:
3635
ports: !reset []

docker/gateway.dev.host.toml

-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ secret_key = "NOT+A+SECRET++NOT+A+SECRET++NOT+A+SECRET++NOT+A+SECRET++NOT+A+SECR
77
listen_addr = "0.0.0.0"
88

99
[telemetry.tracing]
10-
enable = true
1110
endpoint = "http://localhost:4317"
1211

1312
[[targets]]

docker/gateway.dev.simple.toml

-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ allowed_origins = ["http://127.0.0.1:3000", "http://localhost:3000"]
99

1010
[telemetry.tracing]
1111
type = "Otlp"
12-
service_name = "osrd-gateway"
1312
endpoint = "http://osrd-jaeger:4317"
1413

1514
[[targets]]

docker/gateway.pr-tests.simple.toml

-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ listen_addr = "0.0.0.0"
88
port = 4001
99

1010
[telemetry.tracing]
11-
enable = true
1211
type = "Otlp"
13-
service_name = "gateway"
1412
endpoint = "http://osrd-jaeger-pr-tests:4319"
1513

1614

editoast/Dockerfile

+1
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ COPY --from=run_builder /editoast/assets /assets
6565

6666
ARG OSRD_GIT_DESCRIBE
6767
ENV OSRD_GIT_DESCRIBE=${OSRD_GIT_DESCRIBE}
68+
ENV OTEL_SERVICE_NAME="osrd-editoast"
6869
ENV DYNAMIC_ASSETS_PATH=/assets
6970

7071
# We use jemalloc to reduce allocation fragmentation

gateway/Dockerfile

+1
Original file line numberDiff line numberDiff line change
@@ -53,5 +53,6 @@ COPY --from=run_builder /usr/local/cargo/bin/osrd_gateway /usr/local/bin/osrd_ga
5353

5454
ARG OSRD_GIT_DESCRIBE
5555
ENV OSRD_GIT_DESCRIBE=${OSRD_GIT_DESCRIBE}
56+
ENV OTEL_SERVICE_NAME="osrd-gateway"
5657

5758
CMD ["/usr/local/bin/osrd_gateway"]

gateway/gateway.toml

-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ secret_key = "NOT+A+SECRET++NOT+A+SECRET++NOT+A+SECRET++NOT+A+SECRET++NOT+A+SECR
66

77
[telemetry.tracing]
88
type = "Otlp"
9-
enable = true
10-
service_name = "gateway"
119
endpoint = "http://localhost:4317"
1210

1311
[[targets]]

gateway/src/config.rs

+5-22
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,7 @@ impl Telemetry {
3333
#[serde(tag = "type")]
3434
pub enum TracingTelemetry {
3535
None,
36-
Otlp {
37-
endpoint: String,
38-
service_name: Option<String>,
39-
},
36+
Otlp { endpoint: String },
4037
}
4138

4239
#[derive(Deserialize, Serialize, Clone)]
@@ -47,7 +44,7 @@ pub enum Endpoint {
4744
}
4845

4946
impl TracingTelemetry {
50-
fn enable_otlp(&self, endpoint: &String, service_name: String) {
47+
fn enable_otlp(&self, endpoint: &String) {
5148
let exporter = opentelemetry_otlp::new_exporter()
5249
.tonic()
5350
.with_endpoint(endpoint)
@@ -56,18 +53,14 @@ impl TracingTelemetry {
5653

5754
info!("Tracing enabled with otlp");
5855

59-
let resource = opentelemetry_sdk::Resource::new(vec![opentelemetry::KeyValue::new(
60-
"service.name",
61-
service_name,
62-
)])
63-
.merge(&opentelemetry_sdk::Resource::from_detectors(
56+
let resource = opentelemetry_sdk::Resource::from_detectors(
6457
Duration::from_secs(10),
6558
vec![
6659
Box::new(SdkProvidedResourceDetector),
6760
Box::new(TelemetryResourceDetector),
6861
Box::new(EnvResourceDetector::new()),
6962
],
70-
));
63+
);
7164
let provider = TracerProvider::builder()
7265
.with_config(opentelemetry_sdk::trace::Config::default().with_resource(resource))
7366
.with_batch_exporter(exporter, TokioCurrentThread)
@@ -78,18 +71,8 @@ impl TracingTelemetry {
7871
}
7972

8073
pub fn enable_providers(&self) {
81-
let service_name = match self {
82-
TracingTelemetry::None => {
83-
info!("Tracing disabled");
84-
return;
85-
}
86-
TracingTelemetry::Otlp { service_name, .. } => {
87-
service_name.clone().unwrap_or("osrd-gateway".to_string())
88-
}
89-
};
90-
9174
if let TracingTelemetry::Otlp { endpoint, .. } = self {
92-
self.enable_otlp(endpoint, service_name);
75+
self.enable_otlp(endpoint);
9376
}
9477
}
9578
}

osrdyne/Dockerfile

+1
Original file line numberDiff line numberDiff line change
@@ -53,5 +53,6 @@ COPY --from=run_builder /usr/local/cargo/bin/osrdyne /usr/local/bin/osrdyne
5353

5454
ARG OSRD_GIT_DESCRIBE
5555
ENV OSRD_GIT_DESCRIBE=${OSRD_GIT_DESCRIBE}
56+
ENV OTEL_SERVICE_NAME="osrd-osrdyne"
5657

5758
CMD ["/usr/local/bin/osrdyne"]

osrdyne/src/config.rs

-2
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,12 @@ pub struct OsrdyneConfig {
4040

4141
#[derive(Debug, Deserialize, Serialize)]
4242
pub struct OpentelemetryConfig {
43-
pub service_name: Option<String>,
4443
pub endpoint: Url,
4544
}
4645

4746
impl Default for OpentelemetryConfig {
4847
fn default() -> Self {
4948
Self {
50-
service_name: None,
5149
endpoint: "http://jaeger:4317".parse().unwrap(),
5250
}
5351
}

osrdyne/src/main.rs

+5-9
Original file line numberDiff line numberDiff line change
@@ -231,20 +231,14 @@ fn init_tracing(config: &OsrdyneConfig) {
231231
.tonic()
232232
.with_endpoint(otel.endpoint.as_str());
233233

234-
let svc_name = otel.service_name.clone().unwrap_or("osrdyne".to_string());
235-
236-
let resource = opentelemetry_sdk::Resource::new(vec![opentelemetry::KeyValue::new(
237-
opentelemetry_semantic_conventions::resource::SERVICE_NAME,
238-
svc_name.clone(),
239-
)])
240-
.merge(&opentelemetry_sdk::Resource::from_detectors(
234+
let resource = opentelemetry_sdk::Resource::from_detectors(
241235
Duration::from_secs(10),
242236
vec![
243237
Box::new(SdkProvidedResourceDetector),
244238
Box::new(TelemetryResourceDetector),
245239
Box::new(EnvResourceDetector::new()),
246240
],
247-
));
241+
);
248242
let trace_config = opentelemetry_sdk::trace::Config::default().with_resource(resource);
249243

250244
let otlp_tracer_provider = opentelemetry_otlp::new_pipeline()
@@ -254,7 +248,9 @@ fn init_tracing(config: &OsrdyneConfig) {
254248
.install_batch(opentelemetry_sdk::runtime::Tokio)
255249
.expect("Failed to initialize Opentelemetry tracer");
256250

257-
let otlp_tracer = otlp_tracer_provider.tracer(svc_name.clone());
251+
let otlp_tracer = otlp_tracer_provider.tracer(
252+
std::env::var("OTEL_SERVICE_NAME").unwrap_or_else(|_| String::from("osrd-osrdyne")),
253+
);
258254

259255
let layer = tracing_opentelemetry::layer()
260256
.with_tracer(otlp_tracer)

0 commit comments

Comments
 (0)