Skip to content
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

Jump to bottom

fix(log_to_metric transform): Drop events where field is null #7487

Merged
merged 1 commit into from
May 26, 2021
Merged

fix(log_to_metric transform): Drop events where field is null #7487

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
20 changes: 20 additions & 0 deletions src/internal_events/log_to_metric.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,26 @@ use crate::template::TemplateParseError;
use metrics::counter;
use std::num::ParseFloatError;

pub(crate) struct LogToMetricFieldNull<'a> {
Copy link
Contributor

Choose a reason for hiding this comment

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

I feel like I've seen these generally ordered in the file alphabetically, if that's a "standard" we should move this below LogToMetricFieldNotFound

Copy link
Member Author

Choose a reason for hiding this comment

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

Hmm, interesting, I certainly haven't been ordering them that way. I think if they are that is probably incidental.

pub field: &'a str,
}

impl<'a> InternalEvent for LogToMetricFieldNull<'a> {
fn emit_logs(&self) {
warn!(
message = "Field is null.",
null_field = %self.field,
internal_log_rate_secs = 30
);
}

fn emit_metrics(&self) {
counter!("processing_errors_total", 1,
"error_type" => "field_null",
);
}
}

pub(crate) struct LogToMetricFieldNotFound<'a> {
pub field: &'a str,
}
Expand Down
101 changes: 69 additions & 32 deletions src/transforms/log_to_metric.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ use crate::{
log_schema, DataType, GenerateConfig, GlobalOptions, TransformConfig, TransformDescription,
},
event::metric::{Metric, MetricKind, MetricValue, StatisticKind},
event::{Event, LogEvent, Value},
event::{Event, Value},
internal_events::{
LogToMetricFieldNotFound, LogToMetricParseFloatError, LogToMetricTemplateParseError,
TemplateRenderingFailed,
LogToMetricFieldNotFound, LogToMetricFieldNull, LogToMetricParseFloatError,
LogToMetricTemplateParseError, TemplateRenderingFailed,
},
template::{Template, TemplateParseError, TemplateRenderingError},
transforms::{FunctionTransform, Transform},
Expand Down Expand Up @@ -75,6 +75,18 @@ pub enum MetricConfig {
Summary(SummaryConfig),
}

impl MetricConfig {
fn field(&self) -> &str {
match self {
MetricConfig::Counter(CounterConfig { field, .. }) => field,
MetricConfig::Histogram(HistogramConfig { field, .. }) => field,
MetricConfig::Gauge(GaugeConfig { field, .. }) => field,
MetricConfig::Set(SetConfig { field, .. }) => field,
MetricConfig::Summary(SummaryConfig { field, .. }) => field,
}
}
}

fn default_increment_by_value() -> bool {
false
}
Expand Down Expand Up @@ -133,6 +145,9 @@ enum TransformError {
FieldNotFound {
field: String,
},
FieldNull {
field: String,
},
TemplateParseError(TemplateParseError),
TemplateRenderingError(TemplateRenderingError),
ParseFloatError {
Expand Down Expand Up @@ -180,21 +195,6 @@ fn render_tags(
})
}

fn parse_field(log: &LogEvent, field: &str) -> Result<f64, TransformError> {
let value = log
.get(field)
.ok_or_else(|| TransformError::FieldNotFound {
field: field.to_string(),
})?;
value
.to_string_lossy()
.parse()
.map_err(|error| TransformError::ParseFloatError {
field: field.to_string(),
error,
})
}

