Docs: Add troubleshooting examples for fetching the executed command line

fixes #13455

diff --git a/doc/12-icinga2-api.md b/doc/12-icinga2-api.md
index a1b21226e8f04b8c93d0d4fe9ed089e56d4fd322..5d73d9339a11e7dcb10344a4f3c3096a1be44fd1 100644 (file)
--- a/doc/12-icinga2-api.md
+++ b/doc/12-icinga2-api.md
@@ -403,9 +403,9 @@ In addition to these parameters a [filter](12-icinga2-api.md#icinga2-api-filters
 
 Instead of using a filter you can optionally specify the object name in the
 URL path when querying a single object. For objects with composite names
-(e.g. services) the full name (e.g. `localhost!http`) must be specified:
+(e.g. services) the full name (e.g. `example.localdomain!http`) must be specified:
 
-    $ curl -k -s -u root:icinga 'https://localhost:5665/v1/objects/services/localhost!http'
+    $ curl -k -s -u root:icinga 'https://localhost:5665/v1/objects/services/example.localdomain!http'
 
 You can limit the output to specific attributes using the `attrs` URL parameter:
 
@@ -561,7 +561,7 @@ parameters need to be passed inside the JSON body:
   attrs      | dictionary   | **Required.** Set specific object attributes for this [object type](9-object-types.md#object-types).
 
 The object name must be specified as part of the URL path. For objects with composite names (e.g. services)
-the full name (e.g. `localhost!http`) must be specified.
+the full name (e.g. `example.localdomain!http`) must be specified.
 
 If attributes are of the Dictionary type, you can also use the indexer format. This might be necessary to only override specific custom variables and keep all other existing custom variables (e.g. from templates):
 
@@ -602,7 +602,7 @@ which is required for host objects:
 
 Service objects must be created using their full name ("hostname!servicename") referencing an existing host object:
 
-    $ curl -k -s -u root:icinga -H 'Accept: application/json' -X PUT 'https://localhost:5665/v1/objects/services/localhost!realtime-load' \
+    $ curl -k -s -u root:icinga -H 'Accept: application/json' -X PUT 'https://localhost:5665/v1/objects/services/example.localdomain!realtime-load' \
     -d '{ "templates": [ "generic-service" ], "attrs": { "check_command": "load", "check_interval": 1,"retry_interval": 1 } }'
 
 
@@ -815,7 +815,7 @@ allowed for the service (`force_check=true`).
         "results": [
             {
                 "code": 200.0,
-                "status": "Successfully rescheduled check for object 'localhost!ping6'."
+                "status": "Successfully rescheduled check for object 'example.localdomain!ping6'."
             }
         ]
     }

diff --git a/doc/15-troubleshooting.md b/doc/15-troubleshooting.md
index b2e90d5d83f16017c1afa6347d65e9c5cabb52da..6d7c3efcbd40335ebae7fc7f978fa53c91a04d1c 100644 (file)
--- a/doc/15-troubleshooting.md
+++ b/doc/15-troubleshooting.md
@@ -123,6 +123,57 @@ for their check result containing the executed shell command.
 to fetch the checkable object, its check result and the executed shell command.
 * Alternatively enable the [debug log](15-troubleshooting.md#troubleshooting-enable-debug-output) and look for the executed command.
 
+Example for a service object query using a [regex match]() on the name:
+
+    $ curl -k -s -u root:icinga -H 'Accept: application/json' -H 'X-HTTP-Method-Override: GET' -X POST 'https://localhost:5665/v1/objects/services' \
+    -d '{ "filter": "regex(pattern, service.name)", "filter_vars": { "pattern": "^http" }, "attrs": [ "__name", "last_check_result" ] }' | python -m json.tool
+    {
+        "results": [
+            {
+                "attrs": {
+                    "__name": "example.localdomain!http",
+                    "last_check_result": {
+                        "active": true,
+                        "check_source": "example.localdomain",
+                        "command": [
+                            "/usr/local/sbin/check_http",
+                            "-I",
+                            "127.0.0.1",
+                            "-u",
+                            "/"
+                        ],
+
+      ...
+
+                    }
+                },
+                "joins": {},
+                "meta": {},
+                "name": "example.localdomain!http",
+                "type": "Service"
+            }
+        ]
+    }
+
+Example for using the `icinga2 console` CLI command evaluation functionality:
+
+    $ ICINGA2_API_PASSWORD=icinga icinga2 console --connect 'https://root@localhost:5665/' \
+    --eval 'get_service("example.localdomain", "http").last_check_result.command' | python -m json.tool
+    [
+        "/usr/local/sbin/check_http",
+        "-I",
+        "127.0.0.1",
+        "-u",
+        "/"
+    ]
+
+Example for searching the debug log:
+
+    # icinga2 feature enable debuglog
+    # systemctl restart icinga2
+    # tail -f /var/log/icinga2/debug.log | grep "notice/Process"
+
+
 ### <a id="checks-not-executed"></a> Checks are not executed
 
 * Check the [debug log](15-troubleshooting.md#troubleshooting-enable-debug-output) to see if the check command gets executed.