KairosDB

https://kairosdb.github.io/docs/
Admin
KairosDB is an open-source time-series database designed to handle large volumes of time-stamped...
Tokens:38,871
Snippets:400
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Query Data with Relative Date

Source: https://kairosdb.github.io/docs/QueryingData.html

This example shows how to query data using a relative start time.

```APIDOC
## POST /api/v1/datapoints/query

### Description
Queries data points from KairosDB using a relative time range.

### Method
POST

### Endpoint
http://localhost:8080/api/v1/datapoints/query

### Request Body
- **start_relative** (object) - Required - The relative start time for the query.
  - **value** (number) - Required - The value of the relative time.
  - **unit** (string) - Required - The unit of the relative time (e.g., "weeks", "days", "hours").
- **metrics** (array) - Required - A list of metrics to query.
  - **name** (string) - Required - The name of the metric.

### Request Example
```json
{
  "start_relative":{"value":20,"unit":"weeks"},
  "metrics": [
    {
      "name": "archive.file.tracked"
    }
  ]
}
```

### Response
#### Success Response (200)
- **Results** (array) - The queried data points.
  - **name** (string) - The name of the metric.
  - **values** (array) - An array of data points for the metric.
    - **timestamp** (number) - The timestamp of the data point.
    - **value** (number) - The value of the data point.
```

--------------------------------

### Get Version using Netcat

Source: https://kairosdb.github.io/docs/telnetapi/Version.html

An example of how to use netcat to send the 'version' command to a local KairosDB instance running on the default port (4242).

```bash
echo "version" | nc -w 30 localhost 4242

```

--------------------------------

### List Service Keys Response Example

Source: https://kairosdb.github.io/docs/restapi/Metadata.html

Example of a successful response when listing service keys.

```JSON
{
   "results":["service_key_1", "service_key_2"]
}
```

--------------------------------

### List Keys Response Example

Source: https://kairosdb.github.io/docs/restapi/Metadata.html

Example of a successful response when listing keys for a service key.

```JSON
{
   "results":["key_1", "key_2"]
}
```

--------------------------------

### Query Data with Absolute Date

Source: https://kairosdb.github.io/docs/QueryingData.html

This example demonstrates how to query data using an absolute start time.

```APIDOC
## POST /api/v1/datapoints/query

### Description
Queries data points from KairosDB.

### Method
POST

### Endpoint
http://localhost:8080/api/v1/datapoints/query

### Request Body
- **start_absolute** (number) - Required - The absolute start time for the query.
- **metrics** (array) - Required - A list of metrics to query.
  - **name** (string) - Required - The name of the metric.

### Request Example
```json
{
  "start_absolute":1,
  "metrics": [
    {
      "name": "archive.file.tracked"
    }
  ]
}
```

### Response
#### Success Response (200)
- **Results** (array) - The queried data points.
  - **name** (string) - The name of the metric.
  - **values** (array) - An array of data points for the metric.
    - **timestamp** (number) - The timestamp of the data point.
    - **value** (number) - The value of the data point.
```

--------------------------------

### Example Value Grouping Configuration

Source: https://kairosdb.github.io/docs/restapi/ValueGrouping.html

An example of how to configure the value grouper with a range size of 1000.

```json
"group_by": [
      {
        "name": "value",
        "range_size": 1000
      }
]
```

--------------------------------

### Example Bin Grouper Configuration

Source: https://kairosdb.github.io/docs/restapi/BinGrouping.html

An example of how to configure the 'bin' grouper to group values into bins of size 2, using specified bin edges.

```json
"group_by": [
      {
        "name": "bin",
        "bins": ["2", "4", "6", "8"]
      }
]
```

--------------------------------

### Example: Group by Hours for a Week

Source: https://kairosdb.github.io/docs/restapi/TimeGrouping.html

Groups data points by hours of the day for a week, creating 168 groups. Assumes the query start time is Sunday.

```json
"group_by": [
      {
        "name": "time",
        "group_count": "168",
        "range_size": {
          "value": "1",
          "unit": "hours"
        }
      }
]
```

--------------------------------

### Error Response Example

Source: https://kairosdb.github.io/docs/restapi/Metadata.html

Example of a failure response when an error occurs during metadata operations.

```JSON
{
    "errors": [
        "Failed to add value"
    ]
}
```

```JSON
{
    "errors": [
        "Failed to retrieve value"
    ]
}
```

```JSON
{
    "errors": [
        "Failed to get keys"
    ]
}
```

```JSON
{
    "errors": [
        "Failed to delete key"
    ]
}
```

--------------------------------

### Example: Grouping by Data Center and Host

Source: https://kairosdb.github.io/docs/restapi/TagGrouping.html

Demonstrates grouping query results by both 'data_center' and 'host' tags. This creates a separate object for each unique combination of these tags found in the data points.