fn to_metric(config: &MetricConfig, event: &Event) -> Result<Metric, TransformError> {
let log = event.as_log();

Expand All @@ -204,13 +204,20 @@ fn to_metric(config: &MetricConfig, event: &Event) -> Result<Metric, TransformEr
.cloned();
let metadata = event.metadata().clone();

let field = config.field();

let value = match log.get(field) {
None => Err(TransformError::FieldNotFound {
field: field.to_string(),
}),
Some(Value::Null) => Err(TransformError::FieldNull {
field: field.to_string(),
}),
Some(value) => Ok(value),
}?;

match config {
MetricConfig::Counter(counter) => {
let value = log
.get(&counter.field)
.ok_or_else(|| TransformError::FieldNotFound {
field: counter.field.clone(),
})?;
let value = if counter.increment_by_value {
value.to_string_lossy().parse().map_err(|error| {
TransformError::ParseFloatError {
Expand Down Expand Up @@ -243,7 +250,12 @@ fn to_metric(config: &MetricConfig, event: &Event) -> Result<Metric, TransformEr
.with_timestamp(timestamp))
}
MetricConfig::Histogram(hist) => {
let value = parse_field(&log, &hist.field)?;
let value = value.to_string_lossy().parse().map_err(|error| {
TransformError::ParseFloatError {
field: field.to_string(),
error,
}
})?;

let name = hist.name.as_ref().unwrap_or(&hist.field);
let name = render_template(&name, &event)?;
Expand All @@ -269,7 +281,12 @@ fn to_metric(config: &MetricConfig, event: &Event) -> Result<Metric, TransformEr
.with_timestamp(timestamp))
}
MetricConfig::Summary(summary) => {
let value = parse_field(&log, &summary.field)?;
let value = value.to_string_lossy().parse().map_err(|error| {
TransformError::ParseFloatError {
field: field.to_string(),
error,
}
})?;

let name = summary.name.as_ref().unwrap_or(&summary.field);
let name = render_template(&name, &event)?;
Expand All @@ -295,7 +312,12 @@ fn to_metric(config: &MetricConfig, event: &Event) -> Result<Metric, TransformEr
.with_timestamp(timestamp))
}
MetricConfig::Gauge(gauge) => {
let value = parse_field(&log, &gauge.field)?;
let value = value.to_string_lossy().parse().map_err(|error| {
TransformError::ParseFloatError {
field: field.to_string(),
error,
}
})?;

let name = gauge.name.as_ref().unwrap_or(&gauge.field);
let name = render_template(&name, &event)?;
Expand All @@ -318,11 +340,6 @@ fn to_metric(config: &MetricConfig, event: &Event) -> Result<Metric, TransformEr
.with_timestamp(timestamp))
}
MetricConfig::Set(set) => {
let value = log
.get(&set.field)
.ok_or_else(|| TransformError::FieldNotFound {
field: set.field.clone(),
})?;
let value = value.to_string_lossy();

let name = set.name.as_ref().unwrap_or(&set.field);
Expand Down Expand Up @@ -357,6 +374,9 @@ impl FunctionTransform for LogToMetric {
Ok(metric) => {
output.push(Event::Metric(metric));
}
Err(TransformError::FieldNull { field }) => emit!(LogToMetricFieldNull {
field: field.as_ref()
}),
Err(TransformError::FieldNotFound { field }) => emit!(LogToMetricFieldNotFound {
field: field.as_ref()
}),
Expand Down Expand Up @@ -404,7 +424,7 @@ mod tests {
Utc.ymd(2018, 11, 14).and_hms_nano(8, 9, 10, 11)
}

fn create_event(key: &str, value: &str) -> Event {
fn create_event(key: &str, value: impl Into<Value> + std::fmt::Debug) -> Event {
let mut log = Event::from("i am a log");
log.as_mut_log().insert(key, value);
log.as_mut_log().insert(log_schema().timestamp_key(), ts());
Expand Down Expand Up @@ -618,6 +638,23 @@ mod tests {
assert_eq!(transform.transform_one(event), None);
}

#[test]
fn null_field() {
let config = parse_config(
r#"
[[metrics]]
type = "counter"
field = "status"
name = "status_total"
"#,
);

let event = create_event("status", Value::Null);
let mut transform = LogToMetric::new(config);

assert_eq!(transform.transform_one(event), None);
}

#[test]
fn multiple_metrics() {
let config = parse_config(
Expand Down