Skip to content

Guance Docs

API Documentation

中文
English

Initializing search

Learn More GET STARTED

Guance Docs

Release Notes
Release Notes
- 2024
- 2023
- 2022
- 2021
- 2020
- 2019
Getting Started
Features
Features
- Concepts
- Customer Value
Plans
Plans
- Commercial Plan Registration
  Commercial Plan Registration
  - Register Commercial Plan from the Official Website
  - Register Commercial Plan from Cloud Vendors
    Register Commercial Plan from Cloud Vendors
    
    Activate on Alibaba Cloud Marketplace
    
    Activate on Alibaba Cloud Overseas Marketplace
    
    Activate Exclusive Plan on Alibaba Cloud Marketplace
    
    Activate on AWS Marketplace
    
    Purchase on Huawei Cloud Store
    
    Purchase on Microsoft Azure Store
- Free Plan Registration
- Private Cloud Deployment Plan
Getting Started
Getting Started
- Dashboards
- Monitors
Billing Method
Billing Method
DataKit
DataKit
- Changelog
  Changelog
  - 2021~2024
- DataKit Installation
  DataKit Installation
  - Host Installation
  - Containers
    Containers
    
    Kubernetes
    
    Docker
    
    AWS ECS Fargate
    
    AWS EKS
  - Offline Installation
  - Batch Installation
- Using DataKit
  Using DataKit
  - Service Management
  - Status Management
  - Update
  - DQL Query
  - Other Commands
  - Trouble Shooting
    Trouble Shooting
    
    No data collected
    
    Bug report
    
    Datakit Metrics
  - Virtual Internet Access
    Virtual Internet Access
    
    Alibaba Cloud
  - Performance
- DataKit Configuration
  DataKit Configuration
  - Major Configuration
  - Collector Configuration
  - Election Configuration
  - Proxy Configuration
  - Operator Configuration
  - Other Configurations
    Other Configurations
    
    Configuration Overview
    
    DCA
    
    Git
    
    Configuration Support
- DataKit Development
  DataKit Development
  - HTTP API
  - Documentation
Integrations
Platform Advantages
Basic Components
Basic Components
- Explorer
  Explorer
  - Search
  - Filter
  - Time Widget
  - Analysis
  - Columns
- Snapshot
  Snapshot
  - Save Snapshot
  - Share Snapshot
Guance AI
Pipelines
Pipelines
- Manage Pipelines
- Pipeline Manual
  Pipeline Manual
  - Quick start
  - Basics and principles
    
    Basics and principles
    
    Data processing of each data category
    
    Grok pattern
  - Platypus Grammar
  - Built-in function
  - Additional features
    Additional features
    
    Reference Table
    
    Offload
  - Performance benchmarks and optimizations
Key Capabilities
Use Cases
Use Cases
- Dashboard
  Dashboard
- Visual Charts
  Visual Charts
  - Chart Types
    Chart Types
    
    Time Series
    
    Bar Chart
    
    Pie Chart
    
    Overview Chart
    
    Top List
    
    Table Chart
    
    China Map
    
    World Map
    
    Scatter Plot
    
    Bubble Chart
    
    Histogram
    
    Treemap
    
    Cellular Map
    
    Heatmap
    
    Topology Map
    
    SLO
    
    Dashboard
    
    Funnel Chart
    
    Sankey Diagram
    
    Log Stream
    
    Object List
    
    Alert Statistics
    
    Monitor Summary
    
    Text
    
    Video
    
    Picture
    
    Command Panel
    
    IFrame
  - Chart Configuration
  - Chart Queries
    
    Chart Queries
    
    Simple Query
    
    Expression Query
    
    DQL Query
    
    PromQL Query
    
    Data Source Query
  - Chart JSON
  - Chart Links
    
    Chart Links
    
    Default Link
    
    Custom Link
    
    Use Case Examples
  - Event Association
- View Variables
- Scheduled Reports
- Notes
- Explorer
  Explorer
- Built-in Views
  Built-in Views
  - Bind Built-in View
- FAQ
Metrics
Metrics
Logs
Logs
- Log Collection
- Browser Log Collection
- Miniapp Log Collection
- Log Explorer
  Log Explorer
  - Log List
  - Log Details
