Skip to content

refactor(dogstatsd): move parse_metric_namespace to shared util module #49

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
litianningdatadog merged 1 commit into from
Nov 11, 2025
Merged

refactor(dogstatsd): move parse_metric_namespace to shared util module #49

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
104 changes: 2 additions & 102 deletions crates/datadog-serverless-compat/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ use dogstatsd::{
datadog::{MetricsIntakeUrlPrefix, RetryStrategy, Site},
dogstatsd::{DogStatsD, DogStatsDConfig},
flusher::{Flusher, FlusherConfig},
util::parse_metric_namespace,
};

use dogstatsd::metric::{SortedTags, EMPTY_TAGS};
Expand Down Expand Up @@ -74,7 +75,7 @@ pub async fn main() {
.unwrap_or(true);
let dd_statsd_metric_namespace: Option<String> = env::var("DD_STATSD_METRIC_NAMESPACE")
.ok()
.and_then(|val| validate_metric_namespace(&val));
.and_then(|val| parse_metric_namespace(&val));

let https_proxy = env::var("DD_PROXY_HTTPS")
.or_else(|_| env::var("HTTPS_PROXY"))
Expand Down Expand Up @@ -234,104 +235,3 @@ async fn start_dogstatsd(

(dogstatsd_cancel_token, metrics_flusher, handle)
}

fn validate_metric_namespace(namespace: &str) -> Option<String> {
let trimmed = namespace.trim();
if trimmed.is_empty() {
return None;
}

let mut chars = trimmed.chars();

// Check first character is a letter
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;
}

// Check remaining characters are valid (alphanumeric, underscore, or period)
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())
}

#[cfg(test)]
mod tests {
use super::*;

#[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("a1.b2_c3"),
Some("a1.b2_c3".to_string())
);
}

#[test]
fn test_validate_metric_namespace_with_whitespace() {
assert_eq!(
validate_metric_namespace(" myapp "),
Some("myapp".to_string())
);
assert_eq!(
validate_metric_namespace("\tmyapp\n"),
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_start() {
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_characters() {
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 crates/dogstatsd/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ pub mod errors;
pub mod flusher;
pub mod metric;
pub mod origin;
pub mod util;
124 changes: 124 additions & 0 deletions crates/dogstatsd/src/util.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
// Copyright 2023-Present Datadog, Inc. https://www.datadoghq.com/
// SPDX-License-Identifier: Apache-2.0

//! Utility functions for DogStatsD operations.

/// Parses and validates a metric namespace string according to Datadog naming conventions.
///
/// A valid namespace must:
/// - Start with an ASCII letter
/// - Contain only ASCII alphanumerics, underscores, or periods
/// - Not be empty or contain only whitespace
///
/// Whitespace is automatically trimmed from the input.
///
/// # Arguments
///
/// * `namespace` - The namespace string to parse
///
/// # Returns
///
/// * `Some(String)` - The trimmed namespace if valid
/// * `None` - If the namespace is invalid or empty
///
/// # Examples
///
/// ```
/// use dogstatsd::util::parse_metric_namespace;
///
/// assert_eq!(parse_metric_namespace("myapp"), Some("myapp".to_string()));
/// assert_eq!(parse_metric_namespace("my_app.metrics"), Some("my_app.metrics".to_string()));
/// assert_eq!(parse_metric_namespace("1invalid"), None);
/// assert_eq!(parse_metric_namespace("my-app"), None);
/// ```
pub fn parse_metric_namespace(namespace: &str) -> Option<String> {
let trimmed = namespace.trim();
if trimmed.is_empty() {
return None;
}

let mut chars = trimmed.chars();

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

// Check remaining characters are valid (alphanumeric, underscore, or period)
if let Some(invalid_char) =
chars.find(|&ch| !ch.is_ascii_alphanumeric() && ch != '_' && ch != '.')
{
tracing::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())
}

#[cfg(test)]
mod tests {
use super::*;

#[test]
fn test_parse_metric_namespace_valid() {
assert_eq!(parse_metric_namespace("myapp"), Some("myapp".to_string()));
assert_eq!(parse_metric_namespace("my_app"), Some("my_app".to_string()));
assert_eq!(parse_metric_namespace("my.app"), Some("my.app".to_string()));
assert_eq!(
parse_metric_namespace("myApp123"),
Some("myApp123".to_string())
);
assert_eq!(
parse_metric_namespace("a1.b2_c3"),
Some("a1.b2_c3".to_string())
);
}

#[test]
fn test_parse_metric_namespace_with_whitespace() {
assert_eq!(
parse_metric_namespace(" myapp "),
Some("myapp".to_string())
);
assert_eq!(
parse_metric_namespace("\tmyapp\n"),
Some("myapp".to_string())
);
}

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

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

#[test]
fn test_parse_metric_namespace_invalid_characters() {
assert_eq!(parse_metric_namespace("my-app"), None);
assert_eq!(parse_metric_namespace("my app"), None);
assert_eq!(parse_metric_namespace("my@app"), None);
assert_eq!(parse_metric_namespace("my#app"), None);
assert_eq!(parse_metric_namespace("my$app"), None);
assert_eq!(parse_metric_namespace("my!app"), None);
}
}
Loading