```json
"group_by": [
        {
          "name": "tag",
          "tags": ["data_center", "host"]
        }
      ]
```

--------------------------------

### Response Example with Time Grouping

Source: https://kairosdb.github.io/docs/restapi/TimeGrouping.html

Illustrates the structure of a query response when time grouping is applied, showing the group number for each data point.

```json
{
  "queries": [
      {
          "results": [
              {
                 ...
              } ,
              {
                  "name": "metric1",
                  "group_by": [
                      {
                          "name": "time",
                          "range_size": {
                              "value": 1,
                              "unit": "HOURS"
                          },
                          "group_count": 168,
                          "group": {
                              "group_number": 60
                          }
                      }
                  ],
                  "tags": {
                      "data_center": ["dc1"],
                      "host": ["server1"]
                  },
                  "values": [
                      [1353222000000, 146],
                      [1353826800000, 241]
                  ]
              },
              {
                 ....
              },
              {
                  "name": "metric1",
                  "group_by": [
                      {
                          "name": "time",
                          "range_size": {
                              "value": 1,
                              "unit": "HOURS"
                          },
                          "group_count": 168,
                          "group": {
                              "group_number": 156
                          }
                      }
                  ],
                  "tags": {
                      "data_center": ["dc1"],
                      "host": ["server1"]
                  },
                  "values": [
                      [1353567600000, 2188],
                      [1354172400000, 3398]
                  ]
              }
          ]
      }
  ]
}
```

--------------------------------

### Start KairosDB in Background

Source: https://kairosdb.github.io/docs/GettingStarted.html

Launch KairosDB as a background process. This allows your terminal to be used for other tasks.

```shell
> ./kairosdb.sh start
```

--------------------------------

### Get KairosDB Version

Source: https://kairosdb.github.io/docs/restapi/Version.html

Use this endpoint to retrieve the currently installed version of KairosDB. A successful request returns an HTTP 200 status code.

```json
{
  "version": "KairosDB 0.9.4"
}
```

--------------------------------

### Example Response Structure

Source: https://kairosdb.github.io/docs/restapi/Features.html

Illustrates a typical JSON response structure from the KairosDB API, showing nested data points and tags.

```json
{
                            }] 
                    }] 
            } 
            ...
    }]
```

--------------------------------

### Run KairosDB in Foreground

Source: https://kairosdb.github.io/docs/GettingStarted.html

Start KairosDB and keep it running in the foreground. Useful for monitoring and debugging.

```shell
> ./kairosdb.sh run
```

--------------------------------

### Example Error Response

Source: https://kairosdb.github.io/docs/restapi/DeleteMetric.html

An example of a failure response when an error occurs during the metric deletion process.

```json
{
  "errors": ["Connect to 10.92.4.1:4242 timed out"]
}
```

--------------------------------

### Example Response Structure with Tag Grouping

Source: https://kairosdb.github.io/docs/restapi/TagGrouping.html

Illustrates the structure of a response when grouping by 'data_center' and 'host'. Each result object includes a 'group' object detailing the specific tag values for that group.

```json
{
  "queries": [
      {
          "results": [
              {
                  "name": "metric1",
                  "group_by": [
                      {
                          "name": "tag",
                          "tags": ["data_center", "host"],
                          "group": {
                              "data_center": "dc1",
                              "host": "server1"
                          }
                      }
                  ],
                  "tags": {
                      "data_center": ["dc1"],
                      "host": ["server1"]
                  },
                  "values": [
                      [1353222000000, 31],
                      [1364796000000, 723]
                  ]
              },
              {
                  "name": "metric1",
                  "group_by": [
                      {
                          "name": "tag",
                          "tags": ["data_center", "host"],
                          "group": {
                              "data_center": "dc2",
                              "host": "server1"
                          }
                      }
                  ],
                  "tags": {
                      "data_center": ["dc2"],
                      "host": ["server1"]
                  },
                  "values": [
                      [1353222000000, 108],
                      [1364796000000, 1318]
                  ]
              },

             ...

          ]
      }
  ]
}
```

--------------------------------

### Configure Datastore in Hocon

Source: https://kairosdb.github.io/docs/GettingStarted.html

Specify the datastore module to use in the KairosDB configuration file. This example shows the structure for setting the datastore property.

```hocon
kairosdb: {
    service: {
        datastore: "<config value>"
    }
}
```

--------------------------------

### Version

Source: https://kairosdb.github.io/docs/restapi/index.html

Get the current version of the KairosDB instance.

```APIDOC
## GET /api/v1/version

### Description
Get the current version of the KairosDB instance.

### Method
GET

### Endpoint
/api/v1/version

### Response
#### Success Response (200 OK)
- **version** (string) - The version string of KairosDB.

#### Response Example
```json
{
  "version": "1.2.0"
}
```
```

