Skip to content

Metering Data Structure and Usage

Overview

When data is written to a specific workspace, Guance will monitor and count the volume of data being written in real-time. It records and stores the statistical information in the database according to preset time intervals.

By combining DQL query statements, users can easily build a usage analysis dashboard. This dashboard provides intuitive insights into data usage trends, helping users optimize resource allocation and monitor data usage.

Data Structure

{
    "time": 1720584000000,
    "__docid": "fb4d3b817fdc08a266bfefe85049d279",
    "count": "0",
    "create_time": "1720591166343",
    "date": "1720584000000",
    "hour_count": "0",
    "project": "logging",
    "sub_project": "default",
    "workspaceUUID": "wksp_3c5cc6626cb64550b401347931fcf467"
}

Field Descriptions

Field Type Description Example
time int64 Metering item time, in ms, e.g., 1720584000000 is equivalent to 2024-07-10 12:00:00, indicating the time range for this metering item is 2024-07-10 12:00:00 ~ 2024-07-10 13:00:00 (left-closed, right-open) 1720584000000
date int64 Same as time
__docid string Unique identifier for a database record fb4d3b817fdc08a266bfefe85049d279
workspaceUUID string Workspace ID wksp_3c5cc6626cb64550b401347931fcf467
project string Metering project, see below for details logging
sub_project string Metering sub-project, see below for details default
count int64 Total metering 2345
hour_count int64 Hourly metering data 1234
create_time int64 Actual time the data was written to the database, in ms 1720591166343

Metering Project (project) Descriptions

Note⚠️: For total statistics, use count; for incremental statistics, use hour_count.

Statistic project sub_project Interval Method Description
Number of DataKits datakit Hourly Total DataKit usage in a specific workspace
Total DataKits across the site platform_datakit Hourly Total Represents the total DataKit usage across the entire site, independent of specific workspaces
Number of Tests synthetic_test_runs Hourly Incremental
RUM PV Count rum_pv Hourly Total
RUM Data Rows rum_data_rows Hourly Incremental Resource, Action, LongTask, Error counts
RUM Raw Write Volume rum_bytes Hourly Incremental
Trace Count tracing Hourly Incremental
Tracing Raw Write Volume tracing_bytes Hourly Incremental
Event Data Rows keyevent Hourly Total
Data Forwarding to Customer S3 Object Storage data_forwarding_s3_bytes Optional values: logging/tracing/rum, representing backup information for corresponding data types Hourly Incremental
Data Forwarding to Customer Message Engine data_forwarding_kafka_bytes Optional values: logging/tracing/rum, representing backup information for corresponding data types Hourly Incremental
Data Forwarding to Customer OSS Object Storage data_forwarding_oss_bytes Optional values: logging/tracing/rum, representing backup information for corresponding data types Hourly Incremental
Data Forwarding to Customer OBS Object Storage data_forwarding_obs_bytes Optional values: logging/tracing/rum, representing backup information for corresponding data types Hourly Incremental
Data Forwarding to Default Storage Capacity data_forwarding_default_bytes Optional values: logging/tracing/rum, representing backup information for corresponding data types Hourly Total
Data Forwarding to Default Storage Capacity (Incremental) data_forwarding_delta_bytes
Security Check Data Rows security Hourly Incremental
Scheduled Report Send Count report Every 5 minutes Incremental
Infrastructure Object Count object Hourly Total
Pipeline Data Processing Volume pipeline_processed_bytes Hourly Incremental
Sensitive Data Scan Volume sensitive_scan_bytes Hourly Incremental
Log Raw Write Volume logging_bytes Optional values: index names for multi-index logging Hourly Incremental
Log Data Rows logging Optional values: index names for multi-index logging Hourly Incremental
Time Series timeseries Hourly Total
Pipeline Volume Statistics pipeline_processed_bytes Hourly Incremental
Session Replay Count session_replay Hourly
Span Count tracing_span Hourly
Profile Count profile Hourly
SIEM Scan Volume siem_scan_bytes Hourly
Job Run Count job_runs Hourly
SMS Send Count sms Hourly
Network Host Count network Hourly

Metering Data Query

# Use DQL statements to view the log write volume for a specific workspace within a day

metering::`*`:(sum(hour_count)) {project="logging", workspaceUUID="wksp_xxx"}

Feedback

Is this page helpful? ×