Series: insert

Description

Inserts a timestamped array of numbers for a given series identified by metric, entity, and series tags.

  • Entity name, metric name, and tag names can contain only printable characters. Names are case-insensitive and converted to lowercase when stored.
  • Tag values are case-sensitive and stored as submitted.
  • The number of series tags cannot exceed 1,024.
  • New entities and metrics are created and registered automatically by the database.
  • A new metric is registered as versioned if the first sample contains versions.

Request

Method Path Content-Type Header
POST /api/v1/series/insert application/json

Parameters

None.

Fields

The request contains an array of series objects, each consisting of an array of timestamped value objects.

Name Type Description
entity string [Required] Entity name.
metric string [Required] Metric name.
tags object Series tags object, where field name represents tag name and field value is tag value
For example: {"tag-1":"val-1","tag-2":"val2"}
type string Inserted data type: HISTORY, FORECAST.
Default: HISTORY
forecastName string Forecast name.
Applicable when type is FORECAST.
forecastName can be used to store a custom forecast identified by name.
If forecastName is omitted, values overwrite the default forecast.
data array [Required] Array of value objects.
Example [{"d":"2016-06-01T12:08:42.518Z", "v":50.8}].

Value Object

  • The value object must contain the sample time and a numeric or text value.
  • Specify sample time in Unix time (t field, milliseconds) or ISO format (d field, text).
  • Minimum sample time supported by the database is 1970-01-01T00:00:00.000Z, or 0 milliseconds in Unix time.
  • Maximum sample date supported by the database is 2106-02-07T06:59:59.999Z, or 4294969199999 milliseconds in Unix time.
Name Type Description
t integer [Required] Sample Unix time in milliseconds.
Example: {"t":1464782922000, "v":50.8}.
d string [Required] Sample time in ISO format.
Example: {"d":"2016-06-01T12:08:42Z", "v":50.8}.
v number [Required] Numeric sample value at time t/d.
null is supported and is stored as NaN (Not a Number).
Example {"d":"2016-06-01T12:08:42Z", "v": null}
s number Standard deviation of the forecast value v.
Example: {"d":"2016-06-01T12:08:42Z", "v":50.8, "s":12.340}.
Applicable when type is FORECAST.
x string Optional text sample value at time t/d.
Empty string "" is supported and is stored as "".
Example {"d":"2016-06-01T12:08:42Z", "v": null, "x": "Shutdown"}
version object Object containing version source and status fields for versioned metrics.
{"source":string, "status":string}.
Applicable when metric is versioned.

data example:

"data": [
    { "d": "2016-06-05T05:49:18.127Z", "v": 17.7 },
    { "d": "2016-06-05T05:49:25.127Z", "v": 14.0 }
]

Number Representation

  • The string representation of an inserted number contains the optional sign, + (\u002B) or - (\u002D), followed by a sequence of zeros or decimal digits (integer part), optionally followed by a fraction, optionally followed by an exponent.
  • The exponent consists of the character e (\u0065) or E (\u0045) followed by an optional sign, + (\u002B) or - (\u002D), followed by one or more decimal digits.
  • The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction.
  • The number formed by the sign, the integer, and the fraction is referred to as the significand.
  • The significand value stripped from trailing zeros must be within Long.MAX_VALUE 9223372036854775807 and Long.MIN_VALUE -9223372036854775808 (19 digits). Otherwise the database returns an IllegalArgumentException: BigDecimal significand overflows the long type for decimal metrics or rounds the value for non-decimal metrics. For example, significand for 1.1212121212121212121212121212121212121212121 contains 44 digits and is rounded to 1.121212121212121212 if inserted for non-decimal metric.

Response

Fields

None.

Errors

Status Code Description
400 IllegalArgumentException: Empty entity.
400 IllegalArgumentException: Negative timestamp.
400 IllegalArgumentException: No data.
400 IllegalArgumentException: BigDecimal significand overflows the long type.
500 JsonParseException: Unexpected character "}"
500 JsonMappingException: No enum constant in field type.

Example

Request

URI

POST /api/v1/series/insert

Payload

[{
    "entity": "nurswgvml007",
    "metric": "mpstat.cpu_busy",
    "data": [
        { "d": "2016-06-05T05:49:18.127Z", "v": 17.7 },
        { "d": "2016-06-05T05:49:25.127Z", "v": 14.0 }
    ]
}]

curl

  • --data Payload
curl https://atsd_hostname:8443/api/v1/series/insert \
  --insecure --include --user {username}:{password} \
  --header "Content-Type: application/json" \
  --data '[{"entity": "nurswgvml007", "metric": "mpstat.cpu_busy", "data": [{ "t": 1462427358127, "v": 22.0 }]}]'
  • file
curl https://atsd_hostname:8443/api/v1/series/insert \
  --insecure --include --user {username}:{password} \
  --header "Content-Type: application/json" \
  --data @file.json

Additional Examples