icinga2/doc/16-troubleshooting.md

Icinga 2 Troubleshooting

Which information is required

• Run icinga2 troubleshoot to collect required troubleshooting information
• Alternative, manual steps:
  • icinga2 --version
  • icinga2 feature list
  • icinga2 daemon --validate
  • Relevant output from your main and debug log ( icinga2 object list --type='filelogger' )
  • The newest Icinga 2 crash log, if relevant
  • Your icinga2.conf and, if you run multiple Icinga 2 instances, your zones.conf
• How was Icinga 2 installed (and which repository in case) and which distribution are you using
• Provide complete configuration snippets explaining your problem in detail
• If the check command failed - what's the output of your manual plugin tests?
• In case of debugging Icinga 2, the full back traces and outputs

Enable Debug Output

Enable the debuglog feature:

# icinga2 feature enable debuglog
# service icinga2 restart

You can find the debug log file in /var/log/icinga2/debug.log.

Alternatively you may run Icinga 2 in the foreground with debugging enabled. Specify the console log severity as an additional parameter argument to -x.

# /usr/sbin/icinga2 daemon -x notice

The log level can be one of critical, warning, information, notice and debug.

List Configuration Objects

The icinga2 object list CLI command can be used to list all configuration objects and their attributes. The tool also shows where each of the attributes was modified.

That way you can also identify which objects have been created from your apply rules.

# icinga2 object list

Object 'localhost!ssh' of type 'Service':
  * __name = 'localhost!ssh'
  * check_command = 'ssh'
    % = modified in '/etc/icinga2/conf.d/hosts/localhost/ssh.conf', lines 5:3-5:23
  * check_interval = 60
    % = modified in '/etc/icinga2/conf.d/templates.conf', lines 24:3-24:21
  * host_name = 'localhost'
    % = modified in '/etc/icinga2/conf.d/hosts/localhost/ssh.conf', lines 4:3-4:25
  * max_check_attempts = 3
    % = modified in '/etc/icinga2/conf.d/templates.conf', lines 23:3-23:24
  * name = 'ssh'
  * retry_interval = 30
    % = modified in '/etc/icinga2/conf.d/templates.conf', lines 25:3-25:22
  * templates = [ 'ssh', 'generic-service' ]
    % += modified in '/etc/icinga2/conf.d/hosts/localhost/ssh.conf', lines 1:0-7:1
    % += modified in '/etc/icinga2/conf.d/templates.conf', lines 22:1-26:1
  * type = 'Service'
  * vars
    % += modified in '/etc/icinga2/conf.d/hosts/localhost/ssh.conf', lines 6:3-6:19
    * sla = '24x7'
      % = modified in '/etc/icinga2/conf.d/hosts/localhost/ssh.conf', lines 6:3-6:19

[...]

You can also filter by name and type:

# icinga2 object list --name *ssh* --type Service
Object 'localhost!ssh' of type 'Service':
  * __name = 'localhost!ssh'
  * check_command = 'ssh'
    % = modified in '/etc/icinga2/conf.d/hosts/localhost/ssh.conf', lines 5:3-5:23
  * check_interval = 60
    % = modified in '/etc/icinga2/conf.d/templates.conf', lines 24:3-24:21
  * host_name = 'localhost'
    % = modified in '/etc/icinga2/conf.d/hosts/localhost/ssh.conf', lines 4:3-4:25
  * max_check_attempts = 3
    % = modified in '/etc/icinga2/conf.d/templates.conf', lines 23:3-23:24
  * name = 'ssh'
  * retry_interval = 30
    % = modified in '/etc/icinga2/conf.d/templates.conf', lines 25:3-25:22
  * templates = [ 'ssh', 'generic-service' ]
    % += modified in '/etc/icinga2/conf.d/hosts/localhost/ssh.conf', lines 1:0-7:1
    % += modified in '/etc/icinga2/conf.d/templates.conf', lines 22:1-26:1
  * type = 'Service'
  * vars
    % += modified in '/etc/icinga2/conf.d/hosts/localhost/ssh.conf', lines 6:3-6:19
    * sla = '24x7'
      % = modified in '/etc/icinga2/conf.d/hosts/localhost/ssh.conf', lines 6:3-6:19

Found 1 Service objects.

[2014-10-15 14:27:19 +0200] information/cli: Parsed 175 objects.

Where are the check command definitions?

Icinga 2 features a number of built-in check command definitions which are included using

include <itl>
include <plugins>