--------------------------------

### Query Metrics via GET

Source: https://kairosdb.github.io/docs/restapi/QueryMetrics.html

Query metrics using the GET method. The query JSON must be URL-encoded and passed as the 'query' parameter.

```APIDOC
## GET /api/v1/datapoints/query

### Description
Returns a list of metric values based on a set of criteria. The query JSON must be URL-encoded and passed to the "query" parameter.

### Method
GET

### Endpoint
http://[host]:[port]/api/v1/datapoints/query?query=[encoded_JSON]

### Parameters
#### Query Parameters
- **query** (string) - Required - URL-encoded JSON string representing the query criteria.

### Request Example
(URL-encoded JSON query string)

### Response
(Details of the response structure would typically be here, but are not provided in the source text.)
```

--------------------------------

### Insert Data with Netcat using Putm

Source: https://kairosdb.github.io/docs/telnetapi/Putm.html

A shell script demonstrating how to insert data into KairosDB using the 'putm' command via netcat. It dynamically gets the current time in milliseconds.

```bash
#!/bin/bash

# Current time in milliseconds
now=$(($(date +%s%N)/1000))
metric=load_value_test
value=42
host=10.92.4.4

echo "putm $metric $now $value host=A" | nc -w 30 $host 4242

```

--------------------------------

### Get the Value

Source: https://kairosdb.github.io/docs/restapi/Metadata.html

Retrieves the string value associated with a specific service, service key, and key. Returns an empty response if the key does not exist.

```APIDOC
## Get the Value

### Description
Returns the value for the given service, service key, and key if it exists or an empty response if it does not exist.
_service_ The name of the service.
_serviceKey_ The name of the service key.
_key_ The name of the key.

### Method
GET

### Endpoint
http://[host]:[port]/api/v1/metadata/{service}/{serviceKey}/{key}

### Response
_Success_
The response contains the value or an empty string if not found. Returns 200 when successful.
_Failure_
The response will be 500 Internal Server Error if an error occurs writing the value.
```json
{
    "errors": [
        "Failed to retrieve value"
    ]
}
```
```

--------------------------------

### Bin Grouper Response Example

Source: https://kairosdb.github.io/docs/restapi/BinGrouping.html

Illustrates the structure of a KairosDB query response when using the 'bin' grouper. It shows the assigned bin number for each data point group.

```json
{
  "queries": [
      {
          "results": [
              {
                  "name": "metric1",
                  "group_by": [
                   {
                      "name": "bin",
                      "bins": ["2", "4", " 6", " 8"],
                       "group": {
                          "bin_number": 0
                       }
                  }
                  ],
                  "tags": {
                      "data_center": ["dc1"],
                      "host": ["server1"]
                  },
                  "values": [
                      [1353222000000, 1],
                      [1353567600000, 1]
                  ]
              },
              {
                  "name": "metric1",
                  "group_by": [
                      {
                          "name": "bin",
                          "bins": ["2", "4", " 6", " 8"],
                          "group": {
                              "bin_number": 1
                          }
                      }
                  ],
                  "tags": {
                      "data_center": ["dc1"],
                      "host": ["server2"]
                  },
                  "values": [
                      [1353567600000, 2],
                      [1353913200000, 2],
                      [1353999600000, 3]
                  ]
              },
              {
                  "name": "metric1",
                  "group_by": [
                      {
                          "name": "bin",
                          "bins": ["2", "4", " 6", " 8"],
                          "group": {
                              "bin_number": 2
                          }
                      }
                  ],
                  "tags": {
                      "data_center": ["dc1"],
                      "host": ["server2"]
                  },
                  "values": [
                      [1353567600000, 4],
                  ]
              },
              {
                  "name": "metric1",
                  "group_by": [
                      {
                          "name": "bin",
                          "bins": ["2", "4", " 6", " 8"],
                          "group": {
                              "bin_number": 3
                          }
                      }
                  ],
                  "tags": {
                      "data_center": ["dc1"],
                      "host": ["server2"]
                  },
                  "values": [
                      [1353567600000, 6],
                  ]
              }
          ]
      }
  ]
}
```

--------------------------------

### List Metric Names with Prefix

Source: https://kairosdb.github.io/docs/restapi/ListMetricNames.html

Retrieves a list of metric names that start with the specified prefix. This is useful for filtering and finding specific metrics.

```APIDOC
## GET /api/v1/metricnames?prefix=[prefix]

### Description
Returns a list of metric names that start with the specified prefix.

### Method
GET

### Endpoint
http://[host]:[port]/api/v1/metricnames?prefix=[prefix]

#### Query Parameters
- **prefix** (string) - Required - The prefix to filter metric names by.

### Response
#### Success Response (200)
- **results** (array) - A list of metric names matching the prefix.

### Response Example
```json
{
  "results": [
    "archive_file_search",
    "archive_file_tracked"
  ]
}
```
```

