Tencent Cloud Observability Platform
- Release Notes and Announcements
- Product Introduction
- Purchase Guide
- Application Performance Management
- Pay-as-you-go (Postpaid)
- Packages (Prepaid)
- Mobile App Performance Monitoring
- Real User Monitoring
- Cloud Automated Testing
- Prometheus Monitoring
- Pay-as-You-Go (Postpaid)
- Quick Start
- EventBridge
- Cloud Product Monitoring
- Tencent Cloud Service Metrics
- Microservice
- Networking
- TencentDB
- TencentDB for Redis Monitoring Metrics
- CPM
- CDN And EdgeOne
- Operation Guide
- Cloud Monitoring Overview
- Monitoring View
- CM Connection to Grafana
- Troubleshooting
- Application Performance Management
- Access Guide
- Accessing Go Application
- Accessing Java Application
- Accessing Python Application
- Accessing Node.js Application
- Accessing PHP Application
- Accessing .NET Application
- Operation Guide
- Resource Management
- Application Monitoring
- Application Diagnosis
- Database Call Monitoring
- Access Management
- Alarm Service
- System Configuration
- Associate Logs
- Inject TraceID Into Logs
- Practical Tutorial
- Parameter Information
- APM Data Protocol Standard
- Mobile App Performance Monitoring
- Access Guide
- Android Use Cases
- iOS Use Cases
- Tencent Cloud Real User Monitoring
- Operation Guide
- Application Management
- Access Management
- Resource Tag
- Connection Guide
- Web Use Cases
- Cloud Automated Testing
- Operation Guide
- Creating Test Task
- Testing Statistics
- Access Management
- References
- Testing Nodes
- FAQs
- Performance Testing Service
- Operation Guide
- Performance Testing in Script Mode
- Script Examples
- HTTP-based Performance Testing
- Performance Testing in JMeter Mode
- Project Management
- Scenario Management
- Advanced Configuration
- Export Stress Test Indicators
- Traffic Recording
- Performance Testing Report
- Access Control
- Alarm Management
- Tag Management
- Practice Tutorial
- JavaScript API List
- pts/http
- Response
- pts/dataset
- pts/grpc
- pts/jsonpath
- pts/redis
- pts/url
- URL
- pts/util
- pts/ws
- pts/socketio
- socketio
- pts/socket
- Prometheus Monitoring
- Product Introduction
- Access Guide
- EMR Integration
- Java Application Integration
- Exporter Integration
- Operation Guide
- Instance
- Recording Rule
- Alerting Rule
- Access Control
- TKE Metrics
- Practical Tutorial
- Terraform
- Grafana
- Operation Guide
- Instance
- Tencent Cloud Service Integration
- Plugin Management
- Dashboard
- Operation Guide
- Configuring Dashboard
- Monitoring Charts
- Creating Chart
- Use Cases of Different Chart Types
- Alarm Management
- Console Operation Guide
- Alarm Policy
- Configuring alert trigger conditions
- Alarm Notification
- Alarm Callback
- Alarm Receiving Channels and SMS Quota
- Dynamic Threshold Alarm
- Silencing Alarm
- EventBridge
- Product Introduction
- Practical Tutorial
- Migrating Event Alarm
- FAQs
- Related Agreements
- API Documentation
- Making API Requests
- Monitoring Data Query APIs
- Alarm APIs
- Notification Template APIs
- Legacy Alert APIs
- Prometheus Service APIs
- Grafana Service APIs
- Event Center APIs
- TencentCloud Managed Service for Prometheus APIs
- Monitoring APIs
DocumentationTencent Cloud Observability PlatformApplication Performance ManagementParameter InformationAPM Data Protocol StandardAPM Indicator Protocol Standard
APM Indicator Protocol Standard
Last updated: 2025-03-13 15:13:46
This document will elaborate on the protocol standard of inherent indicators of Application Performance Management (APM). Users can obtain the inherent indicators of Application Performance Management (APM) in the following two ways:
To query metrics via TencentCloud API, see DescribeGeneralMetricData API Documentation.
To synchronize indicators to Tencent Cloud Managed Service for Prometheus, see Prometheus Data Integration and Dashboard Associated Display.
Indicator Data Structure
Indicator Name
Each indicator has a unique TencentCloud API indicator name and a unique Prometheus indicator name, which are used for obtaining APM inherent indicators in two ways: TencentCloud API queries and synchronization to Prometheus.
Indicator View
The inherent indicators of APM are divided into 4 categories and identified by 4 indicator views. In the TencentCloud API query scenario, you need to specify the view name in the
ViewName field; in the Prometheus integration scenario, the view can be ignored.View Name | Description |
service_metric | Statistically analyze the general performance of applications, such as request quantity and response time. |
error_metric | Count the number of errors in the link. |
sql_metric | Statistically analyze the performance of application accessing the database, such as the number of SQL executions and response time. |
mq_metric | Statistically analyze the performance of applications accessing TDMQ, such as the number of message productions and response time. |
Metric Dimensions
Each indicator supports multiple dimensions: In the TencentCloud API query scenario, dimensions are used for data filtration; in the Prometheus integration scenario, dimension information will be output to Prometheus indicators in the form of Prometheus Labels.
Common Dimensions
All four types of indicators include the following common dimensions. When integrating applications with APM, most common dimensions can be customized based on instance attributes. For details, see Custom Application Instance Attributes.
TencentCloud API Dimension Name | Prometheus Tag Name | Description |
tapm.app.id | tapm_app_id | Cloud AppID |
tapm.instance.key | apm_instance | APM Instance ID |
service.name | apm_service_name | Application Name |
service.instance | service_instance | Application Instance |
agent.version | agent_version | Probe version number |
service.version | service_version | Application version |
In addition to general dimensions, each set of indicators under a specific view also supports a series of unique dimensions. For example, indicators under the service_metric view support
span.kind, representing the span type. For details, see below.Service Metric View
Metric
TencentCloud API Metric Name | Prometheus Metric Name | Type | Description | Unit | Bucket Distribution |
request_count | service_request_count | Gauge | Number of requests | - | - |
error_request_count | service_error_request_count | Gauge | Number of Error Requests | - | - |
duration_avg | service_duration_avg | Gauge | Average time consumption | ms | - |
duration_max | service_duration_max | Gauge | Maximum Duration | ms | - |
duration_min | service_duration_min | Gauge | Minimum time consumption | ms | - |
slow_request_count | service_slow_request_count | Gauge | Quantity of slow calls (>2000ms) | - | - |
tolerate_request_count | service_tolerate_request_count | Gauge | Tolerable quantity of calls (500 - 2000ms) | - | - |
duration_p50 | service_duration_p50 | Gauge | p50 duration | ms | - |
duration_p90 | service_duration_p90 | Gauge | p90 duration | ms | - |
duration_p95 | service_duration_p95 | Gauge | p95 duration | ms | - |
duration_p99 | service_duration_p99 | Gauge | p99 duration | ms | - |
range_count_duration | Not supported. | Histogram | Duration distribution. | - | 0,1,5,10,50,100,200,300,400,500,600,700,800,900,1000,1500,2000,3000,4000,5000,7000,10000,15000 |
Unique Dimensions
TencentCloud API Dimension Name | Prometheus Tag Name | Description |
span.kind | span_kind | Span Type |
service.component | service_component | Component Type |
peer.service | peer_service | Peer Application Name |
peer.operation | peer_operation | Peer API Name |
peer.filled | peer_filled | Peer Application Name after APM processing |
operation | operation | API Name |
peer.instance | peer_instance | Peer Instance |
status.message | status_message | Request Status Information |
status.code | status_code | Request Status Codes |
status_code_xx | status_code_xx | Status code after APM processing |
error.object | error_object | Error type |
namespace | namespace | Namespace |
service.view | service_view | Component view (enumeration value: "sql", "mq", or empty if none) |
k8s.deployment.name | k8s_deployment_name | Kubernetes workload name |
k8s.pod.name | k8s_pod_name | Kubernetes Pod name |
k8s.namespace.name | k8s_namespace_name | Kubernetes namespace |
k8s.cluster.id | k8s_cluster_id | The ID of the TKE cluster. |
k8s.region | k8s_region | The region of the TKE cluster |
k8s.pod.ip | k8s_pod_ip | Kubernetes Pod IP |
k8s.node.ip | k8s_node_ip | Kubernetes node IP |
cvm.region | cvm_region | The area where the CVM is located |
cvm.instance.id | cvm_instance_id | CVM Instance ID |
custom_key_1 | custom_key_1 | Custom dimension 1 |
custom_key_2 | custom_key_2 | Custom dimension 2 |
custom_key_3 | custom_key_3 | Custom dimension 3 |
Error Metric View
Metric
TencentCloud API Metric Name | Prometheus Metric Name | Type | Description | Unit |
error_request_count | error_error_request_count | Gauge | Error Requests | - |
last_error_occur_time | error_last_error_occur_time | Gauge | Last error occurrence time | ms |
Unique Dimensions
TencentCloud API Dimension Name | Prometheus Tag Name | Description |
service.component | service_component | Component Type |
span.kind | span_kind | Span Type |
operation | operation | API Name |
error.object | error_object | Error type |
peer.service | peer_service | Peer Application Name |
custom_key_1 | custom_key_1 | Custom dimension 1 |
custom_key_2 | custom_key_2 | Custom dimension 2 |
custom_key_3 | custom_key_3 | Custom dimension 3 |
Sql Metric View
Metric
TencentCloud API Metric Name | Prometheus Metric Name | Type | Description | Unit |
duration_avg | sql_duration_avg | Gauge | Average time consumption | - |
last_error_occur_time | sql_last_error_occur_time | Gauge | Last error occurrence time | ms |
error_request_count | sql_error_request_count | Gauge | Number of Error Requests | ms |
request_count | sql_request_count | Gauge | Number of requests | ms |
slow_sql_count | sql_slow_sql_count | Gauge | Quantity of slow SQLs (>2000ms) | - |
Unique Dimensions
TencentCloud API Dimension Name | Prometheus Tag Name | Description |
service.component | service_component | Component Type |
span.kind | span_kind | Span Type |
db.statement | db_statement | Execution statement. |
db.instance | db_instance | Instance address of the database |
db.ip | db_ip | IP Address |
db.operation | db_operation | Operation Type |
error.object | error_object | Error type |
db.system | db_system | Database Type |
attack.subtype | attack_subtype | Injection type |
attack.symbol | attack_symbol | Injection mark: 0 No injection, 1 Suspected injection |
attack.level | attack_level | Injection level: Critical, Important, Moderate, Low, info |
custom_key_1 | custom_key_1 | Custom dimension 1 |
custom_key_2 | custom_key_2 | Custom dimension 2 |
custom_key_3 | custom_key_3 | Custom dimension 3 |
Mq Metric View
Metric
TencentCloud API Metric Name | Prometheus Metric Name | Type | Description | Unit | Bucket Distribution |
duration_avg | mq_duration_avg | Gauge | Average time consumption | ms | - |
error_request_count | mq_error_request_count | Gauge | Number of Errors | - | - |
request_count | mq_request_count | Gauge | Number of requests | - | - |
range_count_duration | Not supported. | Histogram | Duration distribution | - | 0,1,5,10,50,100,200,300,400,500,600,700,800,900,1000,1500,2000,3000 |
Unique Dimensions
TencentCloud API Dimension Name | Prometheus Tag Name | Description |
component | component | Component Type |
span.kind | span_kind | Span Type |
peer.service | peer_service | Peer Application Name |
mq.topic | mq_topic | Cloud Message Queue Topic Name |
mq.broker | mq_broker | Broker address of the message queue |
operation | operation | API Name |
status.code | status_code | Request status |
status_code_xx | status_code_xx | Status code after APM processing |
error.object | error_object | Error type |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No