in the icinga2.conf configuration file. These files are not considered configuration files and will be overridden on upgrade, so please send modifications as proposed patches upstream. The default include path is set to LocalStateDir + "/share/icinga2/includes".

You should add your own command definitions to a new file in conf.d/ called commands.conf or similar.

Checks are not executed

• Check the debug log to see if the check command gets executed
• Verify that failed depedencies do not prevent command execution
• Make sure that the plugin is executable by the Icinga 2 user (run a manual test)
• Make sure the checker feature is enabled.

Examples:

# sudo -u icinga /usr/lib/nagios/plugins/check_ping -4 -H 127.0.0.1 -c 5000,100% -w 3000,80%

# icinga2 feature enable checker
The feature 'checker' is already enabled.

Notifications are not sent

• Check the debug log to see if a notification is triggered
• If yes, verify that all conditions are satisfied
• Are any errors on the notification command execution logged?

Verify the following configuration

• Is the host/service enable_notifications attribute set, and if, to which value?
• Do the notification attributes states, types, period match the notification conditions?
• Do the user attributes states, types, period match the notification conditions?
• Are there any notification begin and end times configured?
• Make sure the notification feature is enabled.
• Does the referenced NotificationCommand work when executed as Icinga user on the shell?

If notifications are to be sent via mail make sure that the mail program specified exists. The name and location depends on the distribution so the preconfigured setting might have to be changed on your system.

Examples:

# icinga2 feature enable notification
The feature 'notification' is already enabled.

Feature is not working

• Make sure that the feature configuration is enabled by symlinking from features-available/ to features-enabled and that the latter is included in icinga2.conf.
• Are the feature attributes set correctly according to the documentation?
• Any errors on the logs?

Configuration is ignored