- BPF Network Logs
- Error Tracing
- Log Index
  Log Index
- Cross-Workspace Index Query
- FAQ
Monitoring
Monitoring
- Monitor
  Monitor
- Intelligent Monitoring
  Intelligent Monitoring
- SLO
- Mute Management
- Alert Strategies
  Alert Strategies
  - Rules List
- Notification Targets
  Notification Targets
- Aggregated Alert Notification Templates
- Custom Event Notification Templates
- Internal Principles of Monitors
- Frequently Asked Questions
Incidents
Incidents
- Create Issue
- Manage Issue
- Analysis Board
- Calendar
- Configuration Management
  Configuration Management
Infrastructure
Infrastructure
- Data Collection
- HOSTs
- CONTAINERS
  CONTAINERS
  - Types
    
    Types
    
    Containers
    
    Kubernetes
    
    Kubernetes
    
    Pods
    
    Services
    
    Deployments
    
    Nodes
    
    Replica Sets
    
    Jobs
    
    Cron Jobs
    
    Daemonset
    
    Statefulset
    
    Persistent Volumes
    
    PVC
  - Analysis Dashboard
- Processes
- DATABASEs
- NETWORKs
- Resource Catalog
  Resource Catalog
  - Data Reporting
APM
APM
- Data Collection
  Data Collection
- Service Management
  Service Management
- Overview
- Explorer
  Explorer
  - Manual Installation
    Manual Installation
    
    Deploy on Host
    
    Deploy on Kubernetes
  - Auto Injection
    Auto Injection
    
    Deployment on Host
    
    Deployment on Kubernetes
    Deployment on Kubernetes
    
    Install Datakit Operator
    
    Install Helm
  - Explorers
    
    Explorers
    
    List
    
    Detail Page
- Error Tracking
- Profiling
- FAQ
RUM PV
RUM PV
- Web
  Web
  - Change Log
  - Application Integration
  - Application Data Collection
  - Custom RUM SDK Data Content Collection
    
    Custom RUM SDK Data Content Collection
    
    Custom User Identifier
    
    Custom Addition of Extra Data TAGs
    
    Custom Addition of Actions
    
    Custom Addition of Errors
  - How to Configure RUM Sampling
  - Actions
  - FAQ
- Miniapp
  Miniapp
  - Change Log
  - App Integration
  - Integration of Mini Programs Based on Uniapp Development Framework
  - Application Data Collection
  - Custom RUM SDK Data Collection Content
    
    Custom RUM SDK Data Collection Content
    
    Custom User Identifier
    
    Custom Addition of Extra Data TAG
    
    Custom Addition of Action
    
    Custom Addition of Error
- Android
  Android
- iOS/tvOS
  iOS/tvOS
- React Native
  React Native
- Flutter
  Flutter
- UniApp
  UniApp
- macOS
  macOS
  - App Access
  - App Data Collection
- C++
  C++
  - App Access
  - App Data Collection
- Unity
  Unity
  - App Access
- Explorers
  Explorers
  - Session
  - View
  - Resource
  - Action
  - Long Task
  - Error
- Application Analysis
- SESSION REPLAY
  SESSION REPLAY
  - Web
    
    Web
    
    How to Integrate Session Replay
    
    Troubleshooting
  - Mobile
    
    Mobile
    
    Android Session Replay
    
    iOS Session Replay
    
    React Native Session Replay
- User Analyses
  User Analyses
  - Session Heatmaps
  - Funnel Analysis
- RUM Data Access
- Self-tracking
- SourceMap
  SourceMap
Synthetic Tests
Synthetic Tests
- Test
  Test
  - Synthetic Tests
    
    Synthetic Tests
    
    HTTP
    
    ICMP
    
    TCP
    
    WEBSOCKET
  - Multi-step Test
- Overview
- Explorer
- User-defined Node Management
- FAQ
Event Center
Event Center
CI Visibility
CI Visibility
Cloud Billing Analysis
Data Security
Real Scenarios
Real Scenarios
Security Incident Management
Security Incident Management
- Arbiter
  Arbiter
  - Syntax
  - Built-in Functions
