How to escape white spaces in variable perfdatagraphs_config_highlight

[KornesWerkman]

icingaweb2-module-perfdatagraphs/doc/03-Configuration.md

Line 63 in 23b940d

| perfdatagraphs_config_highlight (string) | Set the specified metric to the first graph to show in the web UI |

These perfdatagraphs are awesome!

When I try to promote a metric to the top of the list of graphs, this does not work if there's a white space in the metric. Is there a way to set this up:

Error message :
`
[2026-01-09 14:07:55 +0800] critical/config: Error: syntax error, unexpected invalid token

/etc/icinga2/conf.d/vtmis/service-tfp.conf(62): vars.perfdatagraphs_config_highlight = "track\ in\ count"

                                                                                             ^^

`

As visible in the screenshot, the metric did not promote to the top

[martialblog]

Hi, thanks for the feedback.

I don't think you have to escape the whitespaces in the Icinga2 DSL since you are using quotes already.

If the perfdatagraphs_config_highlight option doesn't work with whitespaces then that might be a bug. I'll try to recreate that and test it myself.

[KornesWerkman]

I used the latest releases:

[martialblog]

@KornesWerkman Hi,

I tried to recreate this. This worked for me:

# Just an example check
./check_demo.sh 
OK | 'cpu status'=75%;80;90;0;100 'mem status'=60%;70;85;0;100

The Icinga2 configuration:

object CheckCommand "checkdemo" {
    command = [ PluginDir + "/check_demo.sh" ]
}

apply Service "Perfdata Demo" {
    check_command = "checkdemo"
    assign where host.name == "Example"
    vars.perfdatagraphs_config_highlight = "mem status"
}

[KornesWerkman]

My config :

apply Service          "TFP Eval for " for ( config in host.vars.tfp_sensors ) {
    import             "generic-service"
    import             "service-down-when-oid-not-found"

    check_command      = "snmpv3"
    vars.snmpv3_label  = "Track Fusion Process (TFP) Sensor"
    vars.snmpv3_oid    = "tfpSensorName." + SystemSensors[config]

    vars.snmpv3_label += ",status"
    vars.snmpv3_oid   += ",tfpSensorStatus." + SystemSensors[config]

    vars.snmpv3_label += ",track in count"
    vars.snmpv3_oid   += ",tfpSensorTrackInCount." + SystemSensors[config]

    vars.snmpv3_label += ",sector in count"
    vars.snmpv3_oid   += ",tfpSensorSectorInCount." + SystemSensors[config]

    vars.snmpv3_label += ",revolution time"
    vars.snmpv3_oid   += ",tfpSensorRevolutionTime." + SystemSensors[config]

    vars.snmpv3_label += ",range error"
    vars.snmpv3_oid   += ",tfpSensorSystematicErrorRange." + SystemSensors[config]

    vars.snmpv3_label += ",azimuth error"
    vars.snmpv3_oid   += ",tfpSensorSystematicErrorAzimuth." + SystemSensors[config]

    vars.snmpv3_label += ",status control"
    vars.snmpv3_oid   += ",tfpSensorStatusControl." + SystemSensors[config]

    vars.snmpv3_label += ",tracks used"
    vars.snmpv3_oid   += ",tfpSensorTrackUsedCount." + SystemSensors[config]

    vars.perfdatagraphs_config_highlight = "track in count"

    assign where host.vars.tfp_sensors
}

And the graphs start with the "azimuth error", alphabetically the first

[martialblog]

Hi, could you give me an example of the plugin output? In particular how the perfdata looks so that I can recreate this.

Thanks

[KornesWerkman]

Sure here it is, I ran it a few times