--------------------------------

### Get Metadata Value

Source: https://kairosdb.github.io/docs/restapi/Metadata.html

Retrieves the string value for a specific service, service key, and key. Returns an empty string if not found. Returns 200 on success.

```HTTP
GET http://[host]:[port]/api/v1/metadata/{service}/{serviceKey}/{key}
```

--------------------------------

### Generate Maven Project with IvyIdea

Source: https://kairosdb.github.io/docs/kairosdevelopment/IntelliJSetup.html

Steps to clone the KairosDB repository, set the CLASSPATH, and generate a project POM file using the IvyIdea plugin. This approach aims to create a Maven project for IntelliJ.

```bash
git clone https://github.com/kairosdb/kairosdb.git
cd kairosdb
export CLASSPATH=tools/tablesaw-1.2.4.jar
java make project-pom >> Will generate pom.xml
```

--------------------------------

### Enable Graphite Protocol Module

Source: https://kairosdb.github.io/docs/Graphite.html

Enable the CarbonServerModule in the kairosdb.properties file to activate the Graphite plaintext and pickle protocol support.

```properties
kairosdb.service.carbon=org.kairosdb.core.carbon.CarbonServerModule
```

--------------------------------

### Configure IntelliJ Module Settings

Source: https://kairosdb.github.io/docs/kairosdevelopment/IntelliJSetup.html

Defines source and test folders for the main KairosDB module. Ensure these paths accurately reflect your project structure.

```xml
<module type="JAVA_MODULE" version="4">
  <component name="NewModuleRootManager" inherit-compiler-output="true">
    <exclude-output />
    <content url="file://$MODULE_DIR$">
      <sourceFolder url="file://$MODULE_DIR$/src/main/conf" isTestSource="false" />
      <sourceFolder url="file://$MODULE_DIR$/src/main/java" isTestSource="false" />
      <sourceFolder url="file://$MODULE_DIR$/src/main/resources" isTestSource="false" />
      <sourceFolder url="file://$MODULE_DIR$/src/test/java" isTestSource="true" />
      <sourceFolder url="file://$MODULE_DIR$/src/test/resources" isTestSource="true" />
      <excludeFolder url="file://$MODULE_DIR$/build" />
    </content>
    <orderEntry type="inheritedJdk" />
    <orderEntry type="sourceFolder" forTests="false" />
    <orderEntry type="module-library">
      <library>
        <CLASSES>
          <root url="file://$MODULE_DIR$/lib" />
        </CLASSES>
        <JAVADOC />
        <SOURCES>
          <root url="file://$MODULE_DIR$/lib" />
        </SOURCES>
        <jarDirectory url="file://$MODULE_DIR$/lib" recursive="false" />
        <jarDirectory url="file://$MODULE_DIR$/lib" recursive="false" type="SOURCES" />
      </library>
    </orderEntry>
    <orderEntry type="module-library">
      <library>
        <CLASSES>
          <root url="file://$MODULE_DIR$/lib/ivy/default" />
        </CLASSES>
        <JAVADOC />
        <SOURCES>
          <root url="file://$MODULE_DIR$/lib/ivy/default" />
        </SOURCES>
        <jarDirectory url="file://$MODULE_DIR$/lib/ivy/default" recursive="false" />
        <jarDirectory url="file://$MODULE_DIR$/lib/ivy/default" recursive="false" type="SOURCES" />
      </library>
    </orderEntry>
    <orderEntry type="library" name="tools" level="project" />
  </component>
</module>
```

--------------------------------

### Get KairosDB Version

Source: https://kairosdb.github.io/docs/restapi/Version.html

Retrieves the current version of the KairosDB instance.

```APIDOC
## GET /api/v1/version

### Description
Returns the version of KairosDB.

### Method
GET

### Endpoint
http://[host]:[port]/api/v1/version

### Response
#### Success Response (200)
- **version** (string) - The version of KairosDB.

### Response Example
```json
{
  "version": "KairosDB 0.9.4"
}
```
```

--------------------------------

### Get Roll-up Task

Source: https://kairosdb.github.io/docs/restapi/Roll-ups.html

Retrieves a specific roll-up task by its unique identifier.

