Skip to content

fix: align jaeger tracing flag names #27407

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ivanov17andrey wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: align jaeger tracing flag names #27407

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .circleci/packages/influxdb3/fs/usr/lib/influxdb3/influxdb3-launcher
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ TOML_KEY_ENVVAR: Dict[str, Dict[str, str]] = {
"traces-exporter-jaeger-agent-port": "INFLUXDB3_TRACES_EXPORTER_JAEGER_AGENT_PORT",
"traces-exporter-jaeger-debug-name": "INFLUXDB3_TRACES_EXPORTER_JAEGER_DEBUG_NAME",
"traces-exporter-jaeger-service-name": "INFLUXDB3_TRACES_EXPORTER_JAEGER_SERVICE_NAME",
"traces-exporter-jaeger-tags": "INFLUXDB3_TRACES_EXPORTER_JAEGER_TAGS",
"traces-exporter-jaeger-trace-context-header-name": "INFLUXDB3_TRACES_EXPORTER_JAEGER_TRACE_CONTEXT_HEADER_NAME",
"traces-jaeger-debug-name": "INFLUXDB3_TRACES_EXPORTER_JAEGER_DEBUG_NAME",
"traces-jaeger-max-msgs-per-second": "INFLUXDB3_TRACES_JAEGER_MAX_MSGS_PER_SECOND",
Expand Down
4 changes: 2 additions & 2 deletions .circleci/packages/influxdb3/fs/usr/share/influxdb3/influxdb3-core.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -478,10 +478,10 @@

# Header for force sampling
# Default: jaeger-debug-id (env: TRACES_EXPORTER_JAEGER_DEBUG_NAME)
#traces-jaeger-debug-name="jaeger-debug-id"
#traces-exporter-jaeger-debug-name="jaeger-debug-id"

# Key-value pairs for tracing spans (env: TRACES_EXPORTER_JAEGER_TAGS)
#traces-jaeger-tags="<TAGS>"
#traces-exporter-jaeger-tags="<TAGS>"

# Max messages per second
# Default: 1000 (env: TRACES_JAEGER_MAX_MSGS_PER_SECOND)
Expand Down
58 changes: 56 additions & 2 deletions core/trace_exporters/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,8 @@ pub struct TracingConfig {
///
/// Only used if `--traces-exporter` is "jaeger".
#[clap(
long = "traces-jaeger-debug-name",
long = "traces-exporter-jaeger-debug-name",
alias = "traces-jaeger-debug-name",
env = "TRACES_EXPORTER_JAEGER_DEBUG_NAME",
default_value = "jaeger-debug-id",
action
Expand All @@ -115,7 +116,8 @@ pub struct TracingConfig {
///
/// Only used if `--traces-exporter` is "jaeger".
#[clap(
long = "traces-jaeger-tags",
long = "traces-exporter-jaeger-tags",
alias = "traces-jaeger-tags",
env = "TRACES_EXPORTER_JAEGER_TAGS",
value_delimiter = ',',
action
Expand Down Expand Up @@ -211,3 +213,55 @@ fn jaeger_exporter(config: &TracingConfig) -> Result<Arc<AsyncExporter>> {

Ok(Arc::new(AsyncExporter::new(jaeger)))
}

#[cfg(test)]
mod tests {
use super::*;
use clap::{CommandFactory, Parser};

#[test]
fn jaeger_debug_and_tags_flags_match_exporter_env_names() {
let cmd = TracingConfig::command();

assert_long_option_has_env(
&cmd,
"traces-exporter-jaeger-debug-name",
"TRACES_EXPORTER_JAEGER_DEBUG_NAME",
);
assert_long_option_has_env(
&cmd,
"traces-exporter-jaeger-tags",
"TRACES_EXPORTER_JAEGER_TAGS",
);
}

#[test]
fn deprecated_jaeger_debug_and_tags_flags_remain_accepted() {
let config = TracingConfig::try_parse_from([
"cmd",
"--traces-jaeger-debug-name",
"debug-header",
"--traces-jaeger-tags",
"env=prod,region=west",
])
.expect("deprecated Jaeger flags should still parse");

assert_eq!(config.traces_jaeger_debug_name, "debug-header");
let tags = config.traces_jaeger_tags.expect("tags should be parsed");
assert_eq!(tags.len(), 2);
assert_eq!(tags[0].key(), "env");
assert_eq!(tags[1].key(), "region");
}

fn assert_long_option_has_env(cmd: &clap::Command, long: &str, env: &str) {
let arg = cmd
.get_arguments()
.find(|arg| arg.get_long() == Some(long))
.unwrap_or_else(|| panic!("missing --{long}"));
assert_eq!(
arg.get_env().and_then(std::ffi::OsStr::to_str),
Some(env),
"--{long} should use {env}"
);
}
}
4 changes: 2 additions & 2 deletions influxdb3/src/commands/serve/cli_params.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,8 @@ const NON_SENSITIVE_PARAMS: &[&str] = &[
"traces-exporter-jaeger-agent-port",
"traces-exporter-jaeger-service-name",
"traces-exporter-jaeger-trace-context-header-name",
"traces-jaeger-debug-name",
"traces-jaeger-tags",
"traces-exporter-jaeger-debug-name",
"traces-exporter-jaeger-tags",
"traces-jaeger-max-msgs-per-second",
// DataFusion parameters
"datafusion-config",
Expand Down
4 changes: 2 additions & 2 deletions influxdb3/src/help/serve_all.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,9 +268,9 @@ Examples:
[env: INFLUXDB3_TRACES_EXPORTER_JAEGER_SERVICE_NAME=]
--traces-exporter-jaeger-trace-context-header-name <NAME> Header for trace context [default: uber-trace-id]
[env: INFLUXDB3_TRACES_EXPORTER_JAEGER_TRACE_CONTEXT_HEADER_NAME=]
--traces-jaeger-debug-name <NAME> Header for force sampling [default: jaeger-debug-id]
--traces-exporter-jaeger-debug-name <NAME> Header for force sampling [default: jaeger-debug-id]
[env: INFLUXDB3_TRACES_EXPORTER_JAEGER_DEBUG_NAME=]
--traces-jaeger-tags <TAGS> Key-value pairs for tracing spans
--traces-exporter-jaeger-tags <TAGS> Key-value pairs for tracing spans
[env: INFLUXDB3_TRACES_EXPORTER_JAEGER_TAGS=]
--traces-jaeger-max-msgs-per-second <N> Max messages per second [default: 1000]
[env: INFLUXDB3_TRACES_JAEGER_MAX_MSGS_PER_SECOND=]
Expand Down