openstack
/
monasca-api
Code Issues Proposed changes

Merge "Do not allow metrics in quotes"

This commit is contained in:
Jenkins 2015-07-15 20:49:43 +00:00 committed by Gerrit Code Review
parent 9c243ba04f b262e5bee7
commit 1238fb6e07
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/monasca-api-spec.md
View File

@ -331,10 +331,10 @@ Before using the API, you must first get a valid auth token from Keystone. All A
A metric is uniquely identified by a name and set of dimensions.
### Name
Defines the name of a metric. A name is of type string(255). The name may include any characters except the following: `> < = { } ( ) , ' " \ ; &`. A metric name surrounded by double quotes may include the following: `> < = { } ( ) , ; &`, but not `" \`. Note that JSON does allow control characters (such as `\n`), however these should not be used in metric names.
Defines the name of a metric. A name is of type string(255). The name may include any characters except the following: `> < = { } ( ) , ' " \ ; &`. Note that JSON does allow control characters (such as `\n`), however these should not be used in metric names.
### Dimensions
A dictionary of (key, value) pairs. The key and value are of type string(255). Dimension keys may not begin with '_' (underscore). The dimension key and value strings may include any characters except the following: `> < = { } ( ) , ' " \ ; &`. A dimension key or value surrounded by double quotes may include the following: `> < = { } ( ) , ; &`, but not `" \`. Note that JSON does allow control characters (such as `\n`), however these should not be used in dimension keys or values.
A dictionary of (key, value) pairs. The key and value are of type string(255). Dimension keys may not begin with '_' (underscore). The dimension key and value strings may include any characters except the following: `> < = { } ( ) , ' " \ ; &`. Note that JSON does allow control characters (such as `\n`), however these should not be used in dimension keys or values.
### Text Representation
In this document, metrics will be represented in the form `name{name=value,name=value}` where name is the metric name and the name=value pairs in the curly braces are the dimensions. For example, `cpu.idle_perc{service=monitoring,hostname=mini-mon}` represents a metric with the name "cpu.idle_perc" and the dimensions "service=monitoring" and "hostname=mini-mon".