Processors

Processors

Overview

A processor executes within a Pipeline to complete a data-structuring action and generate attributes to enrich your logs.

In log configuration settings, configure processors such as the Grok parser or date remapper, to help extract, create, and remap attributes to enrich your logs and enhance faceted search.

Notes:

  • Structured logs should be shipped in a valid format. If the structure contains invalid characters for parsing, these should be stripped at the Agent level using the mask_sequences feature.

  • As a best practice, it is recommended to use at most 20 processors per pipeline.

Grok parser

Create custom grok rules to parse the full message or a specific attribute of your raw event. For more information, see the parsing section. As a best practice, it is recommended to use at most 10 parsing rules within a grok processor.

Define the Grok processor in the Datadog Log configuration page:

Click Parse my logs to kickstart a set of three parsing rules for the logs flowing through the underlying pipeline. Refine attribute naming from there, and add new rules for other type of logs if needed. This feature requires that the corresponding logs are being indexed, and actually flowing in—you can temporarily deactivate or sample down exclusion filters to make this work for you.

Select a sample by clicking on it to trigger its evaluation against the parsing rule and display the result at the bottom of the screen.

Up to five samples can be saved with the processor, and each sample can be up to 5000 characters in length. All samples show a status (match or no match), which highlights if one of the parsing rules of the grok parser matches the sample.

Use the Datadog Log Pipeline API endpoint with the following Grok parser JSON payload:

{
  "type": "grok-parser",
  "name": "Parsing Log message",
  "is_enabled": true,
  "source": "message",
  "samples": ["sample log 1", "sample log 2"],
  "grok": {"support_rules": "<SUPPORT_RULES>", "match_rules": "<MATCH_RULES>"}
}
Parameter Type Required Description
type String yes Type of the processor.
name String no Name of the processor.
is_enabled Boolean no If the processors is enabled or not, default: false.
source String yes Name of the log attribute to parse, default: message.
samples Array of Strings no List of (up to 5) sample logs for this grok parser.
grok.support_rules String yes List of Support rules for your grok parser.
grok.match_rules String yes List of Match rules for your grok parser.

Log date remapper

As Datadog receives logs, it timestamps them using the value(s) from any of these default attributes:

  • timestamp
  • date
  • _timestamp
  • Timestamp
  • eventTime
  • published_date

If your logs have dates in an attribute that are not in this list, use the log date remapper processor to define their date attribute as the official log timestamp:

The recognized date formats are: ISO8601, UNIX (the milliseconds EPOCH format), and RFC3164.

If your logs don’t have a timestamp that conforms to the formats listed above, use the grok processor to extract the epoch time from the timestamp to a new attribute. The date remapper uses the newly defined attribute.

To see how a custom date and time format can be parsed in Datadog, see Parsing dates.

Note:

  • Log events can be submitted up to 18h in the past and 2h in the future.
  • If your logs don’t contain any of the default attributes and you haven’t defined your own date attribute, Datadog timestamps the logs with the date it received them.
  • If multiple log date remapper processors are applied to a given log, only the first one (according to the pipeline’s order) is taken into account.

Define the log date remapper processor in the Datadog Log configuration page:

Use the Datadog Log Pipeline API endpoint with the following log date remapper JSON payload:

{
  "type": "date-remapper",
  "name": "Define <SOURCE_ATTRIBUTE> as the official Date of the log",
  "is_enabled": false,
  "sources": ["<SOURCE_ATTRIBUTE_1>"]
}
Parameter Type Required Description
type String yes Type of the processor.
name String no Name of the processor.
is_enabled Boolean no If the processors is enabled or not, default: false
sources Array of Strings yes Array of source attributes.

Log status remapper

Use the status remapper processor to assign attributes as an official status to your logs. For example, add a log severity level to your logs with the status remapper.

