Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 8 additions & 24 deletions bottlecap/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions bottlecap/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ datadog-trace-utils = { git = "https://github.com/DataDog/libdatadog", rev = "ba
datadog-trace-normalization = { git = "https://github.com/DataDog/libdatadog", rev = "ba8955394cf35cf24a1a508fbe6264ad84702567" }
datadog-trace-obfuscation = { git = "https://github.com/DataDog/libdatadog", rev = "ba8955394cf35cf24a1a508fbe6264ad84702567" }
datadog-trace-stats = { git = "https://github.com/DataDog/libdatadog", rev = "ba8955394cf35cf24a1a508fbe6264ad84702567" }
dogstatsd = { git = "https://github.com/DataDog/serverless-components", rev = "05b9dee1ac7c72d296ea12e85685c026cb6dbaaf", default-features = false }
datadog-fips = { git = "https://github.com/DataDog/serverless-components", rev = "05b9dee1ac7c72d296ea12e85685c026cb6dbaaf", default-features = false }
dogstatsd = { git = "https://github.com/DataDog/serverless-components", rev = "aa7961984f221ec3f1048ebf3379c4b94a33be0e", default-features = false }
datadog-fips = { git = "https://github.com/DataDog/serverless-components", rev = "aa7961984f221ec3f1048ebf3379c4b94a33be0e", default-features = false }
libddwaf = { version = "1.28.1", git = "https://github.com/DataDog/libddwaf-rust", rev = "d1534a158d976bd4f747bf9fcc58e0712d2d17fc", default-features = false, features = ["serde"] }

[dev-dependencies]
Expand Down
1 change: 1 addition & 0 deletions bottlecap/src/bin/bottlecap/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1164,6 +1164,7 @@ async fn start_dogstatsd(
let dogstatsd_config = DogStatsDConfig {
host: EXTENSION_HOST.to_string(),
port: DOGSTATSD_PORT,
metric_namespace: config.statsd_metric_namespace.clone(),
};
let cancel_token = tokio_util::sync::CancellationToken::new();
let dogstatsd_agent = DogStatsD::new(
Expand Down
10 changes: 10 additions & 0 deletions bottlecap/src/config/env.rs
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,11 @@ pub struct EnvConfig {
#[serde(deserialize_with = "deserialize_option_lossless")]
pub metrics_config_compression_level: Option<i32>,

/// @env `DD_STATSD_METRIC_NAMESPACE`
/// Prefix all `StatsD` metrics with a namespace.
#[serde(deserialize_with = "deserialize_optional_string")]
pub statsd_metric_namespace: Option<String>,

// OTLP
//
// - APM / Traces
Expand Down Expand Up @@ -521,6 +526,10 @@ fn merge_config(config: &mut Config, env_config: &EnvConfig) {
);
merge_option_to_value!(config, env_config, metrics_config_compression_level);

if let Some(namespace) = &env_config.statsd_metric_namespace {
config.statsd_metric_namespace = super::validate_metric_namespace(namespace);
}

// OTLP
merge_option_to_value!(config, env_config, otlp_config_traces_enabled);
merge_option_to_value!(
Expand Down Expand Up @@ -938,6 +947,7 @@ mod tests {
otlp_config_metrics_summaries_mode: Some("quantiles".to_string()),
otlp_config_traces_probabilistic_sampler_sampling_percentage: Some(50),
otlp_config_logs_enabled: true,
statsd_metric_namespace: None,
api_key_secret_arn: "arn:aws:secretsmanager:region:account:secret:datadog-api-key"
.to_string(),
kms_api_key: "test-kms-key".to_string(),
Expand Down
84 changes: 84 additions & 0 deletions bottlecap/src/config/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,7 @@ pub struct Config {

// Metrics
pub metrics_config_compression_level: i32,
pub statsd_metric_namespace: Option<String>,

// OTLP
//
Expand Down Expand Up @@ -411,6 +412,7 @@ impl Default for Config {

// Metrics
metrics_config_compression_level: 3,
statsd_metric_namespace: None,

// OTLP
otlp_config_traces_enabled: true,
Expand Down Expand Up @@ -699,6 +701,39 @@ where
}
}

fn validate_metric_namespace(namespace: &str) -> Option<String> {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Not a blocker. However, ideally the serverless-component should publish this function so we can call it here and avoid code duplication.

let trimmed = namespace.trim();
if trimmed.is_empty() {
return None;
}

let mut chars = trimmed.chars();

if let Some(first_char) = chars.next() {
if !first_char.is_ascii_alphabetic() {
error!(
"DD_STATSD_METRIC_NAMESPACE must start with a letter, got: '{}'. Ignoring namespace.",
trimmed
);
return None;
}
} else {
return None;
}

if let Some(invalid_char) =
chars.find(|&ch| !ch.is_ascii_alphanumeric() && ch != '_' && ch != '.')
{
error!(
"DD_STATSD_METRIC_NAMESPACE contains invalid character '{}' in '{}'. Only ASCII alphanumerics, underscores, and periods are allowed. Ignoring namespace.",
invalid_char, trimmed
);
return None;
}

Some(trimmed.to_string())
}

pub fn deserialize_option_lossless<'de, D, T>(deserializer: D) -> Result<Option<T>, D::Error>
where
D: Deserializer<'de>,
Expand Down Expand Up @@ -1476,4 +1511,53 @@ pub mod tests {
expected.insert("valid".to_string(), "tag".to_string());
assert_eq!(result.tags, expected);
}

#[test]
fn test_validate_metric_namespace_valid() {
assert_eq!(
validate_metric_namespace("myapp"),
Some("myapp".to_string())
);
assert_eq!(
validate_metric_namespace("my_app"),
Some("my_app".to_string())
);
assert_eq!(
validate_metric_namespace("my.app"),
Some("my.app".to_string())
);
assert_eq!(
validate_metric_namespace("MyApp123"),
Some("MyApp123".to_string())
);
assert_eq!(
validate_metric_namespace(" myapp "),
Some("myapp".to_string())
);
}

#[test]
fn test_validate_metric_namespace_empty() {
assert_eq!(validate_metric_namespace(""), None);
assert_eq!(validate_metric_namespace(" "), None);
assert_eq!(validate_metric_namespace("\t\n"), None);
}

#[test]
fn test_validate_metric_namespace_invalid_first_char() {
assert_eq!(validate_metric_namespace("1myapp"), None);
assert_eq!(validate_metric_namespace("_myapp"), None);
assert_eq!(validate_metric_namespace(".myapp"), None);
assert_eq!(validate_metric_namespace("-myapp"), None);
}

#[test]
fn test_validate_metric_namespace_invalid_chars() {
assert_eq!(validate_metric_namespace("my-app"), None);
assert_eq!(validate_metric_namespace("my app"), None);
assert_eq!(validate_metric_namespace("my@app"), None);
assert_eq!(validate_metric_namespace("my#app"), None);
assert_eq!(validate_metric_namespace("my$app"), None);
assert_eq!(validate_metric_namespace("my!app"), None);
}
}
1 change: 1 addition & 0 deletions bottlecap/src/config/yaml.rs
Original file line number Diff line number Diff line change
Expand Up @@ -993,6 +993,7 @@ api_security_sample_delay: 60 # Seconds
apm_filter_tags_reject: None,
apm_filter_tags_regex_require: None,
apm_filter_tags_regex_reject: None,
statsd_metric_namespace: None,
};

// Assert that
Expand Down
Loading