- Detection Rules
  Detection Rules
  - Create
  - Manage Rules
- Signals
- Execution Logs
Security Check
Security Check
Sensitive Data Scanning
Sensitive Data Scanning
- Scanning Rules
  Scanning Rules
  - Create
  - Official Rule Library
Open Capabilities
DataFlux Func (Automata)
DataFlux Func (Automata)
- DataFlux Func (Automata)
- External Data Sources
  External Data Sources
  - General Chart Data Return
    General Chart Data Return
    
    Line Chart
    
    Pie Chart
    
    Table Chart
  - Topology Graph Data Return
DQL
DQL
- DQL Query
- DQL Definition
- DQL Functions
- DQL Outer Functions
- DQL VS Other Query Languages
  DQL VS Other Query Languages
  - PromQL Quick Start
- Advanced Functions
  Advanced Functions
  - DBSCAN
  - How to Report Custom Advanced Functions for Local Func
- Rollup Functions
DCA
Custom Development
Custom Development
- Develop Custom Collector with Python
- Custom Scheck
  Custom Scheck
  - Implement Check for Changes in Sensitive Files
  - Monitor System User Changes
- Resource Catalog
OpenAPI
OpenAPI
- Public Request Parameters
- Public Response Structure
- Signature Authentication
- Usage Limitations
- Request Example
- Public Error Definitions
- Use Cases - Dashboard
  Use Cases - Dashboard
- Use Cases - Notes
  Use Cases - Notes
  - List
  - Get
  - Delete
  - Export
  - Import
  - Create
  - Modify
- Use Cases - Explorers
  Use Cases - Explorers
  - List
  - Get
  - Delete
  - Export
  - Create
  - Modify
  - Import
- Use Cases - Built-in Views
  Use Cases - Built-in Views
- Use Cases - Service Management
  Use Cases - Service Management
- Events
  Events
- Incident - Channels
  Incident - Channels
  - List
  - Create
  - Modify
  - Delete
  - Subscribe
- Incident - Issues
  Incident - Issues
- Incident - Schedules
  Incident - Schedules
  - List
  - Get
  - Create
  - Modify
  - Delete
- Incident - Configuration Management - Notification Policies
  Incident - Configuration Management - Notification Policies
  - List
  - Get
  - Add
  - Modify
  - Delete
- Incident - Configuration Management - Issue Discovery
  Incident - Configuration Management - Issue Discovery
- Infrastructure
  Infrastructure
  - Get all labels
  - Modify host labels
- Infrastructure - Resource Catalogs
  Infrastructure - Resource Catalogs
- LOG - Pattern Queries
  LOG - Pattern Queries
  - Get query task results
  - Send a query task
- LOG - Indexes
  LOG - Indexes
- LOG - Data Forwarding
  LOG - Data Forwarding
  - List
  - Get
  - Create
  - Modify
  - Delete
- LOG - Data Access
  LOG - Data Access
  - List
  - Get
  - Create
  - Modify
  - Enable/Disable
  - Delete
- Metrics - Retrieve Measurement Information
  Metrics - Retrieve Measurement Information
  - 【Measurement】Metrics and Labels Information Acquisition
- Metrics - Aggregate to Generate Metrics
  Metrics - Aggregate to Generate Metrics
  - List
  - Create
  - Get
  - Modify
  - Disable/Enable
  - Delete
- RUM PV - Applications
  RUM PV - Applications
- RUM PV - SourceMaps
  RUM PV - SourceMaps
- Synthetic Tests - Testing Tasks
  Synthetic Tests - Testing Tasks
- Synthetic Tests - Self-built Nodes Management
  Synthetic Tests - Self-built Nodes Management
  - List
  - Get
  - Delete
  - Create
- Monitoring - Checkers
  Monitoring - Checkers
- Monitoring - SLO
  Monitoring - SLO
  - Create
  - Get
  - List
  - Modify
  - Delete
  - Batch Delete
  - Disable/Enable
  - Batch Disable/Enable
- Monitoring - Intelligent Inspections
  Monitoring - Intelligent Inspections
  - List
  - Get
  - Create
  - Modify
  - Disable
  - Enable
  - Delete
  - Batch Delete
