Project: Vector (Observability and Analysis / Observability)
File: 2020-12-01-0-11-upgrade-guide.md

date: "2020-12-01" title: "0.11 Upgrade Guide" description: "An upgrade guide that addresses breaking changes in 0.11.0" authors: ["binarylogic"] pr_numbers: [3557, 4580, 4557, 4647, 4918, 3297, 3427, 4103] release: "0.11.0" hideonrelease_notes: false badges: type: "breaking change" 0.11 includes some minor breaking changes: We cover each below to help you upgrade quickly: We have not officially announced the `internal_metrics` source (coming in 0.12) due to the high probability of metric name changes.Since then we've settled on a that is largely inspired by the . 0.11 includes these naming changes. To upgrade, please see the following: You'll likely need to update any downstream consumers of this data. We plan to ship official Vector dashboards in 0.12 that will relieve this maintenance burden for you in the future. If you're using the you'll need to add the new `mode` option that specifies which protocol you'd like to use. Previously, the only protocol available was UDP. ```diff title="vector.toml" [sinks.statsd] type = "statsd" mode = "udp" ``` Previously, the `splunkhec` sink was using the event's `sourcetype` field and mapping that to Splunk's expected `sourcetype` field. Splunk uses this field to inform parsing and processing of the data. Because this field can vary depending on your data, we've made the `sourcetype` field an explicit option: ```diff title="vector.toml" [sinks.reduce] type = "splunk_hec" sourcetype = "syslog" # only set this if your `message` field is formatted as syslog ``` Only set this field if you want to explicitly inform Splunk of your `message` field's format. Most users will not want to set this field. Vector's previous Systemd unit file included configuration that forwarded Vector's logs over Syslog. This was presumptuous and we've removed these settings in favor of your system defaults. If you'd like Vector to continue logging to Syslog, you'll need to add back the , but most users should not have to do anything. Previously, the `http` source would dedot JSON keys in incoming data. This means that a JSON payload like this: ```json { "first.second": "value" } ``` Would turn into this after being ingested into Vector: ```json { "first": { "second": "value" } } ``` This is incorrect as Vector should not alter your data in this way. This has been corrected and your events will keep `.` in their key names. There is nothing you need to do to upgrade except understand that your data structure may change if it contained `.` characters in the keys. The `prometheus` sink has been renamed to `prometheus_exporter` since 0.11 introduced a new `prometheusremotewrite` sink. This renaming distinguishes between the two. Upgrading is easy: ```diff title="vector.toml" [sinks.prometheus] type = "prometheus" type = "prometheus_exporter" namespace = "..." default_namespace = "..." ``` We renamed the `reduce` transform's `identifierfields` option to `groupby` for clarity. We are repositioning this transform to handle broad reduce operations, such as merging multi-line logs together: ```diff title="vector.toml" [sinks.reduce] type = "reduce" identifierfields = ["myfield"] groupby = ["myfield"] ```