editoast: setup tracing with opentelemetry for `TestApp` #10122

hamz2a · 2024-12-18T12:00:45Z

I added the OpenTelemetry layer in TestApp to capture the trace_id set in the header, so we can test the endpoint we'll add in the ticket.

Refactored init_tracing to accept a custom SpanExporter for better flexibility, including support for testing scenarios.
Updated main.rs to configure and initialize tracing.
Modified setup tracing in test_app.rs to use opentelemetry layer.

codecov-commenter · 2024-12-18T12:03:22Z

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 86.66667% with 8 lines in your changes missing coverage. Please review.

Project coverage is 81.45%. Comparing base (6a105bf) to head (72ae856).

Files with missing lines	Patch %	Lines
editoast/src/client/telemetry_config.rs	0.00%	6 Missing ⚠️
editoast/editoast_common/src/tracing.rs	96.00%	2 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##              dev   #10122      +/-   ##
==========================================
+ Coverage   79.93%   81.45%   +1.51%     
==========================================
  Files        1057     1058       +1     
  Lines      106302   104318    -1984     
  Branches      724      724              
==========================================
- Hits        84977    84971       -6     
+ Misses      21283    19305    -1978     
  Partials       42       42

Flag	Coverage Δ
editoast	`73.60% <86.66%> (-0.32%)`	⬇️
front	`89.19% <ø> (ø)`
gateway	`2.18% <ø> (ø)`
osrdyne	`3.28% <ø> (ø)`
railjson_generator	`87.50% <ø> (ø)`
tests	`87.00% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

woshilapin

Thank you for the PR. Let's see if we can improve it.

editoast/src/main.rs

editoast/Cargo.toml

editoast/src/main.rs

leovalais

Thanks for this PR. A few comments about architecture and test isolation. Besides, with the context of what you're working on I suppose this is about collecting logs for unit testing, but it's not clear to me how that would work. Why does printing logs on stdout help? Do you plan to capture the stream? A bit more context in the PR description or in the related issue would help.

editoast/Cargo.toml

leovalais · 2024-12-19T13:48:41Z

editoast/src/views/test_app.rs

+    client::{TelemetryConfig, TelemetryKind},
    core::{mocking::MockingClient, CoreClient},
    generated_data::speed_limit_tags_config::SpeedLimitTagIds,
    infra_cache::InfraCache,
    map::MapLayers,
+    try_init_tracing,
    valkey_utils::ValkeyConfig,
-    AppState, ValkeyClient,
+    AppState, EditoastMode, ValkeyClient,


Wrong dependency order. We want client and bin editoast to depend on views

Got it, but I need these structs for init_tracing in test_app:

let telemetry_config = TelemetryConfig { telemetry_kind: TelemetryKind::Opentelemetry, ..Default::default() }; let sub = init_tracing(EditoastMode::Webservice, &telemetry_config, exporter); let tracing_guard = tracing::subscriber::set_default(sub);

Any suggestions on how to better isolate this?

You could move init_tracing in editoast_common, but EditoastMode and the telemetry_config do not make sense there. You'll need some kind of mapping.

I’ve updated the function signature for create_tracing_subscriber to the following:

pub fn create_tracing_subscriber<T: SpanExporter + 'static>( mode: Option<EditoastMode>, telemetry_config: Option<TelemetryConfig>, exporter: T, ) -> impl tracing::Subscriber

I believe it adds more flexibility. what do you think?

I'm not entirely convinced 😕

This does not solves the dependency problem: the function is still imported in views from the crate level.

We have two calls to that function and we know each time which mode and config we want. So there's no need for flexibility when 100% of our usage do not require that.

I'd argue that hiding a parameter behind a None degrades readability: now we have to look inside the function to find the actual values of the parameters, both of them not having an obvious default value.

Wdyt?

I’ve updated the code based on your feedback. Please verify if the changes align with your suggestions. @leovalais

editoast/src/views/test_app.rs

hamz2a · 2024-12-19T14:23:23Z

Thanks for this PR. A few comments about architecture and test isolation. Besides, with the context of what you're working on I suppose this is about collecting logs for unit testing, but it's not clear to me how that would work. Why does printing logs on stdout help? Do you plan to capture the stream? A bit more context in the PR description or in the related issue would help.

Apologies for that. I've added more details in the description, and I hope it helps clarify things.

leovalais · 2024-12-19T14:40:08Z

I added the OpenTelemetry layer in TestApp to capture the trace_id set in the header, so we can test the endpoint we'll add in the #9724.

Thanks for adding some context. So if I get it right, the point is not to necessarily print on stdout, but rather to setup OpenTelemetry so that the request header can be read. The fact that it prints on stdout is irrelevant, or am I missing smth?

I'm surely lacking OpenTelemetry and tracing knowledge, but I still don't understand what setting up a span exporter has to do with reading the HTTP request headers? Especially since the middleware OtelAxumLayer::default() is set in the TestApp.

hamz2a · 2024-12-19T14:49:40Z

Thanks for adding some context. So if I get it right, the point is not to necessarily print on stdout, but rather to setup OpenTelemetry so that the request header can be read. The fact that it prints on stdout is irrelevant, or am I missing smth?

I'm surely lacking OpenTelemetry and tracing knowledge, but I still don't understand what setting up a span exporter has to do with reading the HTTP request headers? Especially since the middleware OtelAxumLayer::default() is set in the TestApp.

You're right, printing to stdout is irrelevant.
The goal is to have the same init_tracing setup for both editoast webservice and TestApp. That's why I kept the same configuration. @woshilapin, do you confirm?

woshilapin · 2024-12-20T10:09:37Z

I'm surely lacking OpenTelemetry and tracing knowledge, but I still don't understand what setting up a span exporter has to do with reading the HTTP request headers? Especially since the middleware OtelAxumLayer::default() is set in the TestApp.

@leovalais From what I understand, OtelAxumLayer emits span events, the SpanExporter is used in the subscriber to these events and will consume these span events to export them somewhere (to Datadog, to stdout, etc.). But you're right, we shouldn't need opentelemetry_stdout since we already have the tracing::layer::fmt() configured, which prints to the terminal.

But as said by @hamz2a, one of the main idea of this PR is to have a similar setup of the subscriber for tests and for production code. We had a hard time debugging what was not working and part of it was that it was working well with a cargo run -- runserver but not with cargo test, and some of the problems came from this difference between production code and tests.

editoast/src/views/test_app.rs

editoast/Cargo.toml

woshilapin

I believe it's in a much better state now 🚀. Thank you 🎉

editoast/Cargo.toml

editoast/src/main.rs

leovalais

Almost there, thanks for the changes! There's still a dependency order issue, but apart from that, lgtm.

leovalais · 2024-12-26T13:53:39Z

editoast/src/views/test_app.rs

 use serde::de::DeserializeOwned;
 use tower_http::trace::TraceLayer;
 use url::Url;

 use crate::{
    core::{mocking::MockingClient, CoreClient},
+    create_tracing_subscriber,


This is the import that breaks the dependency order. views cannot use something from the crate or client level. I'd suggest moving create_tracing_subscriber to editoast_common.

leovalais · 2024-12-26T14:43:55Z

si je bouge create_tracing_subscriber je dois bouger aussi
   mode: EditoastMode,
   telemetry_config: TelemetryConfig,

Yes, but TelemetryConfig is a clap definition and EditoastMode doesn't make sense outside of the CLI. I'd suggest making a new struct for configuration:

struct TracingConfig {
   stream: enum { Stderr, Stdout },
   telemetry: Option<struct {
		service_name: String,
		telemetry_endpoint: Url
	}>
}

Wdyt?

Signed-off-by: hamz2a <[email protected]>

leovalais

LGTM, thanks for all the modifications!

leovalais · 2024-12-27T19:29:18Z

editoast/src/main.rs

@@ -66,61 +58,18 @@ pub use valkey_utils::ValkeyConnection;
 /// - we *expect* a webserver to output logging information, so since it's an expected
 ///   output (and not extra information), it should be on stdout
 #[derive(Debug, PartialEq)]
-enum EditoastMode {
+pub enum EditoastMode {


Suggested change

pub enum EditoastMode {

enum EditoastMode {

leovalais · 2024-12-27T19:30:21Z

editoast/src/views/mod.rs

@@ -22,7 +22,7 @@ pub mod train_schedule;
 pub mod work_schedules;

 #[cfg(test)]
-mod test_app;
+pub mod test_app;


Suggested change

pub mod test_app;

mod test_app;

leovalais · 2024-12-27T20:17:54Z

editoast/src/views/test_app.rs

-            )
-            .with_span_events(tracing_subscriber::fmt::format::FmtSpan::CLOSE)
-            .finish();
+        let sub = create_tracing_subscriber(TracingConfig::default(), NoopSpanExporter);


Suggested change

let sub = create_tracing_subscriber(TracingConfig::default(), NoopSpanExporter);

let sub = create_tracing_subscriber(TracingConfig {

...

}, NoopSpanExporter);

Could the default value be built here? This way we gather all default test constants here instead of having them scattered across different crates. The impl Default and derive(Derivative) from common::tracing can be removed.

hamz2a requested a review from a team as a code owner December 18, 2024 12:00

github-actions bot added the area:editoast Work on Editoast Service label Dec 18, 2024

hamz2a requested a review from woshilapin December 18, 2024 12:01

hamz2a changed the title ~~editoast: setup tracing with opentelemetry for TestApp~~ editoast: setup tracing with opentelemetry for TestApp Dec 18, 2024

hamz2a force-pushed the hai/editoast-setup-tracing-with-opentelemetry-for-test-app branch from c5b5f96 to 8a7a2ad Compare December 18, 2024 12:14

woshilapin reviewed Dec 18, 2024

View reviewed changes

editoast/src/main.rs Outdated Show resolved Hide resolved

editoast/Cargo.toml Outdated Show resolved Hide resolved

hamz2a force-pushed the hai/editoast-setup-tracing-with-opentelemetry-for-test-app branch from 8a7a2ad to c361ea8 Compare December 18, 2024 14:32

hamz2a requested a review from woshilapin December 18, 2024 14:34

woshilapin reviewed Dec 18, 2024

View reviewed changes

editoast/src/main.rs Outdated Show resolved Hide resolved

editoast/src/main.rs Outdated Show resolved Hide resolved

hamz2a force-pushed the hai/editoast-setup-tracing-with-opentelemetry-for-test-app branch from c361ea8 to b5ff13b Compare December 18, 2024 16:31

hamz2a requested review from woshilapin and leovalais December 18, 2024 16:33

leovalais requested changes Dec 19, 2024

View reviewed changes

hamz2a force-pushed the hai/editoast-setup-tracing-with-opentelemetry-for-test-app branch from b5ff13b to 4492eb8 Compare December 20, 2024 14:56

hamz2a requested a review from leovalais December 20, 2024 15:02

woshilapin reviewed Dec 20, 2024

View reviewed changes

editoast/src/views/test_app.rs Outdated Show resolved Hide resolved

editoast/src/views/test_app.rs Outdated Show resolved Hide resolved

hamz2a force-pushed the hai/editoast-setup-tracing-with-opentelemetry-for-test-app branch from 4492eb8 to 112a5c5 Compare December 20, 2024 16:22

hamz2a requested a review from woshilapin December 20, 2024 16:23

woshilapin reviewed Dec 21, 2024

View reviewed changes

editoast/Cargo.toml Outdated Show resolved Hide resolved

woshilapin approved these changes Dec 21, 2024

View reviewed changes

hamz2a force-pushed the hai/editoast-setup-tracing-with-opentelemetry-for-test-app branch 2 times, most recently from 9d9e553 to 373cf12 Compare December 23, 2024 10:36

leovalais requested changes Dec 23, 2024

View reviewed changes

editoast/Cargo.toml Outdated Show resolved Hide resolved

editoast/src/main.rs Outdated Show resolved Hide resolved

hamz2a force-pushed the hai/editoast-setup-tracing-with-opentelemetry-for-test-app branch from 373cf12 to 45217d4 Compare December 23, 2024 14:42

hamz2a requested a review from leovalais December 23, 2024 14:45

hamz2a force-pushed the hai/editoast-setup-tracing-with-opentelemetry-for-test-app branch 2 times, most recently from 033cbc3 to 5c49d18 Compare December 24, 2024 10:24

leovalais requested changes Dec 26, 2024

View reviewed changes

hamz2a force-pushed the hai/editoast-setup-tracing-with-opentelemetry-for-test-app branch from 5c49d18 to 4418d21 Compare December 26, 2024 17:42

hamz2a requested a review from leovalais December 26, 2024 17:42

editoast: setup tracing with opentelemetry for TestApp

72ae856

Signed-off-by: hamz2a <[email protected]>

hamz2a force-pushed the hai/editoast-setup-tracing-with-opentelemetry-for-test-app branch from 4418d21 to 72ae856 Compare December 26, 2024 17:52

leovalais approved these changes Dec 27, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

editoast: setup tracing with opentelemetry for `TestApp` #10122

editoast: setup tracing with opentelemetry for `TestApp` #10122

hamz2a commented Dec 18, 2024 •

edited

Loading

codecov-commenter commented Dec 18, 2024 •

edited

Loading

woshilapin left a comment

leovalais left a comment

leovalais Dec 19, 2024

hamz2a Dec 20, 2024

leovalais Dec 23, 2024

hamz2a Dec 23, 2024

leovalais Dec 23, 2024

hamz2a Dec 24, 2024 •

edited

Loading

hamz2a commented Dec 19, 2024

leovalais commented Dec 19, 2024

hamz2a commented Dec 19, 2024

woshilapin commented Dec 20, 2024 •

edited

Loading

woshilapin left a comment

leovalais left a comment

leovalais Dec 26, 2024

leovalais commented Dec 26, 2024

leovalais left a comment

leovalais Dec 27, 2024

leovalais Dec 27, 2024

leovalais Dec 27, 2024

-        let sub = create_tracing_subscriber(TracingConfig::default(), NoopSpanExporter);
+        let sub = create_tracing_subscriber(TracingConfig {
+        	...
+        }, NoopSpanExporter);

editoast: setup tracing with opentelemetry for TestApp #10122

Are you sure you want to change the base?

editoast: setup tracing with opentelemetry for TestApp #10122

Conversation

hamz2a commented Dec 18, 2024 • edited Loading

codecov-commenter commented Dec 18, 2024 • edited Loading

Codecov Report

woshilapin left a comment

Choose a reason for hiding this comment

leovalais left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hamz2a Dec 24, 2024 • edited Loading

Choose a reason for hiding this comment

hamz2a commented Dec 19, 2024

leovalais commented Dec 19, 2024

hamz2a commented Dec 19, 2024

woshilapin commented Dec 20, 2024 • edited Loading

woshilapin left a comment

Choose a reason for hiding this comment

leovalais left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

leovalais commented Dec 26, 2024

leovalais left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

editoast: setup tracing with opentelemetry for `TestApp` #10122

editoast: setup tracing with opentelemetry for `TestApp` #10122

hamz2a commented Dec 18, 2024 •

edited

Loading

codecov-commenter commented Dec 18, 2024 •

edited

Loading

hamz2a Dec 24, 2024 •

edited

Loading

woshilapin commented Dec 20, 2024 •

edited

Loading