Skip to content

refactor: Move metric namespace validation to dogstatsd util #921

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

Merged
merged 1 commit into from
Nov 11, 2025
Merged

refactor: Move metric namespace validation to dogstatsd util #921

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
4 changes: 2 additions & 2 deletions bottlecap/Cargo.lock
View file
Open in desktop

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
View file
Open in desktop
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 = "aa7961984f221ec3f1048ebf3379c4b94a33be0e", default-features = false }
datadog-fips = { git = "https://github.com/DataDog/serverless-components", rev = "aa7961984f221ec3f1048ebf3379c4b94a33be0e", default-features = false }
dogstatsd = { git = "https://github.com/DataDog/serverless-components", rev = "502f005c56b8d51dee95424a9c1404df46e2aae4", default-features = false }
datadog-fips = { git = "https://github.com/DataDog/serverless-components", rev = "502f005c56b8d51dee95424a9c1404df46e2aae4", 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
3 changes: 2 additions & 1 deletion bottlecap/src/config/env.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ use std::collections::HashMap;
use std::time::Duration;

use datadog_trace_obfuscation::replacer::ReplaceRule;
use dogstatsd::util::parse_metric_namespace;

use crate::{
config::{
Expand Down Expand Up @@ -527,7 +528,7 @@ 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);
config.statsd_metric_namespace = parse_metric_namespace(namespace);
}

// OTLP
Expand Down
82 changes: 0 additions & 82 deletions bottlecap/src/config/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -701,39 +701,6 @@ where
}
}

fn validate_metric_namespace(namespace: &str) -> Option<String> {
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 @@ -1511,53 +1478,4 @@ 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);
}
}
Loading