feat: Add tracing support by DanielVoogsgerd · Pull Request #123 · BraneFramework/brane

DanielVoogsgerd · 2024-08-29T12:08:15Z

This uses the tracing_subscriber with EnvFilter to get log levels that can be set using environment variables.

This also enables branectl to translate a set of environment variables so that every container can get a specific log level set at start

This currently only changes the logging for the brane-api crate as an indication what this would look like.

I am not entirely happy with my solution for the env var translation in branectl, but it is good enough for a draft right now.

@Lut99, what do you think?

Marking this PR as a draft until we hash out how we want to do this, and until all workspace members have been converted.

Fixes: #116

brane-ctl/src/lifetime.rs

Lut99 · 2024-09-02T12:49:33Z

brane-ctl/src/lifetime.rs

    Ok(())
 }

-


Tssk, someone is removing all by formatting whitespace :P

Lut99 · 2024-09-02T13:02:14Z

I'm trying to check out how it looks like, but it seems like the output of brane-api isn't very verbose by default. How can I change it? I tried

BRANE_API_LOG=DEBUG ./target/release/branectl start central

or, to try and trigger your tracing error:

BRANE_LOG=DaskjdhasdEBUG ./target/release/branectl start central

but none of them seem to have any effect on brane-apis deployment, nor do they print!() anything.

Maybe there's something weird with caching here? branectl is a little awkward in these /tmp/docker-compose-*.yml file it generates and then (never?) updates them again. But even so, removing the file and re-running has no effect.

DanielVoogsgerd · 2024-10-08T10:31:58Z

I forgot to remove an optimization that it would not generate an overlay if there were no hostname overrides. This did not fail for me before as I used to always set host.docker.internal.

It should "work" now.

Don't expect too much however, it is still very drafty.

brane-ctl/src/lifetime.rs

brane-ast/src/ast.rs

-        if log::max_level() == log::LevelFilter::Debug {
-            crate::traversals::print::ast::do_traversal(&workflow, std::io::stdout()).unwrap();
-        }
+        // TODO: Implement tracing


brane-cli-c/src/lib.rs

-        if let Err(err) = HumanLogger::terminal(DebugMode::Debug).init() {
-            eprintln!("WARNING: Failed to setup Rust logger: {err} (logging disabled for this session)");
-        }
+        // TODO: Set up tracing


brane-ctl/src/main.rs

                args.node_config,
                DockerOptions { socket: docker_socket, version: docker_version },
-                StartOpts { compose_verbose: args.debug || args.trace, version, image_dir, local_aux, skip_import, profile_dir },
+                // FIXME: Drop compose verbose?


brane-ctl/src/main.rs

        },
        CtlSubcommand::Stop { exe, file } => {
-            if let Err(err) = lifetime::stop(args.debug || args.trace, exe, file, args.node_config) {
+            // FIXME: Drop compose verbose?


brane-ctl/src/main.rs

        },
        CtlSubcommand::Logs { exe, file } => {
-            if let Err(err) = lifetime::logs(exe, file, args.node_config, LogsOpts { compose_verbose: args.debug || args.trace }).await {
+            // FIXME: Drop compose verbose?


brane-log/src/main.rs

+#[derive(Parser)]
+#[clap(version = env!("CARGO_PKG_VERSION"))]
+struct Opts {
+    #[clap(short, long, default_value = "127.0.0.1:8081", env = "ADDRESS")]


brane-log/src/main.rs

+    /// Service address
+    address: String,
+    /// Scylla endpoint
+    #[clap(short, long, default_value = "127.0.0.1", env = "SCYLLA")]


brane-log/src/main.rs

+    #[clap(short, long, default_value = "127.0.0.1", env = "SCYLLA")]
+    scylla: String,
+    /// Kafka brokers
+    #[clap(short, long, default_value = "127.0.0.1:9092", env = "BROKERS")]


brane-log/src/main.rs

+    }))
+    .map(|reply| {
+        // TODO#584: remove this workaround
+        warp::reply::with_header(reply, "Sec-WebSocket-Protocol", "graphql-ws")


brane-shr/src/utilities.rs

-            eprintln!("WARNING: Failed to setup test logger: {err} (no logging for this session)");
-        }
-    }
+    // TODO: Set up tracing subscriber


This uses the `tracing_subscriber` with `EnvFilter` to get log levels that can be set using environment variables. This also enables `branectl` to translate a set of environment variables so that every container can get a specific log level set at start

This guard clause was a correct optimization before we set loglevels via overrides

codecov · 2025-04-11T20:44:45Z

Codecov Report

Attention: Patch coverage is 1.26582% with 156 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
brane-ctl/src/lifetime.rs	0.00%	59 Missing ⚠️
specifications/src/brane.rs	0.00%	54 Missing ⚠️
specifications/src/cli.rs	0.00%	25 Missing ⚠️
specifications/src/tracing.rs	0.00%	13 Missing ⚠️
brane-cli/src/run.rs	0.00%	2 Missing ⚠️
brane-cli-c/src/lib.rs	0.00%	1 Missing ⚠️
brane-ctl/src/old_configs/v1_0_0/node.rs	0.00%	1 Missing ⚠️
brane-drv/src/check.rs	0.00%	1 Missing ⚠️

📢 Thoughts on this report? Let us know!

github-advanced-security bot found potential problems Aug 29, 2024

View reviewed changes

brane-ctl/src/lifetime.rs Fixed Show fixed Hide fixed

brane-ctl/src/lifetime.rs Fixed Show fixed Hide fixed

Lut99 reviewed Sep 2, 2024

View reviewed changes

brane-ctl/src/lifetime.rs

Ok(())

}

