Documentation: Fix missing dollar sign escaping, add troubleshooting hint

This is a pretty common error for years and deserves
a troubleshooting entry.

fixes #10403
This commit is contained in:
Michael Friedrich 2015-10-21 22:49:21 +02:00
parent 09b1f93e1e
commit b4d592dc16
2 changed files with 13 additions and 0 deletions

View File

@ -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.
## <a id="configuration-value-dollar-sign"></a> 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}'.
## <a id="troubleshooting-cluster"></a> Cluster Troubleshooting
This applies to anything using the cluster protocol:

View File

@ -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 (`$$`).
### <a id="macro-evaluation-order"></a> Evaluation Order