Gather agent host metrics and forward them to an OpenTelemetry agent. It uses node_exporter to gather host metrics and otel-contrib to forward them to an OpenTelemetry agent. Node_exporter listens on a tcp port and returns the metrics when queried. Otel-contrib queries the metrics and forwards them to an OpenTelemetry agent.

onMonit depends on the OpenTelemetry plugin being configured and the Export OpenTelemetry configuration as environment variables option being checked. This determines to which OpenTelemetry endpoint the agent metrics are being sent to.

• Node_exporter listen on port (optional, default: 9100): Node exporter will try to listen on this port to expose the host metrics. If another process is already listening, then we try port after port incrementally (so first 9100, 9101, 9102, …) until binding to a port succeeds.
• Log output (optional, default: false): A boolean flag. When true, any process output from node_exporter and otel-contrib is forwarded to the Job console logs. Useful for troubleshooting node_exporter + otel-contrib.
• Node_exporter additional options (optional): Any additional options to pass to the node_exporter process execution. This can be used to enable/disable specific collectors. See the node_exporter --help for more information.
• Otel-contrib additional options (optional): Any additional options to pass to the otel-contrib process execution. This can be used to enable feature-flag gates or override specific values of the configuration. See the otel-contrib --help for more information.

Examples:
The whole pipeline can be monitored using node_exporter + otel-contrib agents by using onMonit as a pipeline option:

pipeline {
    options {
        onMonit()
    }
}
        

    stage {
        agent { label "other-node" }
        options {
            onMonit()
        }
    }
        

    stage {
        steps {
            onMonit() {
                echo "Monitored 🙂"
            }
        }
    }