From b4d592dc16bc4a77052c50f318d04158a167fa81 Mon Sep 17 00:00:00 2001 From: Michael Friedrich Date: Wed, 21 Oct 2015 22:49:21 +0200 Subject: [PATCH] Documentation: Fix missing dollar sign escaping, add troubleshooting hint This is a pretty common error for years and deserves a troubleshooting entry. fixes #10403 --- doc/17-troubleshooting.md | 8 ++++++++ doc/3-monitoring-basics.md | 5 +++++ 2 files changed, 13 insertions(+) diff --git a/doc/17-troubleshooting.md b/doc/17-troubleshooting.md index 119ae9d05..879be1a5b 100644 --- a/doc/17-troubleshooting.md +++ b/doc/17-troubleshooting.md @@ -167,6 +167,14 @@ Icinga 2 allows you to import templates using the [import](20-language-reference 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](3-monitoring-basics.md#runtime-macros). + + 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: diff --git a/doc/3-monitoring-basics.md b/doc/3-monitoring-basics.md index e9ee70432..371aff7fc 100644 --- a/doc/3-monitoring-basics.md +++ b/doc/3-monitoring-basics.md @@ -262,6 +262,11 @@ We can also directly refer to custom attributes, e.g. by using `$ping_wrta$`. Ic automatically tries to find the closest match for the attribute you specified. The exact rules for this are explained in the next section. +> **Note** +> +> When using the `$` sign as single character you must escape it with an +> additional dollar character (`$$`). + ### Evaluation Order