`# for _ in 1 2 3 4 5 6 7 8 9 0
do
/usr/lib/nagios/plugins/check_snmp '-A' '####' '-H' '10.1.15.52' '-L' 'authPriv' '-P' '3' '-U' '#####' '-X' '####' '-a' 'SHA' '-l' 'Target Tracker (TARGHITT) Sensor,status,plot in count,filtering level,position offset X,position offset Y,range gain,range bias,azimuth bias,time bias' '-m' 'ALL' '-o' 'targhittSensorName.71,targhittSensorStatus.71,targhittSensorPlotInCount.71,targhittSensorPlotFilteringLevel.71,targhittSensorPositionOffsetX.71,targhittSensorPositionOffsetY.71,targhittSensorRangeGain.71,targhittSensorRangeBias.71,targhittSensorAzimuthBias.71,targhittSensorTimeBias.71' '-t' '10' '-x' 'AES'
sleep 60
done

SNMP OK - Target Tracker (TARGHITT) Sensor AIS status online(2) plot in count 29 filtering level none(1) position offset X 0 position offset Y 0 range gain 0 range bias 0 azimuth bias 0 time bias 0 | 'plot in count'=29 'position offset X'=0 'position offset Y'=0 'range gain'=0 'range bias'=0 'azimuth bias'=0 'time bias'=0

SNMP OK - Target Tracker (TARGHITT) Sensor AIS status online(2) plot in count 32 filtering level none(1) position offset X 0 position offset Y 0 range gain 0 range bias 0 azimuth bias 0 time bias 0 | 'plot in count'=32 'position offset X'=0 'position offset Y'=0 'range gain'=0 'range bias'=0 'azimuth bias'=0 'time bias'=0

SNMP OK - Target Tracker (TARGHITT) Sensor AIS status online(2) plot in count 29 filtering level none(1) position offset X 0 position offset Y 0 range gain 0 range bias 0 azimuth bias 0 time bias 0 | 'plot in count'=29 'position offset X'=0 'position offset Y'=0 'range gain'=0 'range bias'=0 'azimuth bias'=0 'time bias'=0

SNMP OK - Target Tracker (TARGHITT) Sensor AIS status online(2) plot in count 34 filtering level none(1) position offset X 0 position offset Y 0 range gain 0 range bias 0 azimuth bias 0 time bias 0 | 'plot in count'=34 'position offset X'=0 'position offset Y'=0 'range gain'=0 'range bias'=0 'azimuth bias'=0 'time bias'=0

SNMP OK - Target Tracker (TARGHITT) Sensor AIS status online(2) plot in count 31 filtering level none(1) position offset X 0 position offset Y 0 range gain 0 range bias 0 azimuth bias 0 time bias 0 | 'plot in count'=31 'position offset X'=0 'position offset Y'=0 'range gain'=0 'range bias'=0 'azimuth bias'=0 'time bias'=0

SNMP OK - Target Tracker (TARGHITT) Sensor AIS status online(2) plot in count 31 filtering level none(1) position offset X 0 position offset Y 0 range gain 0 range bias 0 azimuth bias 0 time bias 0 | 'plot in count'=31 'position offset X'=0 'position offset Y'=0 'range gain'=0 'range bias'=0 'azimuth bias'=0 'time bias'=0

SNMP OK - Target Tracker (TARGHITT) Sensor AIS status online(2) plot in count 32 filtering level none(1) position offset X 0 position offset Y 0 range gain 0 range bias 0 azimuth bias 0 time bias 0 | 'plot in count'=32 'position offset X'=0 'position offset Y'=0 'range gain'=0 'range bias'=0 'azimuth bias'=0 'time bias'=0

SNMP OK - Target Tracker (TARGHITT) Sensor AIS status online(2) plot in count 33 filtering level none(1) position offset X 0 position offset Y 0 range gain 0 range bias 0 azimuth bias 0 time bias 0 | 'plot in count'=33 'position offset X'=0 'position offset Y'=0 'range gain'=0 'range bias'=0 'azimuth bias'=0 'time bias'=0

SNMP OK - Target Tracker (TARGHITT) Sensor AIS status online(2) plot in count 33 filtering level none(1) position offset X 0 position offset Y 0 range gain 0 range bias 0 azimuth bias 0 time bias 0 | 'plot in count'=33 'position offset X'=0 'position offset Y'=0 'range gain'=0 'range bias'=0 'azimuth bias'=0 'time bias'=0

SNMP OK - Target Tracker (TARGHITT) Sensor AIS status online(2) plot in count 35 filtering level none(1) position offset X 0 position offset Y 0 range gain 0 range bias 0 azimuth bias 0 time bias 0 | 'plot in count'=35 'position offset X'=0 'position offset Y'=0 'range gain'=0 'range bias'=0 'azimuth bias'=0 'time bias'=0`

[martialblog]

Thanks. I'll investigate this

[martialblog]

Hi, so I did some testing with InfluxDB 1.12.

cat /usr/lib/nagios/plugins/check_demo
#!/bin/bash

plot_in_count=$((RANDOM % 100))
time_bias=$((RANDOM % 10 - 5))

echo "SNMP OK - Target Tracker (TARGHITT) Sensor AIS status online(2) plot in count $plot_in_count | 'plot in count'=$plot_in_count 'time\\ bias'=$time_bias"

object CheckCommand "demo" {
  command = [ PluginDir + "/check_demo" ]
}

apply Service "demo" {
  import "generic-service"

  check_command = "demo"

  assign where host.name == NodeName

  vars.perfdatagraphs_config_highlight = "time\\ bias"
}

All seems to be working as expected:

I'm still a bit confused about where the backslash is coming from. Because given the output you provided, Icinga2 and InfluxDB1 did not produce/show it in my instance:

| 'plot in count'=29 'position offset X'=0 'position offset Y'=0 'range gain'=0 'range bias'=0 'azimuth bias'=0 'time bias'=0

Only when I forced it in the check plugin's output like so: 'time\\ bias'=0". But even so the custom var vars.perfdatagraphs_config_highlight = "time\\ bias" worked as intended.

In you first screenshots there a backslash in the graphs and no backslash in the perfdatalist. In my tests both are the same:

Are there any customizations or settings you have that I'm missing?