From 58f7e9c21469053e29fd09c038b8388bb7723717 Mon Sep 17 00:00:00 2001 From: Daniel Beardsley Date: Thu, 26 Oct 2023 01:50:48 -0700 Subject: [PATCH] Tags Docs: fix allowed characters Space is definitely not allowed as the parser in carbon does this: metric, value, timestamp = line.strip().split() Thus a space in any part of the tags string or metric name would result in it being cut off and the remaining part would be parsed as part of the value. --- docs/tags.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tags.rst b/docs/tags.rst index 041867cee..9abcabd51 100644 --- a/docs/tags.rst +++ b/docs/tags.rst @@ -17,7 +17,7 @@ Carbon will automatically decode the tags, normalize the tag order, and register .. _querying-tagged-series: -Tag names must have a length >= 1 and may contain any ascii characters except ``;!^=``. Tag values must also have a length >= 1, they may contain any ascii characters except ``;`` and the first character must not be ``~``. UTF-8 characters may work for names and values, but they are not well tested and it is not recommended to use non-ascii characters in metric names or tags. Metric names get indexed under the special tag `name`, if a metric name starts with one or multiple `~` they simply get removed from the derived tag value because the `~` character is not allowed to be in the first position of the tag value. If a metric name consists of no other characters than `~`, then it is considered invalid and may get dropped. +Tag names must have a length >= 1 and may contain any ascii characters except ``;!^=`` and space. Tag values must also have a length >= 1, they may contain any ascii characters except ``;`` and space and the first character must not be ``~``. UTF-8 characters may work for names and values, but they are not well tested and it is not recommended to use non-ascii characters in metric names or tags. Metric names get indexed under the special tag `name`, if a metric name starts with one or multiple `~` they simply get removed from the derived tag value because the `~` character is not allowed to be in the first position of the tag value. If a metric name consists of no other characters than `~`, then it is considered invalid and may get dropped. Querying --------