saluki_io/deser/codec/dogstatsd/
event.rs

1use nom::{
2    bytes::complete::{tag, take},
3    character::complete::u32 as parse_u32,
4    combinator::all_consuming,
5    error::{Error, ErrorKind},
6    sequence::{delimited, preceded, separated_pair},
7    IResult, Parser as _,
8};
9use saluki_context::{origin::OriginTagCardinality, tags::RawTags};
10use saluki_core::data_model::event::eventd::*;
11use stringtheory::MetaString;
12
13use super::{helpers::*, DogstatsdCodecConfiguration};
14
15/// A DogStatsD event packet.
16pub struct EventPacket<'a> {
17    pub title: MetaString,
18    pub text: MetaString,
19    pub timestamp: Option<u64>,
20    pub hostname: Option<&'a str>,
21    pub aggregation_key: Option<&'a str>,
22    pub priority: Option<Priority>,
23    pub alert_type: Option<AlertType>,
24    pub source_type_name: Option<&'a str>,
25    pub tags: RawTags<'a>,
26    pub container_id: Option<&'a str>,
27    pub external_data: Option<&'a str>,
28    pub cardinality: Option<OriginTagCardinality>,
29}
30
31#[inline]
32pub fn parse_dogstatsd_event<'a>(
33    input: &'a [u8], config: &DogstatsdCodecConfiguration,
34) -> IResult<&'a [u8], EventPacket<'a>> {
35    // We parse the title length and text length from `_e{<TITLE_UTF8_LENGTH>,<TEXT_UTF8_LENGTH>}:`
36    let (remaining, (title_len, text_len)) = delimited(
37        tag(EVENT_PREFIX),
38        separated_pair(parse_u32, tag(","), parse_u32),
39        tag("}:"),
40    )
41    .parse(input)?;
42
43    // Title and Text are the required fields of an event.
44    if title_len == 0 || text_len == 0 {
45        return Err(nom::Err::Error(Error::new(input, ErrorKind::Verify)));
46    }
47
48    let (remaining, (raw_title, raw_text)) =
49        separated_pair(take(title_len), tag("|"), take(text_len)).parse(remaining)?;
50
51    let title = match simdutf8::basic::from_utf8(raw_title) {
52        Ok(title) => title.replace("\\n", "\n"),
53        Err(_) => return Err(nom::Err::Error(Error::new(raw_title, ErrorKind::Verify))),
54    };
55
56    let text = match simdutf8::basic::from_utf8(raw_text) {
57        Ok(text) => text.replace("\\n", "\n"),
58        Err(_) => return Err(nom::Err::Error(Error::new(raw_text, ErrorKind::Verify))),
59    };
60
61    // At this point, we may have some of this additional data, and if so, we also then would have a pipe separator at
62    // the very front, which we'd want to consume before going further.
63    //
64    // After that, we simply split the remaining bytes by the pipe separator, and then try and parse each chunk to see
65    // if it's any of the protocol extensions we know of.
66    //
67    // Priority and Alert Type have default values
68    let mut maybe_priority = Some(Priority::Normal);
69    let mut maybe_alert_type = Some(AlertType::Info);
70    let mut maybe_timestamp = None;
71    let mut maybe_hostname = None;
72    let mut maybe_aggregation_key = None;
73    let mut maybe_source_type = None;
74    let mut maybe_tags = None;
75    let mut maybe_container_id = None;
76    let mut maybe_external_data = None;
77    let mut maybe_cardinality = None;
78
79    let remaining = if !remaining.is_empty() {
80        let (mut remaining, _) = tag("|")(remaining)?;
81        while let Some((chunk, tail)) = split_at_delimiter(remaining, b'|') {
82            if chunk.len() < 2 {
83                break;
84            }
85            match &chunk[..2] {
86                // Timestamp: client-provided timestamp for the event, relative to the Unix epoch, in seconds.
87                TIMESTAMP_PREFIX => {
88                    let (_, timestamp) = all_consuming(preceded(tag(TIMESTAMP_PREFIX), unix_timestamp)).parse(chunk)?;
89                    maybe_timestamp = Some(timestamp);
90                }
91                // Hostname: client-provided hostname for the host that this event originated from.
92                HOSTNAME_PREFIX => {
93                    let (_, hostname) =
94                        all_consuming(preceded(tag(HOSTNAME_PREFIX), ascii_alphanum_and_seps)).parse(chunk)?;
95                    maybe_hostname = Some(hostname);
96                }
97                // Aggregation key: key to be used to group this event with others that have the same key.
98                AGGREGATION_KEY_PREFIX => {
99                    let (_, aggregation_key) =
100                        all_consuming(preceded(tag(AGGREGATION_KEY_PREFIX), ascii_alphanum_and_seps)).parse(chunk)?;
101                    maybe_aggregation_key = Some(aggregation_key);
102                }
103                // Priority: client-provided priority of the event.
104                PRIORITY_PREFIX => {
105                    let (_, priority) =
106                        all_consuming(preceded(tag(PRIORITY_PREFIX), ascii_alphanum_and_seps)).parse(chunk)?;
107                    maybe_priority = Priority::try_from_string(priority);
108                }
109                // Source type name: client-provided source type name of the event.
110                SOURCE_TYPE_PREFIX => {
111                    let (_, source_type) =
112                        all_consuming(preceded(tag(SOURCE_TYPE_PREFIX), ascii_alphanum_and_seps)).parse(chunk)?;
113                    maybe_source_type = Some(source_type);
114                }
115                // Alert type: client-provided alert type of the event.
116                ALERT_TYPE_PREFIX => {
117                    let (_, alert_type) =
118                        all_consuming(preceded(tag(ALERT_TYPE_PREFIX), ascii_alphanum_and_seps)).parse(chunk)?;
119                    maybe_alert_type = AlertType::try_from_string(alert_type);
120                }
121                // Container ID: client-provided container ID for the container that this event originated from.
122                CONTAINER_ID_PREFIX => {
123                    let (_, container_id) =
124                        all_consuming(preceded(tag(CONTAINER_ID_PREFIX), container_id)).parse(chunk)?;
125                    maybe_container_id = Some(container_id);
126                }
127                // External Data: client-provided data used for resolving the entity ID that this event originated from.
128                EXTERNAL_DATA_PREFIX => {
129                    let (_, external_data) =
130                        all_consuming(preceded(tag(EXTERNAL_DATA_PREFIX), external_data)).parse(chunk)?;
131                    maybe_external_data = Some(external_data);
132                }
133                // Cardinality: client-provided cardinality for the event.
134                _ if chunk.starts_with(CARDINALITY_PREFIX) => {
135                    let (_, cardinality) = cardinality(chunk)?;
136                    maybe_cardinality = cardinality;
137                }
138                // Tags: additional tags to be added to the event.
139                _ if chunk.starts_with(TAGS_PREFIX) => {
140                    let (_, tags) = all_consuming(preceded(tag("#"), tags(config))).parse(chunk)?;
141                    maybe_tags = Some(tags);
142                }
143                _ => {
144                    // We don't know what this is, so we just skip it.
145                    //
146                    // TODO: Should we throw an error, warn, or be silently permissive?
147                }
148            }
149            remaining = tail;
150        }
151        remaining
152    } else {
153        remaining
154    };
155
156    let tags = maybe_tags.unwrap_or_else(RawTags::empty);
157
158    let eventd = EventPacket {
159        title: title.into(),
160        text: text.into(),
161        tags,
162        timestamp: maybe_timestamp,
163        hostname: maybe_hostname,
164        aggregation_key: maybe_aggregation_key,
165        priority: maybe_priority,
166        alert_type: maybe_alert_type,
167        source_type_name: maybe_source_type,
168        container_id: maybe_container_id,
169        external_data: maybe_external_data,
170        cardinality: maybe_cardinality,
171    };
172    Ok((remaining, eventd))
173}
174
175#[cfg(test)]
176mod tests {
177    use nom::IResult;
178    use saluki_context::{
179        origin::OriginTagCardinality,
180        tags::{SharedTagSet, Tag, TagSet},
181    };
182    use saluki_core::data_model::event::eventd::{AlertType, EventD, Priority};
183    use stringtheory::MetaString;
184
185    use super::{parse_dogstatsd_event, DogstatsdCodecConfiguration};
186
187    type NomResult<'input, T> = Result<T, nom::Err<nom::error::Error<&'input [u8]>>>;
188
189    fn parse_dsd_eventd(input: &[u8]) -> NomResult<'_, EventD> {
190        let default_config = DogstatsdCodecConfiguration::default();
191        parse_dsd_eventd_with_conf(input, &default_config)
192    }
193
194    fn parse_dsd_eventd_with_conf<'input>(
195        input: &'input [u8], config: &DogstatsdCodecConfiguration,
196    ) -> NomResult<'input, EventD> {
197        let (remaining, eventd) = parse_dsd_eventd_direct(input, config)?;
198        assert!(remaining.is_empty());
199        Ok(eventd)
200    }
201
202    fn parse_dsd_eventd_direct<'input>(
203        input: &'input [u8], config: &DogstatsdCodecConfiguration,
204    ) -> IResult<&'input [u8], EventD> {
205        let (remaining, packet) = parse_dogstatsd_event(input, config)?;
206        assert!(remaining.is_empty());
207
208        let mut event_tags = TagSet::default();
209        for tag in packet.tags.into_iter() {
210            event_tags.insert_tag(tag);
211        }
212
213        let eventd = EventD::new(packet.title, packet.text)
214            .with_timestamp(packet.timestamp)
215            .with_hostname(packet.hostname.map(|s| s.into()))
216            .with_aggregation_key(packet.aggregation_key.map(|s| s.into()))
217            .with_alert_type(packet.alert_type)
218            .with_priority(packet.priority)
219            .with_source_type_name(packet.source_type_name.map(|s| s.into()))
220            .with_alert_type(packet.alert_type)
221            .with_tags(event_tags);
222
223        Ok((remaining, eventd))
224    }
225
226    #[track_caller]
227    fn check_basic_eventd_eq(expected: EventD, actual: EventD) {
228        assert_eq!(expected.title(), actual.title());
229        assert_eq!(expected.text(), actual.text());
230        assert_eq!(expected.timestamp(), actual.timestamp());
231        assert_eq!(expected.hostname(), actual.hostname());
232        assert_eq!(expected.aggregation_key(), actual.aggregation_key());
233        assert_eq!(expected.priority(), actual.priority());
234        assert_eq!(expected.source_type_name(), actual.source_type_name());
235        assert_eq!(expected.alert_type(), actual.alert_type());
236        assert_eq!(expected.tags(), actual.tags());
237        assert_eq!(expected.origin_tags(), actual.origin_tags());
238    }
239
240    #[test]
241    fn basic_eventd() {
242        let event_title = "my event";
243        let event_text = "text";
244        let raw = format!(
245            "_e{{{},{}}}:{}|{}",
246            event_title.len(),
247            event_text.len(),
248            event_title,
249            event_text
250        );
251
252        let actual = parse_dsd_eventd(raw.as_bytes()).unwrap();
253        let expected = EventD::new(event_title, event_text);
254        check_basic_eventd_eq(expected, actual);
255    }
256
257    #[test]
258    fn eventd_tags() {
259        let event_title = "my event";
260        let event_text = "text";
261        let tags = ["tag1", "tag2"];
262        let shared_tag_set: SharedTagSet = tags.iter().map(|&s| Tag::from(s)).collect::<TagSet>().into_shared();
263        let raw = format!(
264            "_e{{{},{}}}:{}|{}|#{}",
265            event_title.len(),
266            event_text.len(),
267            event_title,
268            event_text,
269            tags.join(","),
270        );
271
272        let expected = EventD::new(event_title, event_text).with_tags(shared_tag_set);
273        let actual = parse_dsd_eventd(raw.as_bytes()).unwrap();
274        check_basic_eventd_eq(expected, actual);
275    }
276
277    #[test]
278    fn eventd_priority() {
279        let event_title = "my event";
280        let event_text = "text";
281        let event_priority = Priority::Low;
282        let raw = format!(
283            "_e{{{},{}}}:{}|{}|p:{}",
284            event_title.len(),
285            event_text.len(),
286            event_title,
287            event_text,
288            event_priority
289        );
290
291        let expected = EventD::new(event_title, event_text).with_priority(event_priority);
292        let actual = parse_dsd_eventd(raw.as_bytes()).unwrap();
293        check_basic_eventd_eq(expected, actual);
294    }
295
296    #[test]
297    fn eventd_alert_type() {
298        let event_title = "my event";
299        let event_text = "text";
300        let event_alert_type = AlertType::Warning;
301        let raw = format!(
302            "_e{{{},{}}}:{}|{}|t:{}",
303            event_title.len(),
304            event_text.len(),
305            event_title,
306            event_text,
307            event_alert_type
308        );
309
310        let expected = EventD::new(event_title, event_text).with_alert_type(event_alert_type);
311        let actual = parse_dsd_eventd(raw.as_bytes()).unwrap();
312        check_basic_eventd_eq(expected, actual);
313    }
314
315    #[test]
316    fn eventd_multiple_extensions() {
317        let event_title = "my event";
318        let event_text = "text";
319        let event_hostname = MetaString::from("testhost");
320        let event_aggregation_key = MetaString::from("testkey");
321        let event_priority = Priority::Low;
322        let event_source_type = MetaString::from("testsource");
323        let event_alert_type = AlertType::Success;
324        let event_timestamp = 1234567890;
325        let event_container_id = "abcdef123456";
326        let event_external_data = "it-false,cn-redis,pu-810fe89d-da47-410b-8979-9154a40f8183";
327        let event_cardinality = "low";
328        let tags = ["tags1", "tags2"];
329        let shared_tag_set = SharedTagSet::from(TagSet::from_iter(tags.iter().map(|&s| s.into())));
330        let raw = format!(
331            "_e{{{},{}}}:{}|{}|h:{}|k:{}|p:{}|s:{}|t:{}|d:{}|c:{}|e:{}|card:{}|#{}",
332            event_title.len(),
333            event_text.len(),
334            event_title,
335            event_text,
336            event_hostname,
337            event_aggregation_key,
338            event_priority,
339            event_source_type,
340            event_alert_type,
341            event_timestamp,
342            event_container_id,
343            event_external_data,
344            event_cardinality,
345            tags.join(","),
346        );
347        let actual = parse_dsd_eventd(raw.as_bytes()).unwrap();
348        let expected = EventD::new(event_title, event_text)
349            .with_hostname(event_hostname)
350            .with_aggregation_key(event_aggregation_key)
351            .with_priority(event_priority)
352            .with_source_type_name(event_source_type)
353            .with_alert_type(event_alert_type)
354            .with_timestamp(event_timestamp)
355            .with_tags(shared_tag_set);
356        check_basic_eventd_eq(expected, actual);
357
358        let config = DogstatsdCodecConfiguration::default();
359        let (_, packet) = parse_dogstatsd_event(raw.as_bytes(), &config).expect("should not fail to parse");
360        assert_eq!(packet.container_id, Some(event_container_id));
361        assert_eq!(packet.external_data, Some(event_external_data));
362        assert_eq!(packet.cardinality, Some(OriginTagCardinality::Low));
363    }
364}
saluki_io/deser/codec/dogstatsd/event.rs

saluki_io/deser/codec/dogstatsd/
event.rs
