Datakit acts as an API server for local data acquisition

summary

When users need to collect a large number of indicators of different technology stacks at the same time 、 Log or link data, or you want to use it in other platforms or applications  DataKit  Data collected and reported ,Datakit  It provides users with a command-line interactive mode for fast data query “DQL Inquire about ” Also provides  API  Form to use  DataKit  Of the data collected  “DataKit API”.

This guide can introduce you to  DataKit  Provided by the  “DQL Inquire about ” and  "DataKit API"  Use .

precondition

You need to create a

Observation cloud account

, And on your host

install  DataKit

.

Interactive model data query  “DQL Inquire about ”

DataKit  Supports interactive execution  DQL  Inquire about , In interactive mode ,DataKit  Self contained statement completion function ：

datakit --dql #  perhaps  datakit -Q
dql > cpu limit 1
-----------------[1.cpu ]-----------------
 cpu 'cpu-total'
 host'tan-air.local'
 time2022-01-13 16:06:03 +0800 CST
 usage_irq 0
 usage_idle 56.928839
 usage_nice 0
 usage_user 19.825218
 usage_guest 0
 usage_steal 0
 usage_total 43.071161
 usage_iowait 0
 usage_system 23.245943
 usage_softirq 0
usage_guest_nice 0
---------
1 rows, cost 13.55119ms

Single execution  DQL  Inquire about

DataKit  It supports running a single  DQL  Query function of statement ：

#  Execute one query statement at a time
datakit --run-dql 'cpu limit 1'


#  Write the execution result to  CSV  file
datakit --run-dql 'O::HOST:(os, message)' --csv="path/to/your.csv"


#  Force overwrite existing  CSV  file
datakit --run-dql 'O::HOST:(os, message)' --csv /path/to/xxx.csv --force


#  Write results to  CSV  At the same time , Query results are also displayed on the terminal
datakit --run-dql 'O::HOST:(os, message)' --csv="path/to/your.csv" --vvv

Derived  CSV  File style example ：

name,active,available,available_percent,free,host,time
mem,2016870400,2079637504,24.210166931152344,80498688,achen.local,1635242524385
mem,2007961600,2032476160,23.661136627197266,30900224,achen.local,1635242534385
mem,2014437376,2077097984,24.18060302734375,73502720,achen.local,1635242544382

DQL Query results JSON turn

DQL The query result of can be directly expressed as  JSON  Output results in form , but  JSON  In mode , No statistics will be output , For example, return the number of rows 、 Time consumption, etc （ In order to make sure  JSON  Directly resolvable ）

datakit --run-dql 'O::HOST:(os, message)' --json
datakit -Q --json


#  If the field value is  JSON  character string , Then do it automatically  JSON  beautify （ Be careful ：JSON  In mode （ namely  --json）,`--auto-json`  Invalid option ）
datakit --run-dql 'O::HOST:(os, message)' --auto-json
-----------------[ r1.HOST.s1 ]-----------------
message ----- json ----- # JSON  There are obvious signs at the beginning , here  message  For field name
{
 "host":{
 "meta":{
 "host_name":"www",
 .... #  Long text is omitted here
 "config":{
 "ip":"10.100.64.120",
 "enable_dca": false,
 "http_listen":"localhost:9529",
 "api_token":"tkn_f2b9920f05d84d6bb5b14d9d39db1dd3"
 }
}
----- end of json ----- # JSON  There are obvious signs at the end
 os 'darwin'
 time2022-01-13 16:56:22 +0800 CST
---------
8 rows, 1 series, cost 4ms

Querying data for a specific workspace

DQL Queries can be made by specifying different  Token  To query data from other workspaces ：

datakit --run-dql 'O::HOST:(os, message)' --token <your-token>
datakit -Q --token <your-token>

DataKit API

DataKit  With  JSON  The data type is... Of the returned result ,Http API  The ability to provide data , Currently supported  API  Include

Write data

http://{DatakitIP}/v1/write/:category

category Support ： Log data 、 Indicator data 、 Object data 、 Custom object data 、RUM Data etc.

testing  Datakit  function

http://{DatakitIP}/v1/ping

View collector errors

http://{DatakitIP}/v1/lasterror

View workspace information

http://{DatakitIP}/v1/workspace

Data query

http://{DatakitIP}/v1/query/raw

Create or update an object's labels

http://{DatakitIP}/v1/object/labels | POST

Delete object's labels

http://{DatakitIP}/v1/object/labels | DELETE