This page is not yet available in Spanish. We are working on its translation. If you have any questions or feedback about our current translation project, feel free to reach out to us!
Observability Pipelines is not available on the US1-FED Datadog site.
A transform allows you to parse, structure, and enrich your data. You can use multiple transforms in your pipeline.
A list of metadata fields to include in each transformed event.
namespace
optional
<oneOf>
Sets a prefix for all event fields added by the transform.
Option 1
optional
string
An optional path that deserializes an empty string to None.
proxy
optional
object
Proxy configuration.
Configure to proxy traffic through an HTTP(S) proxy when making external requests.
Similar to common proxy configuration convention, you can set different proxies
to use based on the type of traffic being proxied, as well as set specific hosts that
should not be proxied.
enabled
optional
boolean
Enables proxying support.
default: true
http
optional
uri
Proxy endpoint to use when proxying HTTP traffic.
Must be a valid URI string.
default: null
https
optional
uri
Proxy endpoint to use when proxying HTTPS traffic.
Must be a valid URI string.
default: null
no_proxy
optional
[string]
A list of hosts to avoid proxying.
Multiple patterns are allowed:
Pattern
Example match
Domain names
example.com matches requests to example.com
Wildcard domains
.example.com matches requests to example.com and its subdomains
Number of events to cache and use for comparing incoming events to previously seen events.
default: 5000
fields
optional
<oneOf>
Options to control what fields to match against.
When no field matching configuration is specified, events are matched using the timestamp,
host, and message fields from an event. The specific field names used are those set in
the global log schema configuration.
Option 1
optional
<oneOf>
Options to control what fields to match against.
When no field matching configuration is specified, events are matched using the timestamp,
host, and message fields from an event. The specific field names used are those set in
the global log schema configuration.
MatchFields
optional
object
Matches events using only the specified fields.
match
required
[string]
A wrapper around OwnedTargetPath that allows it to be used in Vector config
with prefix default to PathPrefix::Event
IgnoreFields
optional
object
Matches events using all fields except for the ignored ones.
ignore
required
[string]
A wrapper around OwnedTargetPath that allows it to be used in Vector config
with prefix default to PathPrefix::Event
Name of the tag in the metric to use for the source host.
If present, the value of the tag is set on the generated log event in the host field,
where the field key uses the global host_key option.
log_namespace
optional
boolean,null
The namespace to use for logs. This overrides the global setting.
metric_tag_values
optional
<oneOf>
Controls how metric tag values are encoded.
When set to single, only the last non-bare value of tags are displayed with the
metric. When set to full, all metric tags are exposed as separate assignments as
described by the native_json codec.
single
optional
single
Tag values are exposed as single strings, the same as they were before this config
option. Tags with multiple values show the last assigned value, and null values
are ignored.
full
optional
full
All tags are exposed as arrays of either string or null values.
timezone
optional
<oneOf>
The name of the time zone to apply to timestamp conversions that do not contain an explicit
time zone.
This overrides the global timezone option. The time zone name may be
any name in the TZ database or local to indicate system local time.
Option 1
optional
<oneOf>
Timezone reference.
This can refer to any valid timezone as defined in the TZ database, or "local" which refers to the system local timezone.
A condition used to distinguish the final event of a transaction.
If this condition resolves to true for an event, the current transaction is immediately
flushed with this event.
Option 1
optional
<oneOf>
An event matching condition.
Many methods exist for matching events, such as using a VRL expression, a Datadog Search query string,
or hard-coded matchers like "must be a metric" or "fields A, B, and C must match these constraints".
As VRL is the most common way to apply conditions to events, this type provides a shortcut to define VRL expressions
directly in the configuration by passing the VRL expression as a string:
condition = '.message == "hooray"'
When other condition types are required, they can be specified with an enum-style notation:
The maximum period of time to wait after the last event is received, in milliseconds, before
a combined event should be considered complete.
flush_period_ms
optional
integer
The interval to check for and flush any expired events, in milliseconds.
group_by
optional
[string]
An ordered list of fields by which to group events.
Each group with matching values for the specified keys is reduced independently, allowing
you to keep independent event streams separate. When no fields are specified, all events
are combined in a single group.
For example, if group_by = ["host", "region"], then all incoming events that have the same
host and region are grouped together before being reduced.
max_events
optional
integer,null
The maximum number of events to group together.
merge_strategies
optional
object
A map of field names to custom merge strategies.
For each field specified, the given strategy is used for combining events rather than
the default behavior.
The default behavior is as follows:
The first value of a string field is kept and subsequent values are discarded.
For timestamp fields the first is kept and a new field [field-name]_end is added with
the last received timestamp value.
Numeric values are summed.
starts_when
optional
<oneOf>
A condition used to distinguish the first event of a transaction.
If this condition resolves to true for an event, the previous transaction is flushed
(without this event) and a new transaction is started.
Option 1
optional
<oneOf>
An event matching condition.
Many methods exist for matching events, such as using a VRL expression, a Datadog Search query string,
or hard-coded matchers like "must be a metric" or "fields A, B, and C must match these constraints".
As VRL is the most common way to apply conditions to events, this type provides a shortcut to define VRL expressions
directly in the configuration by passing the VRL expression as a string:
condition = '.message == "hooray"'
When other condition types are required, they can be specified with an enum-style notation:
Drops any event that is manually aborted during processing.
Normally, if a VRL program is manually aborted (using abort) when
processing an event, the original, unmodified event is sent downstream. In some cases,
you may not wish to send the event any further, such as if certain transformation or
enrichment is strictly required. Setting drop_on_abort to true allows you to ensure
these events do not get processed any further.
Additionally, dropped events can potentially be diverted to a specially-named output for
further logging and analysis by setting reroute_dropped.
drop_on_error
optional
boolean
Drops any event that encounters an error during processing.
Normally, if a VRL program encounters an error when processing an event, the original,
unmodified event is sent downstream. In some cases, you may not want to send the event
any further, such as if certain transformation or enrichment is strictly required. Setting
drop_on_error to true allows you to ensure these events do not get processed any
further.
Additionally, dropped events can potentially be diverted to a specially named output for
further logging and analysis by setting reroute_dropped.
If a relative path is provided, its root is the current working directory.
Required if source is missing.
Option 1
optional
string
A file path.
metric_tag_values
optional
<oneOf>
When set to single, metric tag values are exposed as single strings, the
same as they were before this config option. Tags with multiple values show the last assigned value, and null values
are ignored.
When set to full, all metric tags are exposed as arrays of either string or null
values.
single
optional
single
Tag values are exposed as single strings, the same as they were before this config
option. Tags with multiple values show the last assigned value, and null values
are ignored.
full
optional
full
All tags are exposed as arrays of either string or null values.
reroute_dropped
optional
boolean
Reroutes dropped events to a named output instead of halting processing on them.
When using drop_on_error or drop_on_abort, events that are "dropped" are processed no
further. In some cases, it may be desirable to keep the events around for further analysis,
debugging, or retrying.
In these cases, reroute_dropped can be set to true which forwards the original event
to a specially-named output, dropped. The original event is annotated with additional
fields describing why the event was dropped.
Reroutes unmatched events to a named output instead of silently discarding them.
Normally, if an event doesn't match any defined route, it is sent to the <transform_name>._unmatched
output for further processing. In some cases, you may want to simply discard unmatched events and not
process them any further.
In these cases, reroute_unmatched can be set to false to disable the <transform_name>._unmatched
output and instead silently discard any unmatched events.
route
optional
object
A table of route identifiers to logical conditions representing the filter of the route.
Each route can then be referenced as an input by other components with the name
<transform_name>.<route_id>. If an event doesn’t match any route, and if reroute_unmatched
is set to true (the default), it is sent to the <transform_name>._unmatched output.
Otherwise, the unmatched event is instead silently discarded.
Both _unmatched, as well as _default, are reserved output names and thus cannot be used
as a route name.
A logical condition used to exclude events from sampling.
Option 1
optional
<oneOf>
An event matching condition.
Many methods exist for matching events, such as using a VRL expression, a Datadog Search query string,
or hard-coded matchers like "must be a metric" or "fields A, B, and C must match these constraints".
As VRL is the most common way to apply conditions to events, this type provides a shortcut to define VRL expressions
directly in the configuration by passing the VRL expression as a string:
condition = '.message == "hooray"'
When other condition types are required, they can be specified with an enum-style notation:
The name of the field whose value is hashed to determine if the event should be
sampled.
Each unique value for the key creates a bucket of related events to be sampled together
and the rate is applied to the buckets themselves to sample 1/N buckets. The overall rate
of sampling may differ from the configured one if values in the field are not uniformly
distributed. If left unspecified, or if the event doesn’t have key_field, then the
event is sampled independently.
This can be useful to, for example, ensure that all logs for a given transaction are
sampled together, but that overall 1/N transactions are sampled.
rate
required
integer
The rate at which events are forwarded, expressed as 1/N.
For example, rate = 10 means 1 out of every 10 events are forwarded and the rest are
dropped.
Array of rules containing all the scanning rules inside the scanning group.
name
required
string
The name of this scanning rule.
on_match
required
<oneOf>
Define action on match
Scrubbing and hashing are irreversible changes. Please be sure you want to replace the
matching values with the replacement text or hashed value.
Redact to replace all matching values entirely with a single token of your choice.
Partially redact to replace a specific portion of all matching values.
Hash to replace all matching values entirely with a non-reversible unique identifier.
Redact
optional
object
Redact the matched data by replacing it with a fixed string.
action
required
redact
Redact the matched data by replacing it with a fixed string.
replace
required
string
The replacement text.
Hash
optional
object
Hash the matched data with the farmhash algorithm.
action
required
hash
Hash the matched data with the farmhash algorithm.
PartialRedact
optional
object
Replace part of the matched data with asterisks.
action
required
partial_redact
Replace part of the matched data with asterisks.
characters
required
integer
How many characters should be redacted?
option
required
<oneOf>
Which part of the matched data should be redacted?
first
optional
first
Redact the first characters.
last
optional
last
Redact the last characters.
pattern
required
<oneOf>
The sensitive data pattern to match in the events.
Custom
optional
object
Use a custom regex rule to scan this pattern.
rule
required
string
The custom rule regex pattern.
The log content is checked against the regular expression below.
type
required
custom
Use a custom regex rule to scan this pattern.
Library
optional
object
Look up a rule name in the library of pre-configured patterns.
name
required
<oneOf>
The name of the library pattern.
type
required
library
Look up a rule name in the library of pre-configured patterns.
scope
required
<oneOf>
Scan entire event or portion of it
By default, the regex is checked on all log attributes. For finer grained processing,
identify an inclusion or exclusion list of attributes with a comma-separated list, such as
admin.email, recipient.
Entire
optional
object
Entire Event
exclude
optional
[string]
The list of field names to exclude.
target
required
entire event
Entire Event
Attribute
optional
object
Specific Attributes
include
optional
[string]
The list of field names to include.
target
required
specific attributes
Specific Attributes
tags
optional
[string]
An optional array of tags to associated with matched events.
A logical condition used to exclude events from sampling.
Option 1
optional
<oneOf>
An event matching condition.
Many methods exist for matching events, such as using a VRL expression, a Datadog Search query string,
or hard-coded matchers like "must be a metric" or "fields A, B, and C must match these constraints".
As VRL is the most common way to apply conditions to events, this type provides a shortcut to define VRL expressions
directly in the configuration by passing the VRL expression as a string:
condition = '.message == "hooray"'
When other condition types are required, they can be specified with an enum-style notation:
The value to group events into separate buckets to be rate limited independently.
If left unspecified, or if the event doesn't have key_field, then the event is not rate
limited separately.
Option 1
optional
string
A templated field.
In many cases, components can be configured so that part of the component's functionality can be
customized on a per-event basis. For example, you have a sink that writes events to a file and you want to
specify which file an event should go to by using an event field as part of the
input to the filename used.
By using Template, users can specify either fixed strings or templated strings. Templated strings use a common syntax to
refer to fields in an event that is used as the input data when rendering the template. An example of a fixed string
is my-file.log. An example of a template string is my-file-{{key}}.log, where {{key}}
is the key's value when the template is rendered into a string.
threshold
required
integer
The number of events allowed for a given bucket per configured window_secs.
Each unique key has its own threshold.
window_secs
required
number
The time window in which the configured threshold is applied, in seconds.
