Torch Log Service
Torch Log Service
Torch Log Service
Document
Product News
Product Overview
Product Billing
User Guide
TLS Agent
AgentLoop
Resource management
Host group
Data collection
LogCollector collection
Introduction to LogCollector
Installation and upgrade
Collect host logs
Collect container logs
LogCollector plugins
Manage LogCollector
general reference
Data import
Cloud product log collection
TOS log collection
DBW log collection
VPN Log collection
VKE log collection
CLB log collection
CloudTrail log collection
CFW log collection
NTA log collection
ALB log collection
APMPlus log collection
veFaaS log collection
VPC log collection
veImageX log collection
TrafficRoute DNS log collection
DDoS log collection
WAF log collection
DCDN log collection
Multi-cloud security platform log collection
APIG log collection
Machine learning task log collection
CR log collection
Volcano Ark application lab log collection
FileNAS log collection
LLM Application Firewall Service log collection
vePFS log collection
Cloud security center log collection
EFS log collection
Data storage
Query and analysis
Configure log indexes
Query log
Analyze logs
Query and analyze logs using third-party tools
Associate external data source for log query
SQL function
SQL syntax
Visualization
Query and analysis charts
Summaries of query and analysis charts
Create dashboard
Use dashboard
Add dashboard filters and variables
Use other systems to analyze logs
Log application
Log applications for product observability
Log applications for large models observability
Coding Agent log app
ModelProvider log app
No-coding Agent log app
Log applications for basic service monitoring
Data processing
Data transformation
Syntax and functions
Global operation function
expression function
Data processing best practices
general reference
Data write processor
Data consumer processor
Data consumption and shipping
Ship logs to TOS
Ship logs to Kafka
Ship logs to Splunk
Alarm
Alarm policy
Alarm notification content
Alarm notification content template
alarm notification channel
Tracing service
Monitor Log Service
API reference
Project management API
Topic management API
Shard management API
Index management API
Log management API
Host group management API
Collection configuration management API
Data import API
Data processor API
Data transformation API
Data backflow API
SQL analysis API
Alarm management API
Consumer group management API
Kafka protocol consumption API
Tag management API
Trace storage API
Account management API
SDK reference
Go SDK
Java SDK
Python SDK
iOS SDK
C++ SDK
CLI reference
Best practices
Data collection
Query and analysis
permission management
Consumption and delivery
Visualization
Alarm
FAQs
Billing and cost FAQ
Data collection FAQ
Data storage FAQ
Index configuration FAQ
Query and analysis FAQ
Scheduled SQL tasks FAQ
Alarm FAQ
- Documentation
Torch Log ServiceUser GuideVisualizationUse dashboardDashboard JSON Model description
Copy page
Download PDFUse dashboard
Dashboard JSON Model description
Copy pageDownload PDFDashboard JSON Model description
Each dashboard has a corresponding JSON script. You can quickly copy a new dashboard using the JSON script. You can click the Settings icon on dashboard page first. Then, in the JSON Model tab view the dashboard JSON script or download it as a file.
This topic explains the dashboard JSON Model format and provides detailed field descriptions.
JSON Model Format
{
"DashboardId": "320eb084-d7fb-4ee0-a86c-93f04bb002b2",
"DashboardName": "test",
"Description": "",
"Filters": [
{
"FilterName": "alb-id",
"FilterType": "VARIABLE",
"FilterKey": "id",
"FilterKeyAlias": "",
"StaticSearch": [],
"DynamicSearch": {
"TopicId": "eb234d44-caec-461a-b902-cbe003d9ef73",
"Query": "* | select aaaa as id group by 1",
"StartTime": "now-1d",
"EndTime": "now"
},
"TopicFilter": null
}
],
"ChartPanels": [
{
"ChartId": "f6d139cc58fff1716447417150",
"ChartName": "QPS",
"ChartType": "Line",
"Display": {
"version": 2,
"layout": {
"lg": {
"w": 8,
"h": 8,
"x": 0,
"y": 0
}
},
"setup": {
"x": "time",
"y": {
"ySelectorModel": "white",
"whiteList": ["QPS"]
},
"timescale": true,
"maxCategoryNum": 50,
"chartName": "QPS",
"showChartName": true,
"showChartTime": true,
"version": 3
},
"fieldConfig": {
"items": [],
"version": 2
},
"actions": {
"items": [],
"version": 1
},
"hideInRow": false,
"transformations": {
"version": 1,
"transformations": []
}
},
"SearchInfo": {
"StartTime": "now-1d",
"EndTime": "now",
"SearchOnTime": false,
"SearchTopicInfos": [
{
"TopicId": "eb234d44-caec-461a-b902-cbe003d9ef73",
"Query": "* | select DATE_TRUNC('second', __time__/1000) as time, count(1) as QPS where aaaa = '${{id}}' group by 1",
"DataSourceName": "A"
}
]
},
"Description": ""
}
],
"MetaInfo": {
"GridVersion": 2
}
}
JSON Model Description
Field name | Field type | Required | Field description |
Field name | Field type | Required | Field description |
DashboardId | string | Yes | The dashboard’s unique identifier. It is used to identify a specific dashboard. |
DashboardName | string | Yes | The name of the dashboard. It displayed as the dashboard title in the interface. |
Description | string | No | Custom dashboard description. It is used to explain the purpose or content of the dashboard. |
Filters | Yes | Filter configuration array. It includes filters such as dashboard-level conditions. | |
ChartPanels | Yes | Chart panel array. It includes configuration details for all chart components in the dashboard. | |
MetaInfo | Yes | Dashboard metadata. It includes version and layout configurations. |
IDaoChartFilter
Field name | Field type | Required | Field description |
Field name | Field type | Required | Field description |
DynamicSearch | No | Dynamic search configuration. It used for fetching filter options dynamically. | |
FilterKey | string | No | Key name of the filter field, specifies the log field to filter. |
FilterKeyAlias | string | No | Alias for the filter field. It is used as the display name on the interface. |
FilterLogic | FilterLogic | No | Filtering logic.
|
FilterName | string | Yes | Display name of the filter. |
FilterType | FilterType | Yes | Type of filter.
|
MultiChoice | boolean | No | Supports multiple selection. |
StaticSearch | No | Optional configuration for static search; a predefined list of options. | |
TopicFilter | No | Topic filter configuration. It is used as a parameter for the data source filter. |
IDaoSearchInfo
Field name | Field type | Yes | Field description |
Field name | Field type | Yes | Field description |
EndTime | string | Yes | Specify the query end time. |
Query | string | Yes | Query statement. |
SearchOnTime | boolean | No | Query based on time. |
StartTime | string | Yes | Query start time. |
TopicId | string | Yes | Topic ID. |
PanelJsonModel
Field name | Field type | Required | Field description |
Field name | Field type | Required | Field description |
ChartId | string | Yes | The unique identifier of the chart. |
ChartName | string | Yes | The name of the chart. |
ChartType | string | Yes | Chart types, such as bar charts, line charts, and others. |
Description | string | No | Chart description information. |
SearchInfo | No | Search configuration information for charts. | |
Display | Yes | Chart display configuration. It includes version, layout, settings, and other information. |
DisplayConfig
Field name | Field type | Required | Field description |
Field name | Field type | Required | Field description |
version | number | Yes | Displays configuration version number. |
layout | Yes | Layout configuration | |
setup | Record<string, any> | No | Configuration settings of chart; specified configuration parameters of storage charts. |
fieldConfig | Record<string, any> | No | Field settings. It defines how chart fields are displayed. |
actions | Record<string, any> | No | Action settings. It defines chart drill-down event. |
hideInRow | boolean | No | Hide in row group. It used to control the display status of charts when the group collapsed. |
transformations | No | Data conversion configuration. It defines processing and transformation rules for raw data. |
TransformationMangerForStorage
Field name | Field type | Required | Field description |
Field name | Field type | Required | Field description |
version | number | Yes | Conversion configuration version number. The current version is version 1. |
transformations | Yes | Transformation rule array. The conversion operations are performed in order. |
TransformationItem
Field name | Field type | Required | Field description |
Field name | Field type | Required | Field description |
type | string | Yes | Conversion type, such as "GroupingToMatrix" or "Fallback". |
disabled | boolean | Yes | Disable this conversion rule? |
GridPos
Field name | Field type | Required | Field description |
Field name | Field type | Required | Field description |
w | number | Yes | Layout width. It is calculated in grid units. |
h | number | Yes | Layout height. It is measured in grid units. |
x | number | Yes | Layout horizontal position. It is the grid units from the left. |
y | number | Yes | Vertical grid position. It is the grid units from the top. |
MetaInfo
Field name | Field type | Required | Field description |
Field name | Field type | Required | Field description |
GridVersion | number | Yes | Grid version number. It used for layout system version control and compatibility. |
IDaoChartSearchInfo
Field name | Field type | Required | Field description |
Field name | Field type | Required | Field description |
EndTime | string | Yes | Query end time. Supports relative time format (such as now) and absolute time. |
Query | string | No | Query statement. It is SQL or query statement. |
SearchOnTime | boolean | No | Specifies query based on time. It determines the time range for query. |
SearchTopicInfos | No | Array of topic information for searching; supports queries across multiple data sources. | |
StartTime | string | Yes | Query start time. Both relative time and absolute time formats are supported. |
TopicId | string | No | Log topic ID. |
IDaoSearchTopicInfos
Field name | Field type | Required | Field description |
Field name | Field type | Required | Field description |
DataSourceName | string | No | Data source name. It is used to distinguish different data sources. |
Query | string | Yes | Query statement. It is the query statement for a specific topic. |
TopicId | string | Yes | Log topic ID. |
IDaoSelectKey
Field name | Field type | Required | Field description |
Field name | Field type | Required | Field description |
Alias | string | No | Option alias. The name displayed in the interface. |
Name | string | Yes | The name of option; the actual value. |
Selected | boolean | Yes | Indicates whether the option is selected by default. |
IDaoTopicFilter
Field name | Field type | Required | Field description |
Field name | Field type | Required | Field description |
Regex | string | No | The topic pattern of regex matches. It is employed when TopicType is REGEX. |
Selected | string | No | Default selected topic ID. If no ID is entered, it is left empty. |
TopicType | TopicType | Yes | Log topic type. It determines how to select log topics.
|
Topics | string | No | Specified topic ID list. It is used when TopicType is TOPICS. |
Chart type
Field value | Field description |
Field value | Field description |
SingleValue | Single value chart |
Pie | Pie chart |
Table | Table |
Line | Line chart |
Histogram | Bar chart |
ChinaMap | The map of China. |
WorldMap | World map |
Row | Row layout |
CrossTable | Crosstab |
Statistical | Statistical charts |
Timeline | Timeline chart |
HistogramV2 | Bar chart (V2) |
HeatMap | Heat map |
Progress | Progress chart |
TreeMap | Tree chart |
Gauge | Dashboard |
Flow | Flowchart |
Radar | Radar chart |
Text | Text |
Funnel | Funnel chart |
Scatter | Scatter diagram |
Sankey | Sankey diagram |
Topology | Topology map |
Fallback | Fallback chart (for exceptions) |
WordCloud | Word cloud chart |
Last updated: 2026.06.09 11:29:07
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