Each incoming status value is mapped as follows:

  • Integers from 0 to 7 map to the Syslog severity standards
  • Strings beginning with emerg or f (case-insensitive) map to emerg (0)
  • Strings beginning with a (case-insensitive) map to alert (1)
  • Strings beginning with c (case-insensitive) map to critical (2)
  • Strings beginning with e (case-insensitive)—that do not match emerg—map to error (3)
  • Strings beginning with w (case-insensitive) map to warning (4)
  • Strings beginning with n (case-insensitive) map to notice (5)
  • Strings beginning with i (case-insensitive) map to info (6)
  • Strings beginning with d, trace or verbose (case-insensitive) map to debug (7)
  • Strings beginning with o or s, or matching OK or Success (case-insensitive) map to OK
  • All others map to info (6)

Note: If multiple log status remapper processors are applied to a given log, only the first one (according to the pipeline’s order) is taken into account.

Define the log status remapper processor in the Datadog Log configuration page:

Use the Datadog Log Pipeline API endpoint with the following log status remapper JSON payload:

{
  "type": "status-remapper",
  "name": "Define <SOURCE_ATTRIBUTE> as the official status of the log",
  "is_enabled": true,
  "sources": ["<SOURCE_ATTRIBUTE>"]
}
Parameter Type Required Description
type String yes Type of the processor.
name String no Name of the processor.
is_enabled Boolean no If the processors is enabled or not, default: false
sources Array of Strings yes Array of source attributes.

Service remapper

The service remapper processor assigns one or more attributes to your logs as the official service.

Note: If multiple service remapper processors are applied to a given log, only the first one (according to the pipeline’s order) is taken into account.

Define the log service remapper processor in the Datadog Log configuration page:

Use the Datadog Log Pipeline API endpoint with the following log service remapper JSON payload:

{
  "type": "service-remapper",
  "name": "Define <SOURCE_ATTRIBUTE> as the official log service",
  "is_enabled": true,
  "sources": ["<SOURCE_ATTRIBUTE>"]
}
Parameter Type Required Description
type String yes Type of the processor.
name String no Name of the processor.
is_enabled Boolean no If the processors is enabled or not, default: false
sources Array of Strings yes Array of source attributes.

Log message remapper

Message is a key attribute in Datadog. It is displayed in the message column of the Log Explorer to give context to a log. You can use the search to find a log by log message. Use the log message remapper processor to define one or more attributes as the official log message.

Note: If multiple log message remapper processors are applied to a given log, only the first one (according to the pipeline order) is taken into account.

Define the log message remapper processor in the Datadog Log configuration page:

Use the Datadog Log Pipeline API endpoint with the following log message remapper JSON payload:

{
  "type": "message-remapper",
  "name": "Define <SOURCE_ATTRIBUTE> as the official message of the log",
  "is_enabled": true,
  "sources": ["msg"]
}
Parameter Type Required Description
type String yes Type of the processor.
name String no Name of the processor.
is_enabled Boolean no If the processors is enabled or not, default: false
sources Array of Strings yes Array of source attributes, default: msg

Remapper

The remapper processor remaps any source attribute(s) or tags to another target attribute or tag. For example, remap user by firstname to target your logs in the Log Explorer:

Constraints on the tag/attribute name are explained in the attributes and tags documentation. Some additional constraints, applied as : or ,, are not allowed in the target tag/attribute name.

If the target of the remapper is an attribute, the remapper can also try to cast the value to a new type (String, Integer or Double). If the cast is not possible, the original type is kept.

Note: The decimal separator for Double need to be ..

Define the remapper processor in the Datadog Log configuration page. For example, remap user to user.firstname.

Use the Datadog Log Pipeline API endpoint with the following Remapper JSON payload:

{
  "type": "attribute-remapper",
  "name": "Remap <SOURCE_ATTRIBUTE> to <TARGET_ATTRIBUTE>",
  "is_enabled": true,
  "source_type": "attribute",
  "sources": ["<SOURCE_ATTRIBUTE>"],
  "target": "<TARGET_ATTRIBUTE>",
  "target_type": "tag",
  "target_format": "integer",
  "preserve_source": false,
  "override_on_conflict": false
}
Parameter Type Required Description
type String yes Type of the processor.
name String no Name of the processor.
is_enabled Boolean no If the processors is enabled or not, default: false
source_type String no Defines if the sources are from log attribute or tag, default: attribute
sources Array of Strings yes Array of source attributes or tags
target String yes Final attribute or tag name to remap the sources to.
target_type String no Defines if the target is a log attribute or a tag, default: attribute
target_format String no Defines if the attribute value should be cast to another type. possible value: auto, string, long or integer, default: auto. When set to auto, no cast is applied.
preserve_source Boolean no Remove or preserve the remapped source element, default: false
override_on_conflict Boolean no Override or not the target element if already set, default: false

URL parser

The URL parser processor extracts query parameters and other important parameters from a URL. When setup, the following attributes are produced:

Define the URL parser processor in the Datadog Log configuration page:

{
  "type": "url-parser",
  "name": "Parse the URL from http.url attribute.",
  "is_enabled": true,
  "sources": ["http.url"],
  "target": "http.url_details"
}
Parameter Type Required Description
type String yes Type of the processor.
name String no Name of the processor.
is_enabled Boolean no If the processors is enabled or not, default: false
sources Array of Strings no Array of source attributes, default: http.url
target String yes Name of the parent attribute that contains all the extracted details from the sources, default: http.url_details

User-Agent parser

The user-agent parser processor takes a useragent attribute and extracts OS, browser, device, and other user data. When set up, the following attributes are produced:

Note: If your logs contain encoded user-agents (for example, IIS logs), configure this Processor to decode the URL before parsing it.

Define the user-agent processor in the Datadog Log configuration page:

Use the Datadog Log Pipeline API endpoint with the following user-agent parser JSON payload:

{
  "type": "user-agent-parser",
  "name": "Parses <SOURCE_ATTRIBUTE> to extract all its User-Agent information",
  "is_enabled": true,
  "sources": ["http.useragent"],
  "target": "http.useragent_details",
  "is_encoded": false
}
Parameter Type Required Description
type String yes Type of the processor.
name String no Name of the processor.
is_enabled Boolean no If the processors is enabled or not, default: false.
sources Array of Strings no Array of source attributes, default: http.useragent.
target String yes Name of the parent attribute that contains all the extracted details from the sources, default: http.useragent_details.
is_encoded Boolean no Define if the source attribute is url encoded or not, default: false.

Category processor

Use the category processor to add a new attribute (without spaces or special characters in the new attribute name) to a log matching a provided search query. Then, use categories to create groups for an analytical view (for example, URL groups, machine groups, environments, and response time buckets).

Note:

  • The syntax of the query is the one in the Logs Explorer search bar. This query can be done on any log attribute or tag, whether it is a facet or not. Wildcards can also be used inside your query.
  • Once the log has matched one of the processor queries, it stops. Make sure they are properly ordered in case a log could match several queries.
  • The names of the categories must be unique.
  • Once defined in the category processor, you can map categories to log status using the log status remapper.

Define the category processor in the Datadog Log configuration page. For example, to categorize your web access logs based on the status code range value ("OK" for a response code between 200 and 299, "Notice" for a response code between 300 and 399, ...) add this processor:

This processor produces the following result:

Use the Datadog Log Pipeline API endpoint with the following category processor JSON payload:

{
  "type": "category-processor",
  "name": "Assign a custom value to the <TARGET_ATTRIBUTE> attribute",
  "is_enabled": true,
  "categories": [
    {"filter": {"query": "<QUERY_1>"}, "name": "<VALUE_TO_ASSIGN_1>"},
    {"filter": {"query": "<QUERY_2>"}, "name": "<VALUE_TO_ASSIGN_2>"}
  ],
  "target": "<TARGET_ATTRIBUTE>"
}
Parameter Type Required Description
type String yes Type of the processor.
name String no Name of the processor.
is_enabled Boolean no If the processors is enabled or not, default: false
categories Array of Object yes Array of filters to match or not a log and their corresponding name to assign a custom value to the log.
target String yes Name of the target attribute which value is defined by the matching category.