- Monitoring - Mute Configurations
  Monitoring - Mute Configurations
  - List
  - Create
  - Modify
  - Disable
  - Enable
  - Delete
- Monitoring - Alert Strategies
  Monitoring - Alert Strategies
  - List
  - Create
  - Create v2
  - Get
  - Modify
  - Modify v2
  - Delete
- Monitoring - Alert Strategies - Custom Notification Dates
  Monitoring - Alert Strategies - Custom Notification Dates
  - List
  - Create
  - Get
  - Modify
  - Delete
- Monitoring - Notification Targets
  Monitoring - Notification Targets
  - List
  - Create
  - Get
  - Modify
  - Delete
  - Batch Delete
- Management - Field Management
  Management - Field Management
  - List
  - Get
  - Add
  - Modify
  - Delete
- Management - Global Tags
  Management - Global Tags
  - List
  - Get
  - Create
  - Modify
  - Delete
- Management - Member Management
  Management - Member Management
- Management - Member Management - Role Permissions
  Management - Member Management - Role Permissions
  - List permission information
- Management - Member Management - Team Management
  Management - Member Management - Team Management
  - List
  - Get
  - Delete
  - Create
  - Modify
- Management - Member Management - SSO Management
  Management - Member Management - SSO Management
- Management - Member Management - SSO Management - Custom Mapping Rules (Deployment Plan)
  Management - Member Management - SSO Management - Custom Mapping Rules (Deployment Plan)
- Management - Role Management
  Management - Role Management
  - List
  - Get
  - Create
  - Modify
  - Delete
- Management - API Key Management
  Management - API Key Management
  - List
  - Get
  - Delete
  - Create
- Management - Blacklists
  Management - Blacklists
  - List
  - Get
  - Create
  - Modify
  - Delete
  - Import
  - Export
- Management - Pipelines
  Management - Pipelines
  - List
  - Create
  - Get
  - Modify
  - Delete
  - Enable/Disable
  - Import
  - Export
- Management - Data Access
  Management - Data Access
  - List
  - Get
  - Create
  - Modify
  - Delete
  - Disable/Enable
- Management - Sensitive Data Masking
  Management - Sensitive Data Masking
  - List
  - Get
  - Create
  - Modify
  - Enable/Disable
  - Delete
- Workspaces
  Workspaces
- Workspaces - Attribute Claims
  Workspaces - Attribute Claims
  - Get
  - Modify
- Snapshot Management
  Snapshot Management
- DQL Data Query
  DQL Data Query
- Func Functions
  Func Functions
  - List
  - Execute external functions
- Billing Analysis
  Billing Analysis
- Login-Free Tokens
  Login-Free Tokens
  - Generate token
  - Revoke token
- Chart Images
  Chart Images
  - Get time series trend chart
API Documentation
API Documentation
- Change Log
- Terraform Integration
  Terraform Integration
  - Quick Start
  - Resource List
    Resource List
    
    Resources
    
    Data Sources
- Description of Built-in Roles
- Unrecovered Event Query
- Service Map Chart API
- Unit Description
- SourceMap Multi-part Upload
Management
Workspace Management
Workspace Management
- Settings
  Settings
  - Key Metrics
  - Customized Menu
- Attribute Claims
- Field Management
- Global Labels
- Environment Variables
- Member Management
  Member Management
  - Invite Members
- Role Management
  Role Management
  - Permission Lists
- API Key Management
  API Key Management
  - OpenAPI
- Client Token Management
- Blacklist
- Data Forwarding
  Data Forwarding
- Data Access
- Regular Expressions
- Cloud Account Management
- Audit Events
- Share Management
- Cross Workspace Authorization
- Sensitive Data Masking
- Space Management
- SSO Management
  SSO Management
  - SAML
    
    SAML
    
    Configuration examples
    Configuration examples
    
    Alibaba Cloud IDaaS
    
    Authing
    
    Azure AD
    
    IAM Identity Center
    
    Okta
    
    Keycloak
  - OIDC
  - Role mapping
  - Frequently asked questions
- MFA Management
- Support Center
  Support Center
- FAQ
Billing
Billing
- Billing
  Billing
- FAQ
  FAQ
  - Registration and Plans
  - Settlement and Billing