Copy link

Lut99 Sep 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tssk, someone is removing all by formatting whitespace :P

DanielVoogsgerd force-pushed the env-loglevel branch from 4415bae to c87372b Compare October 5, 2024 13:47

DanielVoogsgerd force-pushed the env-loglevel branch from caf5d87 to 00003e7 Compare October 14, 2024 11:25

github-advanced-security bot found potential problems Oct 14, 2024

View reviewed changes

brane-ctl/src/lifetime.rs Fixed Show fixed Hide fixed

brane-ctl/src/lifetime.rs Fixed Show fixed Hide fixed

DanielVoogsgerd force-pushed the env-loglevel branch from 00003e7 to 07df136 Compare March 24, 2025 18:59

DanielVoogsgerd force-pushed the env-loglevel branch from 07df136 to 92567f7 Compare April 11, 2025 19:47

github-advanced-security bot found potential problems Apr 11, 2025

View reviewed changes

DanielVoogsgerd force-pushed the env-loglevel branch from 92567f7 to 163f771 Compare April 11, 2025 20:33

DanielVoogsgerd added 3 commits April 11, 2025 22:34

feat: Variable log levels

d9cf49d

This uses the `tracing_subscriber` with `EnvFilter` to get log levels that can be set using environment variables. This also enables `branectl` to translate a set of environment variables so that every container can get a specific log level set at start

fix: Generate override even without hosts

2fd923a

This guard clause was a correct optimization before we set loglevels via overrides

chore(api): Replace log with tracing

650612e

DanielVoogsgerd force-pushed the env-loglevel branch from 163f771 to 0e4dfec Compare April 11, 2025 20:34

DanielVoogsgerd force-pushed the env-loglevel branch from 0e4dfec to b230403 Compare April 11, 2025 20:54

wip

13d724d

DanielVoogsgerd force-pushed the env-loglevel branch from b230403 to 13d724d Compare April 11, 2025 21:11

DanielVoogsgerd changed the title ~~Improved logging~~ feat: Add tracing support Sep 28, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add tracing support#123

feat: Add tracing support#123
DanielVoogsgerd wants to merge 4 commits intoBraneFramework:mainfrom
DanielVoogsgerd:env-loglevel

DanielVoogsgerd commented Aug 29, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Lut99 Sep 2, 2024

Uh oh!

Lut99 commented Sep 2, 2024

Uh oh!

DanielVoogsgerd commented Oct 8, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

codecov bot commented Apr 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

DanielVoogsgerd commented Aug 29, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Lut99 Sep 2, 2024

Choose a reason for hiding this comment

Uh oh!

Lut99 commented Sep 2, 2024

Uh oh!

DanielVoogsgerd commented Oct 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

Check notice

codecov bot commented Apr 11, 2025

Codecov Report

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

DanielVoogsgerd commented Aug 29, 2024 •

edited

Loading

DanielVoogsgerd commented Oct 8, 2024 •

edited

Loading