Arithmetic processor

Use the arithmetic processor to add a new attribute (without spaces or special characters in the new attribute name) to a log with the result of the provided formula. This remaps different time attributes with different units into a single attribute, or compute operations on attributes within the same log.

A arithmetic processor formula can use parentheses and basic arithmetic operators: -, +, *, /.

By default, a calculation is skipped if an attribute is missing. Select Replace missing attribute by 0 to automatically populate missing attribute values with 0 to ensure that the calculation is done.

Note: An attribute may be listed as missing if it is not found in the log attributes, or if it cannot be converted to a number.

Notes:

  • The operator - needs to be space split in the formula as it can also be contained in attribute names.
  • If the target attribute already exists, it is overwritten by the result of the formula.
  • Results are rounded up to the 9th decimal. For example, if the result of the formula is 0.1234567891, the actual value stored for the attribute is 0.123456789.
  • If you need to scale a unit of measure, use the scale filter.

Define the arithmetic processor in the Datadog Log configuration page:

Use the Datadog Log Pipeline API endpoint with the following arithmetic processor JSON payload:

{
  "type": "arithmetic-processor",
  "name": "<PROCESSOR_NAME>",
  "is_enabled": true,
  "expression": "<ARITHMETIC_OPERATION>",
  "target": "<TARGET_ATTRIBUTE>",
  "is_replace_missing": false
}
Parameter Type Required Description
type String yes Type of the processor.
name String no Name of the processor.
is_enabled Boolean no If the processors is enabled or not, default: false.
expression String yes Arithmetic operation between one or more log attributes.
target String yes Name of the attribute that contains the result of the arithmetic operation.
is_replace_missing Boolean no If true, it replaces all missing attributes of expression by 0, false skip the operation if an attribute is missing. Default: false.

String builder processor

Use the string builder processor to add a new attribute (without spaces or special characters) to a log with the result of the provided template. This enables aggregation of different attributes or raw strings into a single attribute.

The template is defined by both raw text and blocks with the syntax %{attribute_path}.