Billing Center
Billing Center
Private Deployment
Private Deployment
Private Deployment
- Release History
  Release History
  - 2024
  - 2023
  - 2022
- Deployment Plan Description
- Product Deployment
  Product Deployment
  - Pre-installation Reading
  - How to Apply for a License
  - Infrastructure Deployment
  - Start Installation
  - Activate Product
  - DataWay
    DataWay
    
    Version History
    
    DataWay Installation and Usage
    
    Data Routing
  - Deployment Solutions
    Deployment Solutions
    
    Cloud Infrastructure Deployment
    Cloud Infrastructure Deployment
    
    Resource and System Requirements
    
    Alibaba Cloud Deployment Manual
    
    Huawei Cloud Deployment Manual
    
    Self-built Infrastructure Deployment
    Self-built Infrastructure Deployment
    
    Self-built Infrastructure Deployment Manual
    
    Resource and System Requirements
    
    Infrastructure Deployment
    Infrastructure Deployment
    
    Proxy
    
    NFS
    
    Ingress-Nginx
    
    Kubernetes Storage NFS
    
    Kubernetes Storage OpenEBS
    
    Kubernetes
    
    MySQL
    
    Log Engine
    
    Doris
    
    OpenSearch High Availability
    
    Time Series Engine
    
    Redis
    
    Helm
    
    Application Image Acquisition
    
    Offline Environment Deployment
    Offline Environment Deployment
    
    Deployment Environment Description
    Deployment Environment Description
    
    Offline Image Description
    
    Basic Components
    Basic Components
    
    Kubernetes Deployment
    
    Application Middleware
    Application Middleware
    
    MySQL
    
    Redis
    
    OpenSearch
    
    Business Components
    Business Components
    
    Launcher
    
    Proxy
    
    Single-machine Environment Deployment
    Single-machine Environment Deployment
    
    Resource and System Requirements
    
    Offline Deployment
- Getting Started
  Getting Started
  - How to Start
  - Upgrade Commercial Plan
  - SSO Management
    SSO Management
    
    Keycloak Single Sign-On (Deployment Plan)
    
    Configure Keycloak SSO Mapping Rules
    
    Azure AD Single Sign-On (Deployment Plan)
    
    Custom Mapping
    
    LDAP Single Sign-On
    
    OIDC Single Sign-On Custom Domain Replacement Steps (Deployment Plan URL Address Replacement Solution)
  - Management Backend Manual
    Management Backend Manual
    
    Workspace Management
    
    User Management
    
    Menu Management
    
    Template Management
    
    Field Management
    
    Settings Management
- Operations Manual
  Operations Manual
  - Deployment Configuration Manual
    Deployment Configuration Manual
    
    Application Service Configuration Guide
    
    Enable Self-Observability
    
    Modify Domain Access to IP Access
    
    Configure Email Service
    
    Switch Domain
    
    Switch Log Engine
    
    Switch Time Series Engine
    
    Switch Dial Testing Center
    
    Huawei Cloud Change OpenSearch Disk Type
    
    Configure Data Forwarding
    
    Offline Environment Template Update
    
    Manage Workspace Index Configuration
    
    Embed Pages via iframe
    
    Guance Cluster Backup and Restore
    
    Reliability Verification
    
    Customize Frontend Colors
    
    Customize Frontend Language
    
    Forgot Admin User Password in Backend Management
    
    Use Alibaba Cloud ECI for Elastic Scaling of Kodo-X
    
    Split Kodo-X
    
    Switch to HTTPS Access
  - Operations FAQ
    Operations FAQ
    
    Kubernetes Cluster
    
    Guance Base
    
    Doris
    
    GuanceDB
    
    OpenSearch
  - Usage FAQ
    Usage FAQ
    
    Explorer Reports "View Template Does Not Exist"
    
    Log Engine Storage Space Insufficient
    
    Monitor Troubleshooting
    
    Data Gap Troubleshooting
    
    Empty DataWay List in Integration
    
    Handling Data Write Delays
    
    Synthetic Tests Troubleshooting
    
    Created Dataway Not Visible on Frontend
    
    Error Creating Dial Testing Node
    
    Metrics Query Error
    
    Deployment Plan Kodo Version Expired
    
    Configure kodo-inner Query Concurrency
  - Upgrade Guance
  - Capacity Planning
    Capacity Planning
    
    Log Engine Capacity Planning
