Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: ensure graylog spec fields not prefixed with '_' #10209

Merged
merged 2 commits into from
Dec 6, 2021

Conversation

powersj
Copy link
Contributor

@powersj powersj commented Dec 2, 2021

The Graylog GELF spec[1] there are a number of fields that are part of
the spec and should not be prefixed by a '_'. The only fields that get
the underscore per the spec are additional fields not part of the spec.

[1] https://docs.graylog.org/docs/gelf

Required for all PRs:

resolves #

The Graylog GELF spec[1] there are a number of fields that are part of
the spec and should *not* be prefixed by a '_'. The only fields that get
the underscore per the spec are additional fields not part of the spec.

[1] https://docs.graylog.org/docs/gelf
@telegraf-tiger telegraf-tiger bot added the fix pr to fix corresponding bug label Dec 2, 2021
Copy link
Member

@srebhan srebhan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmm. I think this is a breaking change as all of the sudden the produced messages are different from the ones before the change. I think you need to add a flag (e.g. conform_to_spec) defaulting to the previous behavior (false in the suggested case)...

@srebhan srebhan self-assigned this Dec 6, 2021
@powersj
Copy link
Contributor Author

powersj commented Dec 6, 2021

Hmmm. I think this is a breaking change as all of a sudden the produced messages are different from the ones before the change. I think you need to add a flag (e.g. conform_to_spec) defaulting to the previous behavior (false in the suggested case)...

We are currently not sending data according to the Graylog spec. The spec makes it clear that only specific values should exist in a message and anything else should be prefixed by an underscore. There are currently five fields we were not handling correctly before this change: full_message, level, facility, line, and file.

From a user perspective yes it is a change, but I disagree that a user should have to turn on a flag to have valid Graylog messages in the first place.

@powersj
Copy link
Contributor Author

powersj commented Dec 6, 2021

Chatted as a team and as this is fixing the plugin to conform to the spec we are going to merge as-is.

@powersj powersj merged commit 7049967 into influxdata:master Dec 6, 2021
MyaLongmire pushed a commit that referenced this pull request Dec 8, 2021
powersj added a commit to powersj/telegraf that referenced this pull request Jan 21, 2022
@powersj powersj deleted the fix/graylog-spec-fields branch January 23, 2022 21:11
phemmer added a commit to phemmer/telegraf that referenced this pull request Feb 18, 2022
* origin/master: (133 commits)
  chore: restart service if it is already running and upgraded via RPM (influxdata#9970)
  feat: update etc/telegraf.conf and etc/telegraf_windows.conf (influxdata#10237)
  fix: Handle duplicate registration of protocol-buffer files gracefully. (influxdata#10188)
  fix(http_listener_v2): fix panic on close (influxdata#10132)
  feat: add Vault input plugin (influxdata#10198)
  feat: support aws managed service for prometheus (influxdata#10202)
  fix: Make telegraf compile on Windows with golang 1.16.2 (influxdata#10246)
  Update changelog
  feat: Modbus add per-request tags (influxdata#10231)
  fix: Implement NaN and inf handling for elasticsearch output (influxdata#10196)
  feat: add nomad input plugin (influxdata#10106)
  fix: Print loaded plugins and deprecations for once and test (influxdata#10205)
  fix: eliminate MIB dependency for ifname processor (influxdata#10214)
  feat: Optimize locking for SNMP MIBs loading. (influxdata#10206)
  feat: Add SMART plugin concurrency configuration option, nvme-cli v1.14+ support and lint fixes. (influxdata#10150)
  feat: update configs (influxdata#10236)
  fix(inputs/kube_inventory): set TLS server name config properly (influxdata#9975)
  fix: Sudden close of Telegraf caused by OPC UA input plugin (influxdata#10230)
  fix: bump github.com/eclipse/paho.mqtt.golang from 1.3.0 to 1.3.5 (influxdata#9913)
  fix: json_v2 parser timestamp setting (influxdata#10221)
  fix: ensure graylog spec fields not prefixed with '_' (influxdata#10209)
  docs: remove duplicate links in CONTRIBUTING.md (influxdata#10218)
  fix: pool detection and metrics gathering for ZFS >= 2.1.x (influxdata#10099)
  fix: parallelism fix for ifname processor (influxdata#10007)
  chore: Forbids "log" package only for aggregators, inputs, outputs, parsers and processors (influxdata#10191)
  docs: address documentation gap when running telegraf in k8s (influxdata#10215)
  feat: update etc/telegraf.conf and etc/telegraf_windows.conf (influxdata#10211)
  fix: mqtt topic extracting no longer requires all three fields (influxdata#10208)
  fix: windows service - graceful shutdown of telegraf (influxdata#9616)
  feat: update etc/telegraf.conf and etc/telegraf_windows.conf (influxdata#10201)
  feat: Modbus support multiple slaves (gateway feature) (influxdata#9279)
  fix: Revert unintented corruption of the Makefile from influxdata#10200. (influxdata#10203)
  chore: remove triggering update-config bot in CI (influxdata#10195)
  Update changelog
  feat: Implement deprecation infrastructure (influxdata#10200)
  fix: extra lock on init for safety (influxdata#10199)
  fix: resolve influxdata#10027 (influxdata#10112)
  fix: register bigquery to output plugins influxdata#10177 (influxdata#10178)
  fix: sysstat use unique temp file vs hard-coded (influxdata#10165)
  refactor: snmp to use gosmi (influxdata#9518)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fix pr to fix corresponding bug
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants