為方便追查問題,Python SDK提供了日誌記錄功能,該功能預設處於關閉狀態。
說明
開啟Python SDK日誌記錄功能需要Python SDK 2.6.x以上版本。
背景資訊
Python SDK日誌記錄功能可以收集定位各類OSS操作的日誌資訊,並以記錄檔的形式儲存在本地。
日誌格式:
<time><name><level><threadId><message>記錄層級:CRITICAL > ERROR > WARNING > INFO > DEBUG > NOTSET
說明指定記錄層級後,本地記錄檔只會記錄指定層級及高於指定層級的資訊。例如指定記錄層級為INFO,則記錄檔會記錄CRITICAL、ERROR、WARNING及INFO層級的相關日誌資訊。
注意事項
本文以華東1(杭州)外網Endpoint為例。如果您希望通過與OSS同地區的其他阿里雲產品訪問OSS,請使用內網Endpoint。關於OSS支援的Region與Endpoint的對應關係,請參見地區和Endpoint。
本文以OSS網域名稱建立OSSClient為例。如果您希望通過自訂網域名、STS等方式建立OSSClient,請參見初始化(Python SDK V1)。
開啟Python SDK日誌記錄功能
以下代碼用於開啟Python SDK日誌記錄功能。
# -*- coding: utf-8 -*-
import os
import logging
import oss2
from itertools import islice
from oss2.credentials import EnvironmentVariableCredentialsProvider
# 下載日誌資訊到本地記錄檔,並儲存到指定的本地路徑中。
# 如果未指定本地路徑只填寫了本地記錄檔名稱(例如examplelogfile.log),則下載後的檔案預設儲存到樣本程式所屬專案對應本地路徑中。
log_file_path = "D:\\localpath\\examplelogfile.log"
# 開啟日誌。
oss2.set_file_logger(log_file_path, 'oss2', logging.INFO)
# 從環境變數中擷取訪問憑證。運行本程式碼範例之前,請確保已設定環境變數OSS_ACCESS_KEY_ID和OSS_ACCESS_KEY_SECRET。
auth = oss2.ProviderAuthV4(EnvironmentVariableCredentialsProvider())
# 填寫Bucket所在地區對應的Endpoint。以華東1(杭州)為例,Endpoint填寫為https://oss-cn-hangzhou.aliyuncs.com。
endpoint = "https://oss-cn-hangzhou.aliyuncs.com"
# 填寫Endpoint對應的Region資訊,例如cn-hangzhou。注意,v4簽名下,必須填寫該參數
region = "cn-hangzhou"
# examplebucket填寫儲存空間名稱。
bucket = oss2.Bucket(auth, endpoint, "examplebucket", region=region)
# 遍曆檔案目錄。
for b in islice(oss2.ObjectIterator(bucket), 10):
print(b.key)
# 擷取檔案中繼資料。
# 填寫Object完整路徑,例如exampledir/exampleobject.txt。Object完整路徑中不能包含Bucket名稱。
object_meta = bucket.get_object_meta('exampledir/exampleobject.txt')相應的日誌資訊如下:
說明
如果需要更詳細的日誌資訊,您可以將記錄層級修改為DEBUG。
2018-11-20 16:37:46,437 oss2.api [INFO] 26716 : Exception: {
'status': 404,
'x-oss-request-id': '5BF3C7DA236B3A201CE64679',
'details': {
'HostId': 'examplebucket.oss-cn-shenzhen.aliyuncs.com',
'Message': 'The specified key does not exist.',
'Code': 'NoSuchKey',
'RequestId': '5BF3C7DA236B3A201CE64679',
'Key': 'exampledir/exampleobject.txt'
}
}根據以上日誌資訊可知初始化一個Bucket會遍曆其中所有的Object,當請求的Object不存在時會發生錯誤,錯誤資訊為NoSuchKey。