Monitor
Currently, CnosDB metrics can be collected by Prometheus or stored on CnosDB.
If you would like to see more metrics supported by CnosDB, please send an ISSUE to the repository.
Data Node Monitor Metrics
VNODE_DISK_STORAGE
Name
vnode_disk_storage
Category
Gauge
Description
The disk that the Vnode occupies.
Tag
| Field | Description |
|---|---|
| DATABASE | Database vnode belongs to |
| NODE_ID | ID of data node |
| TENANT | tenant vnode belongs to |
| VNODE_ID | ID of Vnode |
| VALUE | Disk that the Vnode occupies in bytes |
VNODE_CACHE_SIZE
Name
vnode_cache_size
Category
Gauge
Description
The cache size that vnode occupies in bytes.
Tag
| Field | Description |
|---|---|
| DATABASE | Database vnode belongs to |
| NODE_ID | ID of data node |
| TENANT | tenant vnode belongs to |
| VNODE_ID | ID of Vnode |
| VALUE | Cache that the Vnode occupies in bytes |
HTTP_DATA_IN
Name
http_data_in
Category
Count
Description
Data traffic written over http, excluding SQL.
Tag
| Field | Description |
|---|---|
| TIME | Time of record |
| DATABASE | Database name |
| NODE_ID | ID of data node |
| TENANT | Tenant name the database belongs to |
| VALUE | The total write traffic in Bytes |
HTTP_DATA_OUT
Name
http_data_out
Category
Count
Description
The size of the Http return data
Tag
| Field | Description |
|---|---|
| TIME | Time of record |
| DATABASE | Database name |
| NODE_ID | ID of data node |
| TENANT | Tenant name the database belongs to |
| Database | Database name |
| User | User name |
| VALUE | The total size of the read traffic in Bytes |
HTTP_QUERIES
Name
http_queries
Category
Count
Description
This metric keeps track of the number of Http queries a user makes.
Tag
| Field | Description |
|---|---|
| TIME | Time of record |
| DATABASE | Database name |
| NODE_ID | ID of data node |
| TENANT | Tenant name the database belongs to |
| USER | User name |
| VALUE | Query times |
HTTP_WRITES
Name
http_writes
Category
Count
Description
This metric records the number of times a user writes via Http.
Tag
| Field | Description |
|---|---|
| TIME | Time of record |
| DATABASE | Database name |
| NODE_ID | ID of data node |
| TENANT | Tenant name the database belongs to |
| USER | User name |
| VALUE | User write times |
HTTP_QUERY_DURATION
Name
http_query_duration
Category
Histogram
Description
Time spent querying through the Http interface.
Tag
| Field | Description |
|---|---|
| TIME | Time of record |
| DATABASE | Database name |
| NODE_ID | ID of data node |
| TENANT | Tenant name the database belongs to |
| USER | User name |
| LE | Less than this time, in ms |
| VALUE | Times |
HTTP_WRITE_DURATION
Name
http_write_duration
Category
Histogram
Description
Time taken to write through the Http interface.
Tag
| Field | Description |
|---|---|
| TIME | Time of record |
| DATABASE | Database name |
| NODE_ID | ID of data node |
| TENANT | Tenant name the database belongs to |
| USER | User name |
| LE | Less than this time, in ms |
| VALUE | Times |
COORD_DATA_IN
Name
coord_data_in
Category
Count
Description
Total size of the data accepted by the Coordinator when the data is written to the database.
Tag
| Field | Description |
|---|---|
| TIME | Time of record |
| DATABASE | Database name |
| NODE_ID | ID of data node |
| TENANT | Tenant name the database belongs to |
| VALUE | Data size in bytes |
COORD_DATA_OUT
Name
coord_data_out
Category
Count
Description
Total size of the data sent by the Coordinator when the data is read out of the database.
Tag
| Field | Description |
|---|---|
| TIME | Time of record |
| DATABASE | Database name |
| NODE_ID | ID of data node |
| TENANT | Tenant name the database belongs to |
| VALUE | Data size in bytes |
COORD_QUERIES
Name
coord_queries
Category
Count
Description
The number of times the data passes through the Coordinator during the query.
Tag
| Field | Description |
|---|---|
| TIME | Time of record |
| DATABASE | Database name |
| NODE_ID | ID of data node |
| TENANT | Tenant name the database belongs to |
| VALUE | Times |
COORD_WRITES
Name
coord_writes
Category
Count
Description
The number of times the data passes through the Coordinator during writing.
Tag
| Field | Description |
|---|---|
| TIME | Time of record |
| DATABASE | Database name |
| NODE_ID | ID of data node |
| TENANT | Tenant name the database belongs to |
| VALUE | Times |
SQL_DATA_IN
Name
sql_data_in
Category
Count
Description
The size of the data written via sql, including INSERT, COPY statements
Tag
| Field | Description |
|---|---|
| TIME | Time of record |
| DATABASE | Database name |
| NODE_ID | ID of data node |
| TENANT | Tenant name the database belongs to |
| VALUE | Data size in bytes |
HTTP_FLOW
Name
http_flow
Category
Count
Description
The sum of request body and response body accessed through the HTTP protocol
Tag
| Field | Description |
|---|---|
| time | Time of record |
| api | API name |
| host | Node's IP address |
| node_id | Node ID |
| value | Data size in bytes |
HTTP_RESPONSE_TIME
Name
http_response_time
Category
Histogram
Description
Time consumed by accessing via the HTTP protocol
Tag
| Field | Description |
|---|---|
| time | Time of record |
| api | API name |
| host | Node's IP address |
| le | Less than this time, in ms |
| node_id | Node ID |
| value | Times |
Meta Node Monitor Metrics
READ_META_COUNT
Name
read_meta_count
Category
Count
Description
Number of times meta is read
Tag
| Field | Description |
|---|---|
| time | Time of record |
| addr | Meta service address |
| node_id | Visit the node id of meta |
| value | Number of Reads |
READ_META_RESPONSE_TIME
Name
read_meta_response_time
Category
Histogram
Description
Time spent reading meta
Tag
| Field | Description |
|---|---|
| time | Time of record |
| addr | Meta service address |
| node_id | Visit the node id of meta |
| le | Less than this time, in ms |
| value | Times |
WRITE_META_COUNT
Name
write_meta_count
Category
Count
Description
Number of times meta is written
Tag
| Field | Description |
|---|---|
| time | Time of record |
| addr | Meta service address |
| node_id | Visit the node id of meta |
| value | Number of written |
WRITE_META_RESPONSE_TIME
Name
write_meta_response_time
Category
Histogram
Description
Time spent writing meta
Tag
| Field | Description |
|---|---|
| time | Time of record |
| addr | Meta service address |
| node_id | Visit the node id of meta |
| le | Less than this time, in ms |
| value | Times |
WATCH_META_COUNT
Name
watch_meta_count
Category
Count
Description
Number of times meta is read
Tag
| Field | Description |
|---|---|
| time | Time of record |
| addr | Meta service address |
| node_id | Visit the node id of meta |
| value | Visits |
WATCH_META_RESPONSE_TIME
Name
watch_meta_response_time
Category
Histogram
Description
Time spent accessing meta
Tag
| Field | Description |
|---|---|
| time | Time of record |
| addr | Meta service address |
| node_id | Visit the node id of meta |
| le | Less than this time, in ms |
| value | Times |
Prometheus Monitor
Just add Job at the Prometheus configuration file.
scrape_configs:
# The job name is added as a label `job=<job_name>` to any timeseries scraped from this config.
- job_name: 'cnosdb'
static_configs:
- targets: [ '127.0.0.1:8902' ]
Parameter Description
targets is the adderss of CnosDB Http.
Store to CnosDB
Change the store_metrics in config to true.