summaryrefslogtreecommitdiffstats
path: root/docs/configuration-guide.md
diff options
context:
space:
mode:
authorthiagoftsm <thiagoftsm@gmail.com>2020-01-16 14:31:01 +0000
committerGitHub <noreply@github.com>2020-01-16 14:31:01 +0000
commit1db77eb15e802ffb111300a1a20c0fcdfa26d6e7 (patch)
treecf681b395eef9dd796973181572e2db59bdd76fe /docs/configuration-guide.md
parent81251da72c50c0b9efe9efced75452069c4834cb (diff)
Restrict quotes in label values (#7594)
* quotes_labels: Restrict quotes This commit brings the restriction for the values that will not be allowed to have quotes * quotes_labels: Documentation This commit brings update to the documentation * quotes_labels: Missing comma This commit brings a missing comma for the documentation * quotes_labels: Rename variable The variable was renamed to let code more readable * quotes_labels: call function There was a missing call in our utf-8 function, this commit fixes this * quotes_labels: Remove segmentation fault The previous code could result in a segmentation fault depending of the label size, this commit removes this possibility * quotes_labels: remove unecessary UTF-8 Considering that I am testing all addresses, I am removing the UTf-8 call * quotes_labels: Rename variable This commit renames variable according to documentation * quotes_labels: Comparison to function this commit converts the comparison to test labels to an unique function * quotes_labels: Restore name The new name was breaking compatibility with the structure value * quotes_labels: Rename function Rename the function to keep an unique pattern * quotes_labels: Restore previous utf-8 library * quotes_labels: Remove missing file * quotes_labels: Fix grammar Fix grammar documentation * quotes_labels: Missing comparison This commit brings the two missing characters that must be rejected from value * quotes_labels: Fix grammar again Fix grammar documentation
Diffstat (limited to 'docs/configuration-guide.md')
-rw-r--r--docs/configuration-guide.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/configuration-guide.md b/docs/configuration-guide.md
index a6a1c701bb..ec280ce919 100644
--- a/docs/configuration-guide.md
+++ b/docs/configuration-guide.md
@@ -143,7 +143,8 @@ restrictions are applied for label names:
- Names cannot start with `_`, but it can be present in other parts of the name.
- Names only accept alphabet letters, numbers, dots, and dashes.
-The policy for values are more flexible, but you can not use exclamation (`!`), whitespaces (` `) and asterisk (`*`),
+The policy for values is more flexible, but you can not use exclamation marks (`!`), whitespaces (` `), single quotes (`'`),
+double quotes (`"`), or asterisks (`*`),
because they are used to compare label values in health alarms and templates.
[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fdocs%2Fconfiguration-guide&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)