]> granicus.if.org Git - icinga2/blobdiff - doc/15-troubleshooting.md
Fix spelling errors.
[icinga2] / doc / 15-troubleshooting.md
index 216fbd975a3b56eb5c6bae7308bb8f1df25bc751..01c5921bd14fac889b261b7b4c9aec041c4fc655 100644 (file)
@@ -22,8 +22,8 @@ findings and details please.
        * [Icinga Web 2 modules](https://icinga.com/products/icinga-web-2-modules/) e.g. the Icinga Director (optional)
 * Configuration insights:
        * Provide complete configuration snippets explaining your problem in detail
-       * Your [icinga2.conf](04-configuring-icinga-2.md#icinga2-conf) file
-       * If you run multiple Icinga 2 instances, the [zones.conf](04-configuring-icinga-2.md#zones-conf) file (or `icinga2 object list --type Endpoint` and `icinga2 object list --type Zone`) from all affected nodes.
+       * Your [icinga2.conf](04-configuration.md#icinga2-conf) file
+       * If you run multiple Icinga 2 instances, the [zones.conf](04-configuration.md#zones-conf) file (or `icinga2 object list --type Endpoint` and `icinga2 object list --type Zone`) from all affected nodes.
 * Logs
        * Relevant output from your main and [debug log](15-troubleshooting.md#troubleshooting-enable-debug-output) in `/var/log/icinga2`. Please add step-by-step explanations with timestamps if required.
        * The newest Icinga 2 crash log if relevant, located in `/var/log/icinga2/crash`
@@ -237,7 +237,7 @@ include <itl>
 include <plugins>
 ```
 
-in the [icinga2.conf](04-configuring-icinga-2.md#icinga2-conf) configuration file. These files are not considered
+in the [icinga2.conf](04-configuration.md#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 `/usr/share/icinga2/includes` with the constant `IncludeConfDir`.
 
@@ -248,7 +248,7 @@ or similar.
 
 * Make sure that the line(s) are not [commented out](17-language-reference.md#comments) (starting with `//` or `#`, or
 encapsulated by `/* ... */`).
-* Is the configuration file included in [icinga2.conf](04-configuring-icinga-2.md#icinga2-conf)?
+* Is the configuration file included in [icinga2.conf](04-configuration.md#icinga2-conf)?
 
 Run the [configuration validation](11-cli-commands.md#config-validation) and add `notice` as log severity.
 Search for the file which should be included i.e. using the `grep` CLI command.
@@ -274,7 +274,7 @@ did not properly escape the single dollar sign preventing its usage as [runtime
 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}'.
 ```
 
-Correct the custom attribute value to
+Correct the custom variable value to
 
 ```
 "top-syntax=$${list}"
@@ -393,10 +393,10 @@ $ curl -k -s -u root:icinga -H 'Accept: application/json' -H 'X-HTTP-Method-Over
     "results": [
         {
             "attrs": {
-                "__name": "icinga2-client1.localdomain!disk",
+                "__name": "icinga2-agent1.localdomain!disk",
                 "last_check_result": {
                     "active": true,
-                    "check_source": "icinga2-client1.localdomain",
+                    "check_source": "icinga2-agent1.localdomain",
 
   ...
 
@@ -404,7 +404,7 @@ $ curl -k -s -u root:icinga -H 'Accept: application/json' -H 'X-HTTP-Method-Over
             },
             "joins": {},
             "meta": {},
-            "name": "icinga2-client1.localdomain!disk",
+            "name": "icinga2-agent1.localdomain!disk",
             "type": "Service"
         }
     ]
@@ -415,9 +415,9 @@ Example for using the `icinga2 console` CLI command evaluation functionality:
 
 ```
 $ ICINGA2_API_PASSWORD=icinga icinga2 console --connect 'https://root@localhost:5665/' \
---eval 'get_service("icinga2-client1.localdomain", "disk").last_check_result.check_source' | python -m json.tool
+--eval 'get_service("icinga2-agent1.localdomain", "disk").last_check_result.check_source' | python -m json.tool
 
-"icinga2-client1.localdomain"
+"icinga2-agent1.localdomain"
 ```
 
 
@@ -475,13 +475,13 @@ in mind when using a different package.
 
 This could happen with [clients as command endpoint execution](06-distributed-monitoring.md#distributed-monitoring-top-down-command-endpoint).
 
-If you have for example a client host `icinga2-client1.localdomain`
+If you have for example a client host `icinga2-agent1.localdomain`
 and a service `disk` check defined on the master, the warning and
 critical thresholds are sometimes to applied and unwanted notification
 alerts are raised.
 
 This happens because the client itself includes a host object with
-its `NodeName` and a basic set of checks in the [conf.d](04-configuring-icinga-2.md#conf-d)
+its `NodeName` and a basic set of checks in the [conf.d](04-configuration.md#conf-d)
 directory, i.e. `disk` with the default thresholds.
 
 Clients which have the `checker` feature enabled will attempt
@@ -494,7 +494,7 @@ master you will receive wrong check results from the client.
 Solution:
 
 * Disable the `checker` feature on clients: `icinga2 feature disable checker`.
-* Remove the inclusion of [conf.d](04-configuring-icinga-2.md#conf-d) as suggested in the [client setup docs](06-distributed-monitoring.md#distributed-monitoring-top-down-command-endpoint).
+* Remove the inclusion of [conf.d](04-configuration.md#conf-d) as suggested in the [client setup docs](06-distributed-monitoring.md#distributed-monitoring-top-down-command-endpoint).
 
 ### Check Fork Errors <a id="check-fork-errors"></a>
 
@@ -712,7 +712,7 @@ $ curl -k -s -u root:icinga -H 'Accept: application/json' -X POST 'https://local
 ### Feature is not working <a id="feature-not-working"></a>
 
 * 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](04-configuring-icinga-2.md#icinga2-conf).
+to `features-enabled` and that the latter is included in [icinga2.conf](04-configuration.md#icinga2-conf).
 * Are the feature attributes set correctly according to the documentation?
 * Any errors on the logs?
 
@@ -909,7 +909,7 @@ Certificate:
 Client public certificate:
 
 ```
-# openssl x509 -in icinga2-client1.localdomain.crt -text
+# openssl x509 -in icinga2-agent1.localdomain.crt -text
 
 Certificate:
     Data:
@@ -921,7 +921,7 @@ Certificate:
         Validity
             Not Before: Aug 20 16:20:05 2016 GMT
             Not After : Aug 17 16:20:05 2031 GMT
-        Subject: CN=icinga2-client1.localdomain
+        Subject: CN=icinga2-agent1.localdomain
         Subject Public Key Info:
             Public Key Algorithm: rsaEncryption
                 Public-Key: (4096 bit)
@@ -932,7 +932,7 @@ Certificate:
             X509v3 Basic Constraints: critical
                 CA:FALSE
             X509v3 Subject Alternative Name:
-                DNS:icinga2-client1.localdomain
+                DNS:icinga2-agent1.localdomain
     Signature Algorithm: sha256WithRSAEncryption
 ...
 ```
@@ -944,14 +944,14 @@ both instances are signed by the **same CA**.
 # openssl verify -verbose -CAfile /var/lib/icinga2/certs/ca.crt /var/lib/icinga2/certs/icinga2-master1.localdomain.crt
 icinga2-master1.localdomain.crt: OK
 
-# openssl verify -verbose -CAfile /var/lib/icinga2/certs/ca.crt /var/lib/icinga2/certs/icinga2-client1.localdomain.crt
-icinga2-client1.localdomain.crt: OK
+# openssl verify -verbose -CAfile /var/lib/icinga2/certs/ca.crt /var/lib/icinga2/certs/icinga2-agent1.localdomain.crt
+icinga2-agent1.localdomain.crt: OK
 ```
 
 Fetch the `ca.crt` file from the client node and compare it to your master's `ca.crt` file:
 
 ```
-# scp icinga2-client1:/var/lib/icinga2/certs/ca.crt test-client-ca.crt
+# scp icinga2-agent1:/var/lib/icinga2/certs/ca.crt test-client-ca.crt
 # diff -ur /var/lib/icinga2/certs/ca.crt test-client-ca.crt
 ```
 
@@ -1122,7 +1122,7 @@ works (default port is `5665`).
 
 # netstat -tulpen | grep icinga
 
-# nmap icinga2-client1.localdomain
+# nmap icinga2-agent1.localdomain
 ```
 
 ### Cluster Troubleshooting SSL Errors <a id="troubleshooting-cluster-ssl-errors"></a>
@@ -1136,10 +1136,10 @@ the following
   * Verify the `Subject` containing your endpoint's common name (CN)
   * Check the validity of the certificate itself
 
-Try to manually connect from `icinga2-client1.localdomain` to the master node `icinga2-master1.localdomain`:
+Try to manually connect from `icinga2-agent1.localdomain` to the master node `icinga2-master1.localdomain`:
 
 ```
-# openssl s_client -CAfile /var/lib/icinga2/certs/ca.crt -cert /var/lib/icinga2/certs/icinga2-client1.localdomain.crt -key /var/lib/icinga2/certs/icinga2-client1.localdomain.key -connect icinga2-master1.localdomain:5665
+# openssl s_client -CAfile /var/lib/icinga2/certs/ca.crt -cert /var/lib/icinga2/certs/icinga2-agent1.localdomain.crt -key /var/lib/icinga2/certs/icinga2-agent1.localdomain.key -connect icinga2-master1.localdomain:5665
 
 CONNECTED(00000003)
 ---
@@ -1156,7 +1156,7 @@ Unauthenticated nodes are able to connect. This is required for client setups.
 Master:
 
 ```
-[2015-07-13 18:29:25 +0200] information/ApiListener: New client connection for identity 'icinga2-client1.localdomain' (unauthenticated)
+[2015-07-13 18:29:25 +0200] information/ApiListener: New client connection for identity 'icinga2-agent1.localdomain' (unauthenticated)
 ```
 
 Client as command execution bridge:
@@ -1236,7 +1236,7 @@ certificate's CN, the master will deny all events.
 
 > **Tip**
 >
-> [Icinga Web 2](02-getting-started.md#setting-up-icingaweb2) provides a dashboard view
+> [Icinga Web 2](02-installation.md#setting-up-icingaweb2) provides a dashboard view
 > for overdue check results.
 
 Enable the [debug log](15-troubleshooting.md#troubleshooting-enable-debug-output) on the master
@@ -1247,14 +1247,14 @@ If the client cannot authenticate, it's a more general [problem](15-troubleshoot
 The client's endpoint is not configured on nor trusted by the master node:
 
 ```
-Discarding 'check result' message from 'icinga2-client1.localdomain': Invalid endpoint origin (client not allowed).
+Discarding 'check result' message from 'icinga2-agent1.localdomain': 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 'icinga2-client1.localdomain': Unauthorized access.
+Discarding 'check result' message from 'icinga2-agent1.localdomain': Unauthorized access.
 ```
 
 
@@ -1281,7 +1281,7 @@ Icinga 2 requires the `NodeName` [constant](17-language-reference.md#constants)
 This includes loading the TLS certificates, setting the proper check source,
 and so on.
 
-Typically the Windows setup wizard and also the CLI commands populate the [constants.conf](04-configuring-icinga-2.md#constants-conf)
+Typically the Windows setup wizard and also the CLI commands populate the [constants.conf](04-configuration.md#constants-conf)
 file with the auto-detected or user-provided FQDN/Common Name.
 
 If this constant is not set during startup, Icinga will try to resolve the
@@ -1297,7 +1297,7 @@ the `NodeName` constant with the FQDN. Ensure this is the same value
 as the local endpoint object name.
 
 ```
-const NodeName = "windows-client1.domain.com"
+const NodeName = "windows-agent1.domain.com"
 ```