Skip to content
This repository has been archived by the owner on Nov 8, 2022. It is now read-only.

Commit

Permalink
Fixes #1477, Added information about not recommended characters as a …
Browse files Browse the repository at this point in the history
…namespace separators in the task manifest
  • Loading branch information
katarzyna-z committed Mar 16, 2017
1 parent 0b2c031 commit 718bc2d
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/TASKS.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,16 @@ More information about the architecture behind this can be found [here](DISTRIBU

#### collect

The collect section describes which metrics are requested to be collected.
The collect section describes which metrics, indicated by namespaces, are requested to be collected.

Elements of namespace are separated by **namespace separators** which can be set in the task manifest as different characters,
with some limitations specific for format of the task manifest. The first character in the namespace defines the namespace separator.

It is not recommended to use following characters in the task manifest as the namespace separators:
- for YAML: `|`,`#`, `$`, `>`,`*`, `,`,`[`, `]`,`{`,`}`,`!`,`"`, `` ` ``,`%`,`@`
- for JSON: ` \ `, `$`,`"`, `*`

Some of mentioned characters may work as namespace separators but the namespace must be in double quotes (i.e.`"|intel|mock|foo"` for YAML) or special characters must be escaped.

Metrics can be enumerated using:

Expand Down

0 comments on commit 718bc2d

Please sign in to comment.