Heartbeat reference documentation has extra syntax

Elastic Stack Beats
1

Hearbeat version:
8.12.2
Original install method (e.g. download page, yum, from source, etc.):
MSI
Describe the bug:
The Heartbeat reference file, heartbeat.reference.yml, and the documentation site has an extra dash, -, in the check.response section next to # expression: 'myField == "expectedValue"'. This causes a fairly non-descriptive error to be thrown, Exiting: could not create monitor: could not parse cfg for datastream error unpacking monitor plugin config: string value is not set accessing 'heartbeat.monitors.4.type' .
Steps to reproduce:

  1. Copy and past the entire check.response section from the heartbeat.reference.yml to the heartbeat.yml.
  2. .\heartbeat.exe run -e

Expected behavior:
For Heartbeat to start.
Provide logs and/or server output (if relevant):
Exiting: could not create monitor: could not parse cfg for datastream error unpacking monitor plugin config: string value is not set accessing 'heartbeat.monitors.4.type'"
Any additional context:
Update the documentation to remove the extra dash - on line 229: expression: 'myField == "expectedValue"'

2

Solved: Remove the dash - on line 229 of the documentation.

Also, if you hit a similar error to, Exiting: could not create monitor: could not parse cfg for datastream error unpacking monitor plugin config: string value is not set accessing 'heartbeat.monitors.4.type', look for a syntax error somewhere in the yaml file.

The actual error number may be different than above as I've seen it show up as heartbeat.monitors.1.type, heartbeat.monitors.2.type or heartbeat.monitors.3.type and I'm assuming it could be virtually any number.

3

Hi @Ryan_Downey,

Thanks for the heads up! The issue has been addressed here. I apologize for any inconvenience it might have caused.

1 Like