0.16 Upgrade Guide
An upgrade guide that addresses breaking changes in 0.16.0
Vector’s 0.16.0 release includes three breaking changes:
- Component name field renamed to ID
- Datadog Log sink encoding option removed
- Renaming of
datadog_logssource renamed to
kubernetes_logssource’s new RBAC
We cover them below to help you upgrade quickly:
Historically we’ve referred to the component ID field as
name in some places,
id in others. We’ve decided to
ID as we feel this is more closer to the intention of the field: an unchanging identifier for
For example, with the component config:
[transforms.parse_nginx] type = "remap" inputs =  source = ""
parse_nginx part of the config is now only referred to as
ID in the documentation.
We have preserved compatibility with existing usages of
component_name for the
internal_metrics sources by keeping
component_name and adding
component_id as a new tag. Howover, wwe recommend switching usages over to
as we will be removing
component_name in the future: if you were grouping by this tag in your metrics queries, or
referring to it in a
lua transform, you should update it to refer to
Within the GraphQL API, all references to
Components has been updated to be
componentId. This is used
Id has special semantics within the GraphQL ecosystem and we may add support for this field later.
In previous versions of vector it was possible to configure the Datadog logs sink to send in ‘text’ or ‘json’ encoding. While the logs ingest API does accept text format the native format for that API is json. Sending text comes with limitations and is only useful for backward compatability with older clients.
We no longer allow you to set the encoding of the payloads in the Datadog logs sink. For instance, if your configuration looks like so:
[sinks.dd_logs_egress] type = "datadog_logs" inputs = ["datadog_agent"] encoding.codec = "json"
You should remove
encoding.codec entirely, leaving you with:
[sinks.dd_logs_egress] type = "datadog_logs" inputs = ["datadog_agent"]
Encoding fields other than
codec are still valid.
Vector previously documented the
memory_use_bytes metric as
being “The total memory currently being used by Vector (in bytes)."; however,
this metric was actually published by the
lua transform and indicated the
memory use of just the Lua runtime.
To make this more clear, the metric has been renamed from
lua_memory_use_bytes. If you were previously using
a measure of the
lua runtime memory usage, you should update to refer to
The documentation for this metric has also been updated.
With the release of Vector 0.16.0, we’ve renamed the
datadog_logs source to
The naming of the
datadog_logs source was somewhat ambiguous as it could be construed to indicate it is compatible
datadog_logs sink and that it mimics the Datadog Logs API. However, the intention of this
source is to collect data specifically from running Datadog Agents and this release contains some more
baked in assumptions that the data is specifically coming from agent.
For now, this source only collects logs forwarded by the agent, but in the future it will be expanded to collect metrics and traces.
We decided to make this a breaking change, instead of aliasing
datadog_logs, as the released changes are not backwords
compatible and the name change reflects this.
It is possible that we will re-add a
datadog_logs source in the future that mimics the Datadog API for use with other
Datadog clients aside from the agent. Let us know if this would be useful to you!
kubernetes_logs source will now enrich events with labels from the Namespace they originate from. This enhancement
requires access to an additional resource in Kubernetes. Our Kubernetes manifests and Helm chart have been updated to
ClusterRole granting access to the
datadog_logs source components in your configuration to
[sources.datadog] -type = "datadog_logs" +type = "datadog_agent" address = "0.0.0.0:8080" store_api_key = true
Updating to 0.16.0 requires that you update to the equivalent chart or Kubernetes manifests. If you don’t use either of
our provided installation methods, you should update your
ClusterRole as such:
apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: name: vector-agent rules: - apiGroups: - "" resources: + - namespaces - pods verbs: - watch