Data Streams Ex
v1.2.2

View Source Datadog.DataStreams.Tags (Data Streams Ex v1.2.2)

A helper module to enumerate and filter over data stream tags.

Summary

Types

encoded()

An encoded list of tags. This is the format that Datadog expects when we send data. It's a list of key value binary joined via :. For example: "partition:1", "group:some-consumer-group", "topic:a-topic".

input()

All allowed tag input types. This could be any one of the following examples

t()

The type all tags are internally mapped to.

Functions

encode(tags)

Tags a list of tags and converts them to a list of binary tags. This is the format that Datadog expects. This also orders the tags to ensure it matches other languages when hashing.

filter(tags, arg2)

Filters a list of tags to a known list of allowed tags. This varies based on the context of where it is used.

parse(input)

Parses any type of tag input and normalizes it to our internal t:t type. Note this will also filter out invalid data like nil values.

Types

Link to this type

encoded()

View Source 
@type encoded() :: [binary()]

An encoded list of tags. This is the format that Datadog expects when we send data. It's a list of key value binary joined via :. For example: "partition:1", "group:some-consumer-group", "topic:a-topic".

Link to this type

input()

View Source 
@type input() ::
  [{binary() | atom(), binary()}]
  | %{required(binary() | atom()) => binary()}
  | [binary()]

All allowed tag input types. This could be any one of the following examples:

[{:key, "value"}, {:key_two, "value_two"}]
[{"key", "value"}, {"key_two", "value_two"}]
%{key: "value", key_two: "value_two"}
%{"key" => "value", "key_two" => "value_two"}
["key:value", "key_two:value_two"]
Link to this type

t()

View Source 
@type t() :: [{binary(), binary()}]

The type all tags are internally mapped to.

Functions

Link to this function

encode(tags)

View Source 
@spec encode(t()) :: [binary()]

Tags a list of tags and converts them to a list of binary tags. This is the format that Datadog expects. This also orders the tags to ensure it matches other languages when hashing.

Examples 

iex> Tags.encode([{"tag_two", "value_two"}, {"tag", "value"}])
["tag:value", "tag_two:value_two"]
Link to this function

filter(tags, arg2)

View Source 
@spec filter(t(), atom()) :: t()

Filters a list of tags to a known list of allowed tags. This varies based on the context of where it is used.

Examples 

iex> [{"key", "value"}, {"topic", "one"}, {"key_two", "value_two"}]
...> |> Tags.filter(:hash)
[{"topic", "one"}]
Link to this function

parse(input)

View Source 
@spec parse(input()) :: t()

Parses any type of tag input and normalizes it to our internal t:t type. Note this will also filter out invalid data like nil values.

Examples 

iex> [{:key, "value"}, {:key_two, "value_two"}]
...> |> Tags.parse()
[{"key", "value"}, {"key_two", "value_two"}]

iex> [{"key", "value"}, {"key_two", "value_two"}]
...> |> Tags.parse()
[{"key", "value"}, {"key_two", "value_two"}]

iex> %{key: "value", key_two: "value_two"}
...> |> Tags.parse()
[{"key", "value"}, {"key_two", "value_two"}]

iex> %{"key" => "value", "key_two" => "value_two"}
...> |> Tags.parse()
[{"key", "value"}, {"key_two", "value_two"}]

iex> ["key:value", "key_two:value_two"]
...> |> Tags.parse()
[{"key", "value"}, {"key_two", "value_two"}]

iex> [{"key", nil}, {"key_two", "value_two"}]
...> |> Tags.parse()
[{"key_two", "value_two"}]