```APIDOC
## GET /api/v1/rollups/{id}

### Description
Returns the roll-up task by Id.

### Method
GET

### Endpoint
http://[host]:[port]/api/v1/rollups/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the roll-up task.

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the roll-up task.
- **name** (string) - The name of the roll-up task.
- **execution_interval** (object) - The interval at which the roll-up task is executed.
  - **value** (integer) - The numeric value of the interval.
  - **unit** (string) - The unit of the interval (e.g., "hours", "minutes").
- **rollups** (array) - A list of roll-up configurations.
  - **save_as** (string) - The name to save the roll-up results as.
  - **query** (object) - The query definition for the roll-up.
    - **cache_time** (integer) - The cache time for the query.
    - **metrics** (array) - A list of metrics to include in the roll-up.
      - **name** (string) - The name of the metric.
      - **limit** (integer) - The limit for the metric data.
      - **tags** (object) - Tags to filter the metric data.
      - **aggregators** (array) - Aggregators to apply to the metric data.

### Response Example
```json
{
    "id": "ce55e623-0610-4451-a725-3daee896afd9",
    "name": "MyRollup",
    "execution_interval": {
            "value": 1,
            "unit": "hours"
    },
    "rollups": [{
            "save_as": "kairosdb.http.query_time_rollup",
            "query": {
                    "cache_time": 0,
                    "metrics": [{
                            "name": "kairosdb.http.query_time",
                            "limit": 10000,
                            "tags": {
                                    "host": ["foo", "bar"],
                                    "customer": ["foobar"]
                            },
                            "aggregators": [{
                                    "name": "sum",
                                    "sampling": {
                                            "value": 1,
                                            "unit": "minutes"
                                    }
                            }, {
                                    "name": "avg",
                                    "sampling": {
                                            "value": 10,
                                            "unit": "minutes"
                                    }
                            }]
                    }]
            }
    }]
}
```

#### Error Response
- **404** - Roll-up resource not found.
- **500** - Internal Server Error.
```

--------------------------------

### KairosDB Putm Command Format

Source: https://kairosdb.github.io/docs/telnetapi/Putm.html

Illustrates the expected format for submitting data using the 'putm' command.

```text
putm <metric name> <time stamp> <value> <tag> <tag>... 

```

--------------------------------

### Get Roll-up Task

Source: https://kairosdb.github.io/docs/restapi/index.html

Retrieve the details of a specific roll-up task by its name.

```APIDOC
## GET /api/v1/rollups/run/{task_name}

### Description
Retrieve the details of a specific roll-up task by its name.

### Method
GET

### Endpoint
/api/v1/rollups/run/{task_name}

### Parameters
#### Path Parameters
- **task_name** (string) - Required - The name of the roll-up task to retrieve.

### Response
#### Success Response (200 OK)
- **name** (string) - The name of the roll-up task.
- **metric_names** (array) - The metric names included in the task.
- **roll_up_interval** (object) - The interval for the roll-up.
- **aggregator** (object) - The aggregator used.

#### Response Example
```json
{
  "name": "daily_cpu_average",
  "metric_names": ["cpu.usage"],
  "roll_up_interval": {
    "value": 1,
    "unit": "days"
  },
  "aggregator": {
    "name": "average"
  }
}
```
```

--------------------------------

### Query Performance Comparison: Raw vs. Daily Roll-up

Source: https://kairosdb.github.io/docs/Roll-ups.html

Illustrates the significant performance improvement in query time and data points returned when using a daily roll-up compared to querying raw millisecond data.

```text
Query Time: 24 seconds
Data Points Returned: 1,535,711
Data Points Plotted: 12


```

```text
Query Time: 417 milliseconds
Data Points Returned: 2,045
Data Points Plotted: 12

```

--------------------------------

### Get Roll-up Task

Source: https://kairosdb.github.io/docs/index.html

Retrieves details of a specific roll-up task by its ID.

```APIDOC
## GET /api/v1/rollups/{id}

### Description
Retrieves details of a specific roll-up task.

### Method
GET

### Endpoint
/api/v1/rollups/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the roll-up task to retrieve.

### Response
#### Success Response (200 OK)
- **id** (string) - The ID of the roll-up task.
- **name** (string) - The name of the roll-up task.
- **source_metric** (string) - The name of the source metric.
- **target_metric** (string) - The name of the target metric.
- **period** (integer) - The time period in seconds for aggregation.
- **time_zone** (string) - The time zone for the roll-up task.
- **start_time** (long) - The start time in milliseconds since the epoch.
- **delay_backfill** (boolean) - Whether to delay backfilling data.
- **retention_days** (integer) - The number of days to retain the aggregated data.
- **aggregators** (array) - An array of aggregators used in the task.
```

--------------------------------

### Import Data from Compressed File

Source: https://kairosdb.github.io/docs/ImportExport.html

This command imports data from a gzipped file by decompressing it on the fly and piping it into the KairosDB import process.

```bash
> gzip -dc export.gz | bin/kairosdb.sh import

```

--------------------------------

### Get Specific Feature Metadata

Source: https://kairosdb.github.io/docs/restapi/Features.html

Returns metadata for a particular feature specified by its name.

