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 local_data: 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_local_data = 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                    if chunk != HOSTNAME_PREFIX {
94                        let (_, hostname) =
95                            all_consuming(preceded(tag(HOSTNAME_PREFIX), ascii_alphanum_and_seps)).parse(chunk)?;
96                        maybe_hostname = Some(hostname);
97                    }
98                }
99                // Aggregation key: key to be used to group this event with others that have the same key.
100                AGGREGATION_KEY_PREFIX => {
101                    if chunk != AGGREGATION_KEY_PREFIX {
102                        let (_, aggregation_key) =
103                            all_consuming(preceded(tag(AGGREGATION_KEY_PREFIX), ascii_alphanum_and_seps))
104                                .parse(chunk)?;
105                        maybe_aggregation_key = Some(aggregation_key);
106                    }
107                }
108                // Priority: client-provided priority of the event.
109                PRIORITY_PREFIX => {
110                    let (_, priority) =
111                        all_consuming(preceded(tag(PRIORITY_PREFIX), ascii_alphanum_and_seps)).parse(chunk)?;
112                    maybe_priority = Priority::try_from_string(priority);
113                }
114                // Source type name: client-provided source type name of the event.
115                SOURCE_TYPE_PREFIX => {
116                    if chunk != SOURCE_TYPE_PREFIX {
117                        let (_, source_type) =
118                            all_consuming(preceded(tag(SOURCE_TYPE_PREFIX), ascii_alphanum_and_seps)).parse(chunk)?;
119                        maybe_source_type = Some(source_type);
120                    }
121                }
122                // Alert type: client-provided alert type of the event.
123                ALERT_TYPE_PREFIX => {
124                    let (_, alert_type) =
125                        all_consuming(preceded(tag(ALERT_TYPE_PREFIX), ascii_alphanum_and_seps)).parse(chunk)?;
126                    maybe_alert_type = AlertType::try_from_string(alert_type);
127                }
128                // Local Data: client-provided data used for resolving the entity ID that this event originated from.
129                LOCAL_DATA_PREFIX => {
130                    if chunk != LOCAL_DATA_PREFIX {
131                        let (_, local_data) =
132                            all_consuming(preceded(tag(LOCAL_DATA_PREFIX), local_data)).parse(chunk)?;
133                        maybe_local_data = Some(local_data);
134                    }
135                }
136                // External Data: client-provided data used for resolving the entity ID that this event originated from.
137                EXTERNAL_DATA_PREFIX => {
138                    if chunk != EXTERNAL_DATA_PREFIX {
139                        let (_, external_data) =
140                            all_consuming(preceded(tag(EXTERNAL_DATA_PREFIX), external_data)).parse(chunk)?;
141                        maybe_external_data = Some(external_data);
142                    }
143                }
144                // Cardinality: client-provided cardinality for the event.
145                _ if chunk.starts_with(CARDINALITY_PREFIX) => {
146                    if chunk != CARDINALITY_PREFIX {
147                        let (_, cardinality) = cardinality(chunk)?;
148                        maybe_cardinality = cardinality;
149                    }
150                }
151                // Tags: additional tags to be added to the event.
152                _ if chunk.starts_with(TAGS_PREFIX) => {
153                    if chunk != TAGS_PREFIX {
154                        let (_, tags) = all_consuming(preceded(tag("#"), tags(config))).parse(chunk)?;
155                        maybe_tags = Some(tags);
156                    }
157                }
158                _ => {
159                    // We don't know what this is, so we just skip it.
160                    //
161                    // TODO: Should we throw an error, warn, or be silently permissive?
162                }
163            }
164            remaining = tail;
165        }
166        remaining
167    } else {
168        remaining
169    };
170
171    let tags = maybe_tags.unwrap_or_else(RawTags::empty);
172
173    let eventd = EventPacket {
174        title: title.into(),
175        text: text.into(),
176        tags,
177        timestamp: maybe_timestamp,
178        hostname: maybe_hostname,
179        aggregation_key: maybe_aggregation_key,
180        priority: maybe_priority,
181        alert_type: maybe_alert_type,
182        source_type_name: maybe_source_type,
183        local_data: maybe_local_data,
184        external_data: maybe_external_data,
185        cardinality: maybe_cardinality,
186    };
187    Ok((remaining, eventd))
188}
189
190#[cfg(test)]
191mod tests {
192    use nom::IResult;
193    use saluki_context::{
194        origin::OriginTagCardinality,
195        tags::{SharedTagSet, Tag, TagSet},
196    };
197    use saluki_core::data_model::event::eventd::{AlertType, EventD, Priority};
198    use stringtheory::MetaString;
199
200    use super::{parse_dogstatsd_event, DogstatsdCodecConfiguration};
201
202    type NomResult<'input, T> = Result<T, nom::Err<nom::error::Error<&'input [u8]>>>;
203
204    fn parse_dsd_eventd(input: &[u8]) -> NomResult<'_, EventD> {
205        let default_config = DogstatsdCodecConfiguration::default();
206        parse_dsd_eventd_with_conf(input, &default_config)
207    }
208
209    fn parse_dsd_eventd_with_conf<'input>(
210        input: &'input [u8], config: &DogstatsdCodecConfiguration,
211    ) -> NomResult<'input, EventD> {
212        let (remaining, eventd) = parse_dsd_eventd_direct(input, config)?;
213        assert!(remaining.is_empty());
214        Ok(eventd)
215    }
216
217    fn parse_dsd_eventd_direct<'input>(
218        input: &'input [u8], config: &DogstatsdCodecConfiguration,
219    ) -> IResult<&'input [u8], EventD> {
220        let (remaining, packet) = parse_dogstatsd_event(input, config)?;
221        assert!(remaining.is_empty());
222
223        let mut event_tags = TagSet::default();
224        for tag in packet.tags.into_iter() {
225            event_tags.insert_tag(tag);
226        }
227
228        let eventd = EventD::new(packet.title, packet.text)
229            .with_timestamp(packet.timestamp)
230            .with_hostname(packet.hostname.map(|s| s.into()))
231            .with_aggregation_key(packet.aggregation_key.map(|s| s.into()))
232            .with_alert_type(packet.alert_type)
233            .with_priority(packet.priority)
234            .with_source_type_name(packet.source_type_name.map(|s| s.into()))
235            .with_alert_type(packet.alert_type)
236            .with_tags(event_tags);
237
238        Ok((remaining, eventd))
239    }
240
241    #[track_caller]
242    fn check_basic_eventd_eq(expected: EventD, actual: EventD) {
243        assert_eq!(expected.title(), actual.title());
244        assert_eq!(expected.text(), actual.text());
245        assert_eq!(expected.timestamp(), actual.timestamp());
246        assert_eq!(expected.hostname(), actual.hostname());
247        assert_eq!(expected.aggregation_key(), actual.aggregation_key());
248        assert_eq!(expected.priority(), actual.priority());
249        assert_eq!(expected.source_type_name(), actual.source_type_name());
250        assert_eq!(expected.alert_type(), actual.alert_type());
251        assert_eq!(expected.tags(), actual.tags());
252        assert_eq!(expected.origin_tags(), actual.origin_tags());
253    }
254
255    #[test]
256    fn basic_eventd() {
257        let event_title = "my event";
258        let event_text = "text";
259        let raw = format!(
260            "_e{{{},{}}}:{}|{}",
261            event_title.len(),
262            event_text.len(),
263            event_title,
264            event_text
265        );
266
267        let actual = parse_dsd_eventd(raw.as_bytes()).unwrap();
268        let expected = EventD::new(event_title, event_text);
269        check_basic_eventd_eq(expected, actual);
270    }
271
272    #[test]
273    fn eventd_tags() {
274        let event_title = "my event";
275        let event_text = "text";
276        let tags = ["tag1", "tag2"];
277        let shared_tag_set: SharedTagSet = tags.iter().map(|&s| Tag::from(s)).collect::<TagSet>().into_shared();
278        let raw = format!(
279            "_e{{{},{}}}:{}|{}|#{}",
280            event_title.len(),
281            event_text.len(),
282            event_title,
283            event_text,
284            tags.join(","),
285        );
286
287        let expected = EventD::new(event_title, event_text).with_tags(shared_tag_set);
288        let actual = parse_dsd_eventd(raw.as_bytes()).unwrap();
289        check_basic_eventd_eq(expected, actual);
290    }
291
292    #[test]
293    fn eventd_priority() {
294        let event_title = "my event";
295        let event_text = "text";
296        let event_priority = Priority::Low;
297        let raw = format!(
298            "_e{{{},{}}}:{}|{}|p:{}",
299            event_title.len(),
300            event_text.len(),
301            event_title,
302            event_text,
303            event_priority
304        );
305
306        let expected = EventD::new(event_title, event_text).with_priority(event_priority);
307        let actual = parse_dsd_eventd(raw.as_bytes()).unwrap();
308        check_basic_eventd_eq(expected, actual);
309    }
310
311    #[test]
312    fn eventd_alert_type() {
313        let event_title = "my event";
314        let event_text = "text";
315        let event_alert_type = AlertType::Warning;
316        let raw = format!(
317            "_e{{{},{}}}:{}|{}|t:{}",
318            event_title.len(),
319            event_text.len(),
320            event_title,
321            event_text,
322            event_alert_type
323        );
324
325        let expected = EventD::new(event_title, event_text).with_alert_type(event_alert_type);
326        let actual = parse_dsd_eventd(raw.as_bytes()).unwrap();
327        check_basic_eventd_eq(expected, actual);
328    }
329
330    #[test]
331    fn eventd_multiple_extensions() {
332        let event_title = "my event";
333        let event_text = "text";
334        let event_hostname = MetaString::from("testhost");
335        let event_aggregation_key = MetaString::from("testkey");
336        let event_priority = Priority::Low;
337        let event_source_type = MetaString::from("testsource");
338        let event_alert_type = AlertType::Success;
339        let event_timestamp = 1234567890;
340        let event_local_data = "abcdef123456";
341        let event_external_data = "it-false,cn-redis,pu-810fe89d-da47-410b-8979-9154a40f8183";
342        let event_cardinality = "low";
343        let tags = ["tags1", "tags2"];
344        let shared_tag_set = SharedTagSet::from(TagSet::from_iter(tags.iter().map(|&s| s.into())));
345        let raw = format!(
346            "_e{{{},{}}}:{}|{}|h:{}|k:{}|p:{}|s:{}|t:{}|d:{}|c:{}|e:{}|card:{}|#{}",
347            event_title.len(),
348            event_text.len(),
349            event_title,
350            event_text,
351            event_hostname,
352            event_aggregation_key,
353            event_priority,
354            event_source_type,
355            event_alert_type,
356            event_timestamp,
357            event_local_data,
358            event_external_data,
359            event_cardinality,
360            tags.join(","),
361        );
362        let actual = parse_dsd_eventd(raw.as_bytes()).unwrap();
363        let expected = EventD::new(event_title, event_text)
364            .with_hostname(event_hostname)
365            .with_aggregation_key(event_aggregation_key)
366            .with_priority(event_priority)
367            .with_source_type_name(event_source_type)
368            .with_alert_type(event_alert_type)
369            .with_timestamp(event_timestamp)
370            .with_tags(shared_tag_set);
371        check_basic_eventd_eq(expected, actual);
372
373        let config = DogstatsdCodecConfiguration::default();
374        let (_, packet) = parse_dogstatsd_event(raw.as_bytes(), &config).expect("should not fail to parse");
375        assert_eq!(packet.local_data, Some(event_local_data));
376        assert_eq!(packet.external_data, Some(event_external_data));
377        assert_eq!(packet.cardinality, Some(OriginTagCardinality::Low));
378    }
379
380    #[test]
381    fn empty_structured_fields_treated_as_missing() {
382        // All optional stringy fields are empty — should parse successfully and treat them as missing.
383        let raw = "_e{5,4}:title|text|h:|k:|s:|c:|e:|card:|#";
384        let config = DogstatsdCodecConfiguration::default();
385        let (_, packet) = parse_dogstatsd_event(raw.as_bytes(), &config).expect("should not fail to parse");
386        assert_eq!(packet.hostname, None);
387        assert_eq!(packet.aggregation_key, None);
388        assert_eq!(packet.source_type_name, None);
389        assert_eq!(packet.local_data, None);
390        assert_eq!(packet.external_data, None);
391        assert_eq!(packet.cardinality, None);
392        assert!(packet.tags.into_iter().next().is_none());
393    }
394}
saluki_io/deser/codec/dogstatsd/event.rs

saluki_io/deser/codec/dogstatsd/
event.rs
