Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

monitoring_parameter

Add a monitoring parameter to a node (requires a monitoring plugin).

⚙️ Compatible targets: Linux

Parameters

NameDocumentation
keyName of the parameter.

This parameter is required.
valueValue of the parameter.

This parameter is required.

Outcome conditions

You need to replace ${key} with its actual canonified value.

  • ✅ Ok: monitoring_parameter_${key}_ok
    • ☑️ Already compliant: monitoring_parameter_${key}_kept
    • 🟨 Repaired: monitoring_parameter_${key}_repaired
  • ❌ Error: monitoring_parameter_${key}_error

Example

method: monitoring_parameter
params:
  key: VALUE
  value: VALUE

Documentation

This method adds monitoring parameters to rudder nodes. The monitoring parameters are used to pass configuration to the monitoring plugins running with Rudder. Expected keys and parameters are specific to each plugin and can be found in their respective documentation.