全部產品
Search
文件中心

Simple Log Service:SDK參考概述

更新時間:Jul 30, 2024

開發人員可以使用.NET、.NET Core、Java、Python、PHP、Node.js、C、Go、iOS、Android、C++等語言的SDK採集、查詢和分析日誌等。

使用前須知

不同語言的Log ServiceSDK具體實現細節會有所不同,但是它們都是Log ServiceAPI在不同語言上的封裝,實現的功能也基本一致。具體包括如下幾個方面:

  • 實現對Log ServiceAPI介面的統一封裝 ,讓您不需要關心具體的API請求構建和響應解析。而且各個不同語言的介面使用也非常接近,方便您在不同語言間切換。更多資訊,請參見介面規範

  • 實現Log ServiceAPI的數位簽章邏輯,讓您不需要關心API的簽名邏輯細節,降低使用Log ServiceAPI的難度。更多資訊,請參見請求籤名

  • 實現Log Service日誌的ProtoBuffer格式封裝,讓您在寫入日誌時不需要關心ProtoBuffer格式的具體細節。更多資訊,請參見ProtoBuffer格式

  • 實現Log ServiceAPI中定義的壓縮方法,讓您不用關心壓縮實現的細節。部分語言的SDK支援啟用壓縮模式寫入日誌(預設為使用壓縮方式)。

  • 提供統一的錯誤處理機制,讓您可以使用語言所熟悉的方式處理請求異常。更多資訊,請參見錯誤處理機制

  • 目前所有語言實現的SDK僅提供同步請求方式。

SDK列表

下表列舉了Log Service不同語言的SDK的參考文檔和GitHub源碼。

說明

Log Service對基礎資源(例如Project個數、Logstore個數、Shard個數、LogItem大小)設定了合理的限制。建議您在使用前閱讀使用限制文檔,瞭解基礎資源的使用限制。更多資訊,請參見基礎資源使用限制

使用SDK採集日誌到Log Service後,您還需要為日誌配置合適的索引,之後您就可以進行日誌查詢和分析、資料加工等操作。更多資訊,請參見建立索引查詢和分析日誌

SDK語言

參考文檔

GitHub源碼

Java

Java SDK概述

Log Service Java SDKJava Producer Library

.NET Core

.NET Core SDK概述

Log Service .NET Core SDK

.NET

.NET SDK概述

Log Service .NET SDK

PHP

PHP SDK概述

Log Service PHP SDK

Python

Python SDK概述

Log Service Python SDK

Node.js

Node.js SDK概述

Log Service Node.js SDK

C

C SDK

Log Service C SDK

GO

Go SDK概述

Log Service Go SDK

iOS

iOS SDK概述

Log Service iOS SDKObjective-C SDK

Android

Android SDK概述

Log Service Android SDK

C++

C++ SDK概述

Log Service C++ SDK

調用樣本

具體調用樣本參考Python SDK調用Log ServiceListProject介面查詢Project資訊

常見問題

Log ServiceSDK都支援哪些功能?

Log ServiceSDK已經實現Log Service大部分功能,包括日誌採集、建立索引、查詢和分析、資料加工、日誌消費、日誌投遞管理、警示、定時SQL等。若您在SDK調試中發現未實現功能,建議您升級到最新版本SDK重試或關注後續SDK版本更新。

使用Log ServiceSDK的基本流程是什嗎?

Log ServiceSDK提供全流程的日誌管理,其使用流程和控制台使用流程基本相似。其使用基本流程大致如下:

  1. 開通Log Service。

  2. 擷取存取金鑰。

  3. 建立專案Project和日誌庫Logstore。

  4. 日誌採集並儲存至Logstore。

  5. 為日誌建立索引。

  6. 查詢和分析日誌,可視化展示。

  7. 對日誌資料進行加工、投遞和警示等操作。

Log Service提供介面化Operations 主控台,操作更簡單。更多資訊,請參考Log Service快速入門

SDK調試常見報錯如何處理?

Log ServiceSDK提供錯誤處理邏輯。SDK可能出現的異常錯誤可以分成如下幾類:

  • 由Log Service端返回的錯誤。這類錯誤由Log Service端返回並由SDK處理。關於這類錯誤的詳細資料可以參見具體的API介面說明、API錯誤碼。關於錯誤碼的更多資訊,請參見錯誤碼

  • 由SDK在向服務端發出請求時出現的網路錯誤。這類錯誤包括網路連接不通,服務端返回逾時等。

  • 由SDK自身產生的、與平台及語言相關的錯誤,如記憶體溢出等。

更多資訊,請參見錯誤處理

在使用Log ServiceSDK過程中,您可能遇到日誌採集、索引、查詢和分析、加工等各類報錯,您可以參考Log Service常見問題進行處理。更多資訊,請參見常見問題

使用Log ServiceSDK是否存在限制?

Log Service對基礎資源(例如Project個數、Logstore個數、Shard個數、LogItem大小)設定了合理的限制。建議您在使用前閱讀使用限制文檔,瞭解基礎資源的使用限制。更多資訊,請參見基礎資源使用限制

使用SDK採集日誌到Log Service後,您還需要為日誌配置合適的索引,之後您就可以進行日誌查詢和分析、資料加工等操作。更多資訊,請參見建立索引查詢和分析日誌

是否有使用SDK的程式碼範例文檔?

相關文檔

Log ServiceSDK調試平台

阿里雲OpenAPI開發人員門戶提供調試、SDK、樣本和配套文檔。通過OpenAPI,您無需手動封裝請求和簽名操作,就可以快速對Log ServiceAPI進行調試。更多資訊,請參見OpenAPI開發人員門戶

命令列工具CLI

為滿足越來越多的自動化Log Service配置需求,Log Service提供命令列工具CLI。更多資訊,請參見命令列工具CLI

費用說明

使用SDK、OpenAPI開發人員門戶和Log ServiceCLI產生的費用和使用控制台產生的費用一致。更多資訊,請參見計費概述