```APIDOC
## GET /api/v1/features/{feature}

### Description
Returns metadata for a particular feature.

### Method
GET

### Endpoint
http://[host]:[port]/api/v1/features/{feature}

### Parameters
#### Path Parameters
- **feature** (string) - Required - The name of the feature to retrieve metadata for.
```

--------------------------------

### Get All Features Metadata

Source: https://kairosdb.github.io/docs/restapi/Features.html

Retrieves metadata for all available features in KairosDB. This includes details about aggregators, GroupBys, and their properties.

```json
[
    {
        "name": "groupby",
                "label": "Group By",
                "properties": [{
                        "name": "tag",
                        "label": "Tag",
                        "description": "Groups data points by tag names.",
                        "properties": [{
                                "name": "tags",
                                "label": "Tags",
                                "description": "A list of tags to group by.",
                                "optional": false,
                                "type": "array",
                                "options": [],
                                "defaultValue": "[]",
                                "autocomplete": "tags",
                                "multiline": false,
                                "validations": [{
                                        "expression": "value.length \u003e 0",
                                        "type": "js",
                                        "message": "Tags can\u0027t be empty."
                                }]
                        }]
                },
                ...
        },
        {
                "name": "aggregators",
                "label": "Aggregator",
                "properties": [{
                        "name": "avg",
                        "label": "AVG",
                        "description": "Averages the data points together.",
                        "properties": [{
                                "name": "align_sampling",
                                "label": "Align sampling",
                                "description": "When set to true the time for the aggregated data point for each range will fall on the start of the range instead of being the value for the first data point within that range. Note that align_sampling, align_start_time, and align_end_time are mutually exclusive. If more than one are set, unexpected results will occur.",
                                "optional": false,
                                "type": "boolean",
                                "options": [],
                                "defaultValue": "true",
                                "autocomplete": "",
                                "multiline": false,
                                "validations": []
                        }]
                },
                ...
                }]
        }]

]
```

--------------------------------

### List Keys

Source: https://kairosdb.github.io/docs/restapi/Metadata.html

Retrieves all keys for a given service and service key. Returns an empty list if none exist. Returns 200 on success.

```HTTP
GET http://[host]:[port]/api/v1/metadata/{service}/{serviceKey}
```

--------------------------------

### Get Health Status

Source: https://kairosdb.github.io/docs/restapi/Health.html

Retrieves the status of each health check (JVM thread deadlock and Datastore query) as a JSON array.

```APIDOC
## GET /api/v1/health/status

### Description
Returns the status of each health check as JSON.

### Method
GET

### Endpoint
http://[host]:[port]/api/v1/health/status

### Response
#### Success Response (200)
- Array of strings indicating the status of each check, e.g., ["JVM-Thread-Deadlock: OK","Datastore-Query: OK"]

### Response Example
```json
["JVM-Thread-Deadlock: OK","Datastore-Query: OK"]
```
```

--------------------------------

### Import Data from File

Source: https://kairosdb.github.io/docs/ImportExport.html

Use this command to import data from a specified file into KairosDB. If no file is specified, input is read from stdin.

```bash
> bin/kairosdb.sh import -f export.txt

```

--------------------------------

### Invoke Version Command

Source: https://kairosdb.github.io/docs/telnetapi/Version.html

Send the 'version' command to the KairosDB server. This is the basic command to retrieve version information.

```text
version 

```

--------------------------------

### Get All Features Metadata

Source: https://kairosdb.github.io/docs/restapi/Features.html

Returns metadata for all features available in KairosDB. This includes information about aggregators, group by types, and their configurable properties.

```APIDOC
## GET /api/v1/features

### Description
Returns metadata for all features.

### Method
GET

### Endpoint
http://[host]:[port]/api/v1/features

### Response
#### Success Response (200)
- **Array of Feature Objects** - Description of the feature metadata structure.

### Response Example
```json
[
    {
        "name": "groupby",
        "label": "Group By",
        "properties": [
            {
                "name": "tag",
                "label": "Tag",
                "description": "Groups data points by tag names.",
                "properties": [
                    {
                        "name": "tags",
                        "label": "Tags",
                        "description": "A list of tags to group by.",
                        "optional": false,
                        "type": "array",
                        "defaultValue": "[]"
                    }
                ]
            }
        ]
    },
    {
        "name": "aggregators",
        "label": "Aggregator",
        "properties": [
            {
                "name": "avg",
                "label": "AVG",
                "description": "Averages the data points together.",
                "properties": [
                    {
                        "name": "align_sampling",
                        "label": "Align sampling",
                        "description": "When set to true the time for the aggregated data point for each range will fall on the start of the range instead of being the value for the first data point within that range. Note that align_sampling, align_start_time, and align_end_time are mutually exclusive. If more than one are set, unexpected results will occur.",
                        "optional": false,
                        "type": "boolean",
                        "defaultValue": "true"
                    }
                ]
            }
        ]
    }
]
```
```

