Skip to content

Commit

Permalink
Update line protocol README for new integer spec
Browse files Browse the repository at this point in the history
As noted in #3526 writing
integer values now requires a tailing i. This commit updates the README
appropriately
  • Loading branch information
desa committed Aug 5, 2015
1 parent 47f0835 commit 25b2f7c
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions tsdb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,22 @@ Fields are key-value metrics associated with the measurement. Every line must h

Field keys are always strings and follow the same syntactical rules as described above for tag keys and values. Field values can be one of four types. The first value written for a given field on a given measurement defines the type of that field for all series under that measurement.

* _integer_ - Numeric values that do not include a decimal. (e.g. 1, 345, 2015, -10)
* _float_ - Numeric values that include a decimal. (e.g. 1.0, -3.14, 6.0+e5). Note that all values _must_ have a decimal even if the decimal value is zero (1 is an _integer_, 1.0 is a _float_).
* _integer_ - Numeric values that do not include a decimal and are followed by a trailing i when inserted (e.g. 1i, 345i, 2015i, -10i). Note that all values must have a trailing i. If they do not they will be written as floats.
* _float_ - Numeric values that include a decimal or that are not followed by a trailing i. (e.g. 1, 1.0, -3.14, 6.0+e5, 10).
* _boolean_ - A value indicating true or false. Valid boolean strings are (t, T, true, TRUE, f, F, false, and FALSE).
* _string_ - A text value. All string values _must_ be surrounded in double-quotes `"`. If the string contains
a double-quote, it must be escaped with a backslash, e.g. `\"`.


```
# integer value
cpu value=1
cpu value=1i
# float value
cpu_load value=1
cpu_load value=1.0
cpu_load value=1.2
# boolean value
Expand All @@ -58,7 +62,7 @@ error fatal=true
event msg="logged out"
# multiple values
cpu load=10.0,alert=true,reason="value above maximum threshold"
cpu load=10,alert=true,reason="value above maximum threshold"
```

## Timestamp
Expand All @@ -71,13 +75,13 @@ an integer epoch in microseconds, milliseconds, seconds, minutes or hours.
## Full Example
A full example is shown below.
```
cpu,host=server01,region=uswest value=1.0 1434055562000000000
cpu,host=server02,region=uswest value=3.0 1434055562000010000
cpu,host=server01,region=uswest value=1 1434055562000000000
cpu,host=server02,region=uswest value=3 1434055562000010000
```
In this example the first line shows a `measurement` of "cpu", there are two tags "host" and "region, the `value` is 1.0, and the `timestamp` is 1434055562000000000. Following this is a second line, also a point in the `measurement` "cpu" but belonging to a different "host".
```
cpu,host=server\ 01,region=uswest value=1.0,msg="all systems nominal"
cpu,host=server\ 01,region=us\,west value_int=1
cpu,host=server\ 01,region=uswest value=1,msg="all systems nominal"
cpu,host=server\ 01,region=us\,west value_int=1i
```
In these examples, the "host" is set to `server 01`. The field value associated with field key `msg` is double-quoted, as it is a string. The second example shows a region of `us,west` with the comma properly escaped. In the first example `value` is written as a floating point number. In the second, `value_int` is an integer.

Expand Down

0 comments on commit 25b2f7c

Please sign in to comment.