Notes:

  • This processor only accepts attributes with values or an array of values in the block (see examples in the UI section below.
  • If an attribute cannot be used (object or array of object), it is replaced by an empty string or the entire operation is skipped depending on your selection.
  • If a target attribute already exists, it is overwritten by the result of the template.
  • Results of a template cannot exceed 256 characters.

Define the string builder processor on the Datadog log configuration page:

With the following log, use the template Request %{http.method} %{http.url} was answered with response %{http.status_code} to returns a result. For example:

{
  "http": {
    "method": "GET",
    "status_code": 200,
    "url": "https://app.datadoghq.com/users"
  },
  "array_ids": [123, 456, 789],
  "array_users": [
    {"first_name": "John", "last_name": "Doe"},
    {"first_name": "Jack", "last_name": "London"}
  ]
}
Request GET https://app.datadoghq.com/users was answered with response 200

Note: http is an object and cannot be used in a block (%{http} fails), whereas %{http.method}, %{http.status_code}, or %{http.url} returns the corresponding value. Blocks can be used on arrays of values or on a specific attribute within an array. For example, adding the block %{array_ids} returns:

```text
123,456,789
```

Whereas `%{array_users}` does not return anything because it is a list of objects.
However, `%{array_users.first_name}` returns a list of `first_name` contained in the array:

```text
John,Jack
```

Use the Datadog Log Pipeline API endpoint with the following string builder processor JSON payload:

{
  "type": "string-builder-processor",
  "name": "<PROCESSOR_NAME>",
  "is_enabled": true,
  "template": "<STRING_BUILDER_TEMPLATE>",
  "target": "<TARGET_ATTRIBUTE>",
  "is_replace_missing": true
}
Parameter Type Required Description
type String Yes Type of the processor.
name String No Name of the processor.
is_enabled Boolean No If the processor is enabled or not, defaults to false.
template String Yes A formula with one or more attributes and raw text.
target String Yes The name of the attribute that contains the result of the template.
is_replace_missing Boolean No If true, it replaces all missing attributes of template by an empty string. If false (default), skips the operation for missing attributes.

GeoIP parser

The geoIP parser takes an IP address attribute and extracts continent, country, subdivision, or city information (if available) in the target attribute path.

Most elements contain a name and iso_code (or code for continent) attribute. subdivision is the first level of subdivision that the country uses such as “States” for the United States or “Departments” for France.

For example, the geoIP parser extracts location from the network.client.ip attribute and stores it into the network.client.geoip attribute:

Use the Datadog Log Pipeline API endpoint with the following geoIP parser JSON payload:

{
  "type": "geo-ip-parser",
  "name": "Parse the geolocation elements from network.client.ip attribute.",
  "is_enabled": true,
  "sources": ["network.client.ip"],
  "target": "network.client.geoip"
}
Parameter Type Required Description
type String yes Type of the processor.
name String no Name of the processor.
is_enabled Boolean no If the processors is enabled or not, default: false
sources Array of Strings no Array of source attributes, default: network.client.ip
target String yes Name of the parent attribute that contains all the extracted details from the sources, default: network.client.geoip

Lookup processor

Use the lookup processor to define a mapping between a log attribute and a human readable value saved in an Enrichment Table (beta) or the processors mapping table.

For example, you can use the lookup processor to map an internal service ID into a human readable service name.

Alternatively, you can use it to check if the MAC address that just attempted to connect to the production environment belongs to your list of stolen machines.

The lookup processor performs the following actions:

  • Looks if the current log contains the source attribute.
  • Checks if the source attribute value exists in the mapping table.
    • If it does, creates the target attribute with the corresponding value in the table.
    • Optionally, if it does not find the value in the mapping table, creates a target attribute with the filled default value.

You can fill the mapping table by selecting an enrichment table or manually by entering a list of source_key,target_value pairs, or uploading a CSV file.

The size limit for the mapping table is 100Kb. This limit applies across all Lookup Processors on the platform, however, Enrichment tables support larger file sizes.

Use the Datadog Log Pipeline API endpoint with the following lookup processor JSON payload:

{
  "type": "lookup-processor",
  "name": "<PROCESSOR_NAME>",
  "is_enabled": true,
  "source": "<SOURCE_ATTRIBUTE>",
  "target": "<TARGET_ATTRIBUTE>",
  "lookup_table": ["key1,value1", "key2,value2"],
  "default_lookup": "<DEFAULT_TARGET_VALUE>"
}
Parameter Type Required Description
type String yes Type of the processor.
name String no Name of the processor.
is_enabled Boolean yes If the processor is enabled or not. Default: false
source String yes Source attribute used to perform the lookup.
target String yes Name of the attribute that contains the corresponding value in the mapping list or the default_lookup if not found in the mapping list.
lookup_table Array of strings yes Mapping table of values for the source attribute and their associated target attribute values, formatted as [ “source_key1,target_value1”, “source_key2,target_value2” ]
default_lookup String no Value to set the target attribute if the source value is not found in the list.

Trace remapper

There are two ways to improve correlation between application traces and logs:

  1. Follow the documentation on how to inject a Trace ID in the application logs. Log integrations take care of all the rest of the setup by default.

  2. Use the trace remapper processor to define a log attribute as its associated trace ID.

Define the trace remapper processor in the Datadog Log configuration page. Enter the Trace ID attribute path in the processor tile as follows:

Use the Datadog Log Pipeline API endpoint with the following trace remapper JSON payload:

{
  "type": "trace-id-remapper",
  "name": "Define dd.trace_id as the official trace id associate to this log",
  "is_enabled": true,
  "sources": ["dd.trace_id"]
}
Parameter Type Required Description
type String yes Type of the processor.
name String no Name of the processor.
is_enabled Boolean no If the processors is enabled or not, default: false.
sources Array of Strings no Array of source attributes, default: dd.trace_id.

Further Reading


*Logging without Limits is a trademark of Datadog, Inc.