--------------------------------

### Get Health Status

Source: https://kairosdb.github.io/docs/restapi/Health.html

Retrieves the status of JVM thread deadlock and Datastore query checks. Always returns HTTP 200.

```json
["JVM-Thread-Deadlock: OK","Datastore-Query: OK"]
```

--------------------------------

### Range Aggregator Parameters

Source: https://kairosdb.github.io/docs/restapi/Aggregators.html

Parameters common to Range Aggregators, including sampling, alignment options, start time, and time zone.

```APIDOC
## Range Aggregator Parameters

### Description
Parameters that are common to more than one aggregator, particularly those inheriting from the Range Aggregator.

### Parameters
#### Common Parameters
- **sampling** (Sampling {value (long), unit (See unit)})
  > Sampling is the length of the interval on which to aggregate data.
- **align_start_time** (boolean, optional, default value: false)
  > When set to true the time for the aggregated data point for each range will fall on the start of the range instead of being the value for the first data point within that range. Note that align_sampling, align_start_time, and align_end_time are mutually exclusive. If more than one are set, unexpected results will occur.
- **align_end_time** (boolean, optional, default value: false)
  > Setting this to true will cause the aggregation range to be aligned based on the sampling size. For example if your sample size is either milliseconds, seconds, minutes or hours then the start of the range will always be at the top of the hour. The difference between align_start_time and align_end_time is that align_end_time sets the timestamp for the datapoint to the beginning of the following period versus the beginning of the current period. As with align_start_time, setting this to true will cause your data to take the same shape when graphed as you refresh the data. Note that align_start_time and align_end_time are mutually exclusive. If more than one are set, unexpected results will occur.
- **align_sampling** (boolean, optional, default value: false)
  > Setting this to true will cause the aggregation range to be aligned based on the sampling size. For example if your sample size is either milliseconds, seconds, minutes or hours then the start of the range will always be at the top of the hour. The effect of setting this to true is that your data will take the same shape when graphed as you refresh the data. Note that align_sampling, align_start_time, and align_end_time are mutually exclusive. If more than one are set, unexpected results will occur.
- **start_time** (long, optional, default value: 0)
  > Start time to calculate the ranges from. Typically this is the start of the query
- **time_zone** (long time zone format)
  > Time zone to use when doing time based calculations.

### Example Usage
```json
{
  "aggregators": [
    {
      "name": "sum",
      "align_sampling": true,
      "align_start_time": true,
      "align_end_time": false,
      "sampling": {
        "value": 1,
        "unit": "minutes"
      }
    }
  ]
}
```
```

--------------------------------

### Insert Data via Telnet using Netcat

Source: https://kairosdb.github.io/docs/PushingData.html

This script demonstrates how to insert a single data point into KairosDB using the telnet protocol with netcat. Ensure the metric name has no spaces and the timestamp is in milliseconds.

```bash
#!/bin/bash

# Current time in milliseconds
now=$(($(date +%s%N)/1000000))
metric=load_value_test
value=42
host=10.92.4.4

echo "put $metric $now $value host=A" | nc -w 30 $host 4242

```

--------------------------------

### List Service Keys

Source: https://kairosdb.github.io/docs/restapi/Metadata.html

Retrieves all service keys for a given service. Returns an empty list if none exist. Returns 200 on success.

```HTTP
GET http://[host]:[port]/api/v1/metadata/{service}
```

--------------------------------

### Get Roll-up Task by ID

Source: https://kairosdb.github.io/docs/restapi/Roll-ups.html

Retrieves a specific roll-up task configuration using its unique identifier. Expects a 200 success code or 404/500 for errors.

```json
{
    "id": "ce55e623-0610-4451-a725-3daee896afd9",
    "name": "MyRollup",
    "execution_interval": {
            "value": 1,
            "unit": "hours"
    },
    "rollups": [{
            "save_as": "kairosdb.http.query_time_rollup",
            "query": {
                    "cache_time": 0,
                    "metrics": [{
                            "name": "kairosdb.http.query_time",
                            "limit": 10000,
                            "tags": {
                                    "host": ["foo", "bar"],
                                    "customer": ["foobar"]
                            },
                            "aggregators": [{
                                    "name": "sum",
                                    "sampling": {
                                            "value": 1,
                                            "unit": "minutes"
                                    }
                            }, {
                                    "name": "avg",
                                    "sampling": {
                                            "value": 10,
                                            "unit": "minutes"
                                    }
                            }]
                    }]
            }
    }]
}
```

--------------------------------

### Enable Roll-ups in KairosDB

Source: https://kairosdb.github.io/docs/Roll-ups.html

Uncomment this line in `kairosdb.properties` to enable the roll-up service. Restart KairosDB after making changes.

```properties
kairosdb.service.rollups=org.kairosdb.rollup.RollUpModule

```