- Extended Usage
  Extended Usage
  - Metering Data Structure and Usage
ExternalAPI
ExternalAPI
- Public Request Parameters
- Public Response Structure
- Signature Authentication
- Front Accounts
  Front Accounts
  - List
  - Get
  - Create
  - Modify
  - Enable/Disable
  - Delete
  - Change brand identifier
- Backend Management Accounts
  Backend Management Accounts
  - List
  - Create
  - Get
  - Modify
  - Enable/Disable
  - Delete
- Workspace Members
  Workspace Members
- Workspace
  Workspace
- Workspace API Key
  Workspace API Key
  - Create
  - Obtain
  - Modify
  - List
  - Delete
  - Batch Delete
- Role Management
  Role Management
  - List
- Group Management
  Group Management
  - List
  - Create
  - Modify
  - Manage workspaces
  - Delete
- Data Queries
  Data Queries
  - DQL Data Query
- Login Mapping Rules
  Login Mapping Rules
- Scenes-Dashboards
  Scenes-Dashboards
  - Identifier Import
- APM
  APM
  - APM services list
  - Service Map
- DataKit List
  DataKit List
  - Online Datakit List
Other
Best Practices
Best Practices
- Cloud Native
  Cloud Native
- Cloud Platform Integration
  Cloud Platform Integration
- Monitoring
  Monitoring
  - Application Performance Monitoring (APM)
    Application Performance Monitoring (APM)
    
    Tracing
    Tracing
    
    SpringBoot3 WebFlux Observability Best Practices
    
    OpenTelemetry Operator Best Practices
    
    Distributed Tracing (APM) Best Practices
    
    Implementing Custom TraceId Using extract + TextMapAdapter
    
    DDtrace Custom Instrumentation
    
    JVM Observability Best Practices
    
    Achieving Trace Observability with GraalVM and Spring Native Projects
    
    JAVA OOM Exception Observability Best Practices
    
    Building Observability for Springcloud Services from Scratch Using Guance
    
    Skywalking Collecting JVM Observability Best Practices
    
    Injecting dd-java-agent Using datakit-operator
    
    Smart Use of Flame Graphs for Analyzing Trace Performance
    
    Best Practices for Observability Deployment of RuoYi Monolithic Applications on Tomcat
    
    Middleware
    Middleware
    
    Nginx Observability Best Practices
    
    Redis Observability Best Practices
    
    Kafka Observability Best Practices
    
    Insights into MySQL
    
    Performance Optimization (Profling)
    Performance Optimization (Profling)
    
    Optimizing Application Performance Using async-profiler
  - User Experience Monitoring (RUM)
    User Experience Monitoring (RUM)
    
    Web Application Monitoring (RUM) Best Practices
    
    RUM Data Reporting DataKit Cluster Best Practices
    
    Page Channel Traffic Acquisition Observability Best Practices
  - IT Infrastructure Monitoring (ITIM)
    IT Infrastructure Monitoring (ITIM)
    
    Host Observability Best Practices
    
    Prometheus System Data Ingestion Best Practices
    
    Ansible Batch Processing in Practice
  - Continuous Integration and Deployment (CI/CD)
    Continuous Integration and Deployment (CI/CD)
    
    Jenkins Observability Best Practices
    
    Gitlab-CI Observability Best Practices
  - Blockchain
    Blockchain
    
    Swarm Bee Observability Best Practices
    
    Chia Harvesters Best Practices for Assurance
- Insight
  Insight
Third-party Integration
Third-party Integration
- Command Line Interface
MOBILE
Agreements
Agreements

Overview¶

This section includes some public descriptions in Guance Open API / External API.

2025-06-04 2025-03-24

Feedback

Is this page helpful? ×

Product

Features
Pricing

Company

About Us

Contact us

+852 - 68424220
co-operation@guance.com

Follow us

© 2013-2025 Shanghai Futuroscope Information Technology Co., Ltd. . All Rights Reserved.