• Make sure that the line(s) are not commented out (starting with // or #, or encapsulated by /* ... */).
• Is the configuration file included in icinga2.conf?

Configuration attributes are inherited from

Icinga 2 allows you to import templates using the import keyword. If these templates contain additional attributes, your objects will automatically inherit them. You can override or modify these attributes in the current object.

Configuration Value with Single Dollar Sign

In case your configuration validation fails with a missing closing dollar sign error message, you did not properly escape the single dollar sign preventing its usage as runtime macro.

critical/config: Error: Validation failed for Object 'ping4' (Type: 'Service') at /etc/icinga2/zones.d/global-templates/windows.conf:24: Closing $ not found in macro format string 'top-syntax=${list}'.

Cluster Troubleshooting

This applies to anything using the cluster protocol:

• Distributed and High-Availability scenarios
• Remote client scenarios

You should configure the cluster health checks if you haven't done so already.

Note

Some problems just exist due to wrong file permissions or packet filters applied. Make sure to check these in the first place.

Cluster Troubleshooting Connection Errors

General connection errors normally lead you to one of the following problems:

• Wrong network configuration
• Packet loss on the connection
• Firewall rules preventing traffic

Use tools like netstat, tcpdump, nmap, etc to make sure that the cluster communication happens (default port is 5665).

# tcpdump -n port 5665 -i any

# netstat -tulpen | grep icinga

# nmap yourclusternode.localdomain

Cluster Troubleshooting SSL Errors

If the cluster communication fails with SSL error messages, make sure to check the following

• File permissions on the SSL certificate files
• Does the used CA match for all cluster endpoints?
  • Verify the Issuer being your trusted CA
  • Verify the Subject containing your endpoint's common name (CN)
  • Check the validity of the certificate itself

Steps on the client icinga2-node2.localdomain:

# ls -la /etc/icinga2/pki

# cd /etc/icinga2/pki/
# openssl x509 -in icinga2-node2.localdomain.crt -text
Certificate:
    Data:
        Version: 1 (0x0)
        Serial Number: 2 (0x2)
    Signature Algorithm: sha1WithRSAEncryption
        Issuer: C=DE, ST=Bavaria, L=Nuremberg, O=NETWAYS GmbH, OU=Monitoring, CN=Icinga CA
        Validity
            Not Before: Jan  7 13:17:38 2014 GMT
            Not After : Jan  5 13:17:38 2024 GMT
        Subject: C=DE, ST=Bavaria, L=Nuremberg, O=NETWAYS GmbH, OU=Monitoring, CN=icinga2-node2.localdomain
        Subject Public Key Info:
            Public Key Algorithm: rsaEncryption
                Public-Key: (4096 bit)
                Modulus:
                ...

Try to manually connect from icinga2-node2.localdomain to the master node icinga2-node1.localdomain:

# openssl s_client -CAfile /etc/icinga2/pki/ca.crt -cert /etc/icinga2/pki/icinga2-node2.localdomain.crt -key /etc/icinga2/pki/icinga2-node2.localdomain..key -connect icinga2-node1.localdomain.crt:5665

CONNECTED(00000003)
---
...

If the connection attempt fails or your CA does not match, verify the master and client certificates.

Cluster Troubleshooting Unauthenticated Clients

Unauthenticated nodes are able to connect required by the CSR auto-signing functionality.

Master:

[2015-07-13 18:29:25 +0200] information/ApiListener: New client connection for identity 'icinga-client' (unauthenticated)

Client as command execution bridge:

[2015-07-13 18:29:26 +1000] notice/ApiEvents: Discarding 'execute command' message from 'icinga-master': Invalid endpoint origin (client not allowed).

If these messages do not go away, make sure to verify the master and client certificates.

Cluster Troubleshooting SSL Certificate Verification

Make sure to verify the client's certificate and its received ca.crt in /etc/icinga2/pki and ensure that both instances are signed by the same CA.

# openssl verify -verbose -CAfile /etc/icinga2/pki/ca.crt /etc/icinga2/pki/icinga2-node1.localdomain.crt
icinga2-node1.localdomain.crt: OK

# openssl verify -verbose -CAfile /etc/icinga2/pki/ca.crt /etc/icinga2/pki/icinga2-node2.localdomain.crt
icinga2-node2.localdomain.crt: OK

Fetch the ca.crt file from the client node and compare it to your master's ca.crt file:

# scp icinga2-node2:/etc/icinga2/pki/ca.crt test-client-ca.crt
# diff -ur /etc/icinga2/pki/ca.crt test-client-ca.crt

On SLES11 you'll need to use the openssl1 command instead of openssl.

Cluster Troubleshooting Message Errors

At some point, when the network connection is broken or gone, the Icinga 2 instances will be disconnected. If the connection can't be re-established between zones and endpoints, they remain in a Split-Brain-mode and history may differ.

Although the Icinga 2 cluster protocol stores historical events in a replay log for later synchronisation, you should make sure to check why the network connection failed.

Cluster Troubleshooting Command Endpoint Errors

Command endpoints can be used for clients acting as remote command execution bridge as well as inside an High-Availability cluster.

There is no cli command for manually executing the check, but you can verify the following (e.g. by invoking a forced check from the web interface):

• /var/log/icinga2/icinga2.log contains connection and execution errors.
• The ApiListener is not enabled to accept commands.
• CheckCommand definition not found on the remote client.
• Referenced check plugin not found on the remote client.
• Runtime warnings and errors, e.g. unresolved runtime macros or configuration problems.
• Specific error messages are also populated into UNKNOWN check results including a detailed error message in their output.
• More verbose logs are found inside the debug log.

Cluster Troubleshooting Config Sync

If the cluster zones do not sync their configuration, make sure to check the following:

• Within a config master zone, only one configuration master is allowed to have its config in /etc/icinga2/zones.d. ** The master syncs the configuration to /var/lib/icinga2/api/zones/ during startup and only syncs valid configuration to the other nodes. ** The other nodes receive the configuration into /var/lib/icinga2/api/zones/.
• The icinga2.log log file in /var/log/icinga2 will indicate whether this ApiListener accepts config, or not.

Cluster Troubleshooting Overdue Check Results

If your master does not receive check results (or any other events) from the child zones (satellite, clients, etc) make sure to check whether the client sending in events is allowed to do so.

The cluster naming convention applies so if there's a mismatch between your client node's endpoint name and its provided certificate's CN, the master will deny all events.

Tip

Icinga Web 2 provides a dashboard view for overdue check results.

Enable the debug log on the master for more verbose insights.

If the client cannot authenticate, it's a more general problem.

The client's endpoint is not configured on nor trusted by the master node:

Discarding 'check result' message from 'icinga2b': Invalid endpoint origin (client not allowed).

The check result message sent by the client does not belong to the zone the checkable object is in on the master:

Discarding 'check result' message from 'icinga2b': Unauthorized access.

Cluster Troubleshooting Replay Log

If your /var/lib/icinga2/api/log directory grows, it generally means that your cluster cannot replay the log on connection loss and re-establishment. A master node for example will store all events for not connected endpoints in the same and child zones.

Check the following:

• All clients are connected? (e.g. cluster health check).
• Check your connection in general.
• Does the log replay work, e.g. are all events processed and the directory gets cleared up over time?
• Decrease the log_duration attribute value for that specific endpoint.