--------------------------------

### Export Data to Compressed File

Source: https://kairosdb.github.io/docs/ImportExport.html

This command exports data and pipes it through gzip for compression, saving it to a .gz file. This is useful for reducing file size.

```bash
> bin/kairosdb.sh export | gzip > export.gz

```

--------------------------------

### Export Data to File

Source: https://kairosdb.github.io/docs/ImportExport.html

Use this command to export all metrics from KairosDB to a specified file. If no file is specified, output goes to stdout.

```bash
> bin/kairosdb.sh export -f export.txt

```

--------------------------------

### Run KairosDB with Debugger

Source: https://kairosdb.github.io/docs/kairosdevelopment/IntelliJSetup.html

Command to run KairosDB with debugging enabled, listening on port 5005. This allows attaching a debugger from IntelliJ IDEA.

```bash
java make run-debug
```

--------------------------------

### List Service Keys

Source: https://kairosdb.github.io/docs/restapi/index.html

Retrieve a list of all service keys configured in KairosDB.

```APIDOC
## GET /api/v1/keys/service

### Description
Retrieve a list of all service keys configured in KairosDB.

### Method
GET

### Endpoint
/api/v1/keys/service

### Response
#### Success Response (200 OK)
- **results** (array) - A list of service key names.

#### Response Example
```json
{
  "results": [
    "default",
    "monitoring"
  ]
}
```
```

--------------------------------

### List All Metric Names

Source: https://kairosdb.github.io/docs/restapi/ListMetricNames.html

Use this endpoint to retrieve a list of all metric names. No parameters are required for a full listing.

```json
{
  "results": [
    "archive_file_search",
    "archive_file_tracked"
  ]
}
```

--------------------------------

### Query Data with Relative Date

Source: https://kairosdb.github.io/docs/QueryingData.html

This JSON payload allows querying data points based on a relative time frame. Specify 'start_relative' with a 'value' and 'unit' to define the query's start.

```json
{
  "start_relative":{"value":20,"unit":"weeks"},
  "metrics": [
    {
      "name": "archive.file.tracked"
    }
  ]
}
```

--------------------------------

### List Keys

Source: https://kairosdb.github.io/docs/restapi/Metadata.html

Retrieves a list of all keys within a specific service and service key. Returns an empty list if no keys exist.

```APIDOC
## List Keys

### Description
Returns all keys for the given service key or an empty list if no keys exist.
_service_ The name of the service.
_serviceKey_ The name of the service key.

### Method
GET

### Endpoint
http://[host]:[port]/api/v1/metadata/{service}/{serviceKey}

### Response
_Success_
```json
{
   "results":["key_1", "key_2"]
}
```
The response contains a list of keys for the given service key or an empty string if not found. Returns 200 when successful.
_Failure_
The response will be 500 Internal Server Error if an error occurs writing the value.
```json
{
    "errors": [
        "Failed to get keys"
    ]
}
```
```

--------------------------------

### KairosDB API Error Response

Source: https://kairosdb.github.io/docs/restapi/AddDataPoints.html

This is an example of a failure response from the KairosDB API when a request is invalid or an error occurs. It typically returns a 400 Bad Request, 500 Internal Server Error, or a timeout error.

```json
{
  "errors": [
    "Connect to 10.92.4.1:4242 timed out"
  ]
}
```

--------------------------------

### Add Metadata Value

Source: https://kairosdb.github.io/docs/restapi/Metadata.html

Writes a string value for a given service, service key, and key. Returns 204 on success.

```HTTP
POST http://[host]:[port]/api/v1/metadata/{service}/{serviceKey}/{key}
<The Value>
```

--------------------------------

### POST Request Body for Querying Metrics

Source: https://kairosdb.github.io/docs/restapi/QueryMetrics.html

This JSON structure is used in the body of a POST request to query metric data. It specifies absolute start time, relative end time, time zone, and details for multiple metrics including tags, name, limit, and aggregators.

```json
{
   "start_absolute": 1357023600000,
   "end_relative": {
       "value": "5",
       "unit": "days"
   },
   "time_zone": "Asia/Kabul",
   "metrics": [
       {
           "tags": {
               "host": ["foo", "foo2"],
               "customer": ["bar"]
           },
           "name": "abc.123",
           "limit": 10000,
           "aggregators": [
               {
                   "name": "sum",
                   "sampling": {
                       "value": 10,
                       "unit": "minutes"
                   }
               }
           ]
       },
       {
           "tags": {
               "host": ["foo", "foo2"],
               "customer": ["bar"]
           },
           "name": "xyz.123",
           "aggregators": [
               {
                   "name": "avg",
                   "sampling": {
                       "value": 10,
                       "unit": "minutes"
                   }
               }
           ]
       }
   ]
}

```
Tokens:
Raw