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

saluki_io/deser/codec/dogstatsd/
event.rs
