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
- Practical Tutorial
- 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 ManagementAccess GuideAccessing Python ApplicationAutomatic Connecting Python Application for the K8s Environment (Recommended)
Automatic Connecting Python Application for the K8s Environment (Recommended)
Last updated: 2025-03-20 19:34:07
Automatic Connecting Python Application for the K8s Environment (Recommended)
Last updated: 2025-03-20 19:34:07
For Python applications deployed on Kubernetes, APM offers an automatic connection scheme that enables agent auto-injection, facilitating quick application integration.
Automatic connecting Python applications for the K8s environment will use the community OpenTelemetry-Python scheme for agent injection. For more information on OpenTelemetry-Python, see the community OpenTelemetry-Python project.
Prerequisites
See Supported Components and Frameworks by the OpenTelemetry-Python Scheme to ensure that your Python versions, dependency libraries, and frameworks are within the supported range of the agent. For dependency libraries and frameworks supported by automatic instrumentation, data reporting is completed upon successful connection without the need to modify the code. If automatic Event Tracking does not meet your scenario, or you need to add business layer tracing, use the OpenTelemetry API for Custom Event Tracking.
Django Application Precautions
If your application uses the Django framework, pay attention to the following points before connecting:
To automatically connect in a K8s environment through the Operator, ensure that the Python version is 3.8 or higher.
It is recommended to deploy the service using uWSGI. For deployment methods, see through uWSGI Hosting Django Application. Starting directly through the python command may cause reporting failures.
The introduction of OpenTelemetry-Python may result in Django applications no longer using the default configuration file. It is necessary to re-specify the configuration file through environment variables:
export DJANGO_SETTINGS_MODULE=mysite.settings
You can add this configuration item to the project's startup script, or add environment variables through a YAML file:
env:- name: DJANGO_SETTINGS_MODULEvalue: mysite.settings
Step 1: Install Operator.
Install Operator in the TKE cluster, it's recommended to install Operator with one click on the APM console, for details see installing tencent-opentelemetry-operator.
Step 2: Add annotation to workload.
1. Log in to TKE console.
2. Click Cluster to enter the corresponding TKE cluster.
3. In Workload, locate the application that needs to connect with APM, click More, then click Edit YAML.
4. In the Pod annotation where the application is located, add the following content, then click Complete to finish the connection.
cloud.tencent.com/inject-python: "true"cloud.tencent.com/otel-service-name: my-app # Application name, processes that connect using the same application name are displayed in APM as multiple instances under the same application.# The application name can be up to 63 characters and can only contain lowercase letters, digits, and the separator (-), and it must start with a lowercase letter and end with a digit or lowercase letter.
Note that this content needs to be added to
spec.template.metadata.annotations, affecting the Pod's annotation, not the workload's annotation. You can see the following code snippet: apiVersion: apps/v1kind: Deploymentmetadata:labels:k8s-app: my-appname: my-appnamespace: defaultspec:selector:matchLabels:k8s-app: my-apptemplate:metadata:labels:k8s-app: my-appannotations:cloud.tencent.com/inject-python: "true" # Add it here.cloud.tencent.com/otel-service-name: my-appspec:containers:image: my-app:0.1name: my-app
Connection Verification
After an annotation is added to the workload, depending on the published policy, you can trigger the restart of the application Pod. The newly started Pod will automatically inject an agent and connect to the APM server to report monitoring data. The reported business system is the default business system of the Operator. Under normal traffic conditions, the connected application will be displayed in Application Performance Management > Application List.
Select Instance monitoring to view the connected application instances. Since there is a certain latency in the processing of observable data, if the applications or instances are not found in the console after connecting, wait about 30 seconds.
More Connection Configuration Items (Optional)
At the Workload level, you can add more annotations to adjust the connect behaviors:
Configuration Item | Description |
cloud.tencent.com/apm-token | Specify the Token for the APM business system. If this configuration item is not added, the Operator's configuration is used (corresponding to the Operator's env.APM_TOKEN field). |
cloud.tencent.com/python-instr-version | Specify the Python agent version. If this configuration item is not added, the Operator's configuration is used (corresponding to the Operator's
env.PYTHON_INSTR_VERSION field). The value can be latest (default) or a specific version number. For a list of specific version numbers, see Agent Version Information. It is not recommended to fill in this field unless necessary. |
cloud.tencent.com/container-names | Specify the container for agent injection. This configuration item supports injecting probes into multiple containers. Just fill in the names of multiple containers in the value of this configuration item and separate them with commas. If this configuration item is not added, the probe will be default injected into the first container. This configuration item is supported in operator 0.88 and above versions. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No