openstack
/
monasca-api
Code Issues Proposed changes

Update documentation for dimension keys and values 

Change-Id: I94c055222c2648d7a76bd95405c8c4557dc7a3cb
This commit is contained in:
Ryan Brandt 2015-05-01 13:51:43 -06:00
parent 8877db7f31
commit b377991913
2 changed files with 2 additions and 5 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 for the following: `> < = { } ( ) , ' " ; &`. If one of the restricted characters is needed, this can be achieved by double quoting the name.
Defines the name of a metric. A name is of type string(255). The name may include any characters except the following: `> < = { } ( ) , ' " ; &`. If one of the restricted characters is needed, this can be achieved by double quoting the name.
### Dimensions
A dictionary of (key, value) pairs. The key and value are of type string(255). The dimensions string may include any characters except for the following: `> < = { } ( ) , ' " ; &`. If one of the restricted characters is needed, this can be achieved by double quoting the dimensions.
A dictionary of (key, value) pairs. The key and value are of type string(255). Dimension keys may not begin with '_' (underscore). The dimensions string may include any characters except the following: `> < = { } ( ) , ' " ; &`. If one of the restricted characters is needed, this can be achieved by double quoting the dimension key or value containing the character.
### 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".

3
setup.cfg
View File

@ -1,9 +1,6 @@
[metadata]
name = monasca-api
# Juno
version = 2014.7
summary = OpenStack Monitoring Service
description-file =
README.md