tencent cloud

日志服务

动态与公告
产品动态
公告
新手指引
产品简介
产品概述
产品优势
地域和访问域名
规格与限制
基本概念
购买指南
计费概述
产品定价
按量计费(后付费)
欠费说明
清理日志服务资源
成本优化
常见问题
快速入门
一分钟入门指南
入门指南
使用 Demo 日志快速体验 CLS
操作指南
资源管理
权限管理
日志采集
指标采集
日志存储
指标存储
检索分析(日志主题)
检索分析(指标主题)
仪表盘
数据处理
投递与消费
监控告警
云产品中心
DataSight 独立控制台
历史文档
实践教程
日志采集
检索分析
仪表盘
监控告警
投递和消费
成本优化
开发者指南
通过 iframe 内嵌 CLS(旧方案)
通过 Grafana 使用 CLS
API 文档
History
Introduction
API Category
Making API Requests
Topic Management APIs
Log Set Management APIs
Index APIs
Topic Partition APIs
Machine Group APIs
Collection Configuration APIs
Log APIs
Metric APIs
Alarm Policy APIs
Data Processing APIs
Kafka Protocol Consumption APIs
CKafka Shipping Task APIs
Kafka Data Subscription APIs
COS Shipping Task APIs
SCF Delivery Task APIs
Scheduled SQL Analysis APIs
COS Data Import Task APIs
Data Types
Error Codes
常见问题
健康监测问题解释
采集相关
检索分析相关
其他问题
服务等级协议
CLS 政策
隐私协议
数据处理和安全协议
联系我们
词汇表

Python SDK 上传日志

PDF
聚焦模式
字号
最后更新时间: 2025-11-07 17:40:37
本文介绍如何快速使用日志服务的 Python SDK 实现日志上传的操作。更多 SDK 使用的详细内容,可见代码仓库 tencentcloud-cls-sdk-python

前提条件

创建并获取云 API 密钥信息 accessKeyId 和 accessKey,密钥信息获取请前往 API 密钥管理
请确保密钥关联的账号具有相应的 SDK 上传日志权限

准备开发环境

请参见 Python 官网 下载并安装 Python 开发环境或使用 conda 创建 Python 虚拟环境。
日志服务 Python SDK 支持 Pypy 2、3和 Python 2.7、3.3、3.4、3.5、3.6、3.7、3.8、3.9版本。
您可执行以下命令检查当前 Python 的版本信息。
pip -V

安装 Python SDK

在命令行工具中,执行以下命令安装 Python SDK。
pip install git+https://github.com/TencentCloud/tencentcloud-cls-sdk-python.git@v1.0.4

验证 SDK 安装

安装 SDK 后,执行以下步骤验证已安装的 Python SDK。
pip show tencentcloud-cls-sdk-python
如果返回以下类型的信息,则代表安装成功。
Name: tencentcloud-cls-sdk-python
Version: 1.0.4
Summary: TencentCloud cls log service Python client SDK
Home-page: https://github.com/TencentCloud/tencentcloud-cls-sdk-python
Author: farmerx

请求参数

变量
类型
是否必填
说明
endpoint
String
域名信息,填写请参见 可用域名 中 API 上传日志 Tab 中的域名。
accessKeyId
String
云 API 密钥信息,密钥信息获取请前往 API 密钥管理。并请确保密钥关联的账号具有相应的 SDK 上传日志权限
accessKey
String
云 API 密钥信息,密钥信息获取请前往 API 密钥管理。并请确保密钥关联的账号具有相应的 SDK 上传日志权限
topic_id
String
日志主题的 ID 信息。

日志上传示例代码

以下代码以 Python SDK 为例,展示通过调用 SDK 完成日志上传的操作,示例代码如下所示。
不建议将云 API 密钥信息明文存储至工程代码中,可通过环境变量动态获取云 API 密钥信息,具体操作,请参见 配置环境变量
# 导入所需的库
import time
from tencentcloud.log.logclient import LogClient
from tencentcloud.log.logexception import LogException
from tencentcloud.log.cls_pb2 import LogGroupList
import os

def upload(topic_id, client):
LogLogGroupList = LogGroupList()
LogGroup = LogLogGroupList.logGroupList.add()
# 自定义本次日志上传的文件名来源,会作为元数据字段在日志中
LogGroup.filename = "pyXXXX.log"
# 自定义本次上传的地址来源,会作为元数据字段在日志中
LogGroup.source = "192.XX.XX.XX"
# 自定义元数据字段
LogTag = LogGroup.logTags.add()
LogTag.key = "key"
LogTag.value = "value"
Log = LogGroup.logs.add()
Log.time = int(round(time.time() * 1000000)) # 获取当前时间作为日志的时间戳
# 定义日志的内容
Content = Log.contents.add()
Content.key = "Hello"
Content.value = "World"
try:
request = client.put_log_raw(topic_id, LogLogGroupList)
print("Request ID:", request.get_request_id())
except LogException as e:
print("Error uploading log:", e)
if name == 'main':

# 填入域名信息,填写指引:https://www.tencentcloud.com/document/product/614/18940?from_cn_redirect=1#.E5.9F.9F.E5.90.8D,请参见链接中 API 上传日志 Tab 中的域名
endpoint = 'https://ap-xxxxxxxx.cls.tencentcs.com';
# 填入云API密钥信息。密钥信息获取请前往:https://console.tencentcloud.com/cam/capi
# 并请确保密钥关联的账号具有相应的日志上传权限,权限配置指引:https://www.tencentcloud.com/document/product/614/68374?from_cn_redirect=1#.E4.BD.BF.E7.94.A8-api-.E4.B8.8A.E4.BC.A0.E6.95.B0.E6.8D.AE
# 本示例从环境变量中获取,环境变量配置指引:https://www.tencentcloud.com/document/product/614/113851?from_cn_redirect=1
accessKeyId = os.environ["TENCENTCLOUD_SECRET_ID"]
accessKey = os.environ["TENCENTCLOUD_SECRET_KEY"]
# 填入日志主题的 ID
topic_id = '59XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
# 构建日志客户端
client = LogClient(endpoint, accessKeyId, accessKey)
# 调用上传函数
upload(topic_id, client)

结语

通过以上步骤,您可以快速使用腾讯云 CLS 的 Python SDK 完成日志的上传操作。如遇到任何问题,请 联系我们 获取帮助。


帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