赛尔校园公共服务平台 Logo
平台使用
阿里云
百度云
移动云
智算服务
教育生态
登录 →
赛尔校园公共服务平台 Logo
平台使用 阿里云 百度云 移动云 智算服务 教育生态
登录
  1. 首页
  2. 阿里云
  3. 日志服务
  4. 开发参考
  5. 日志服务SDK
  6. SDK参考概述

SDK参考概述

  • 日志服务SDK
  • 发布于 2025-04-22
  • 0 次阅读
文档编辑
文档编辑

开发人员可以使用.NET Core、Java、Python、PHP、Node.js、C、Go、iOS、Android、C++等语言的SDK采集、查询和分析日志等。

使用前须知

不同语言的日志服务SDK具体实现细节会有所不同,但是它们都是日志服务API在不同语言上的封装,实现的功能也基本一致。具体包括如下几个方面:

  • 实现对日志服务API接口的统一封装 ,让您不需要关心具体的API请求构建和响应解析。而且各个不同语言的接口使用也非常接近,方便您在不同语言间切换。更多信息,请参见接口规范。

  • 实现日志服务API的数字签名逻辑,让您不需要关心API的签名逻辑细节,降低使用日志服务API的难度。更多信息,请参见请求签名。

  • 实现日志服务日志的ProtoBuffer格式封装,让您在写入日志时不需要关心ProtoBuffer格式的具体细节。更多信息,请参见ProtoBuffer格式。

  • 实现日志服务API中定义的压缩方法,让您不用关心压缩实现的细节。部分语言的SDK支持启用压缩模式写入日志(默认为使用压缩方式)。

  • 提供统一的错误处理机制,让您可以使用语言所熟悉的方式处理请求异常。更多信息,请参见错误处理机制。

  • 目前所有语言实现的SDK仅提供同步请求方式。

SDK列表

下表列举了日志服务不同语言的SDK的参考文档和GitHub源码。

说明

日志服务对基础资源(例如Project个数、Logstore个数、Shard个数、LogItem大小)设定了合理的限制。建议您在使用前阅读使用限制文档,了解基础资源的使用限制。更多信息,请参见基础资源使用限制。

使用SDK采集日志到日志服务后,您还需要为日志配置合适的索引,之后您就可以进行日志查询和分析、数据加工等操作。更多信息,请参见创建索引和查询与分析快速指引。

SDK语言

参考文档

GitHub源码

Java

Java SDK概述

Log Service Java SDK、Java Producer Library、

.NET Core

.NET Core SDK概述

Log Service .NET Core 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 SDK、Objective-C SDK

Android

Android SDK概述

Log Service Android SDK

C++

C++ SDK概述

Log Service C++ SDK

HarmonyOS

HarmonyOS SDK概述

Log Service HarmonyOS SDK

调用示例

具体调用示例参考Python SDK调用日志服务ListProject接口。

常见问题

日志服务SDK都支持哪些功能?

日志服务SDK已经实现日志服务大部分功能,包括日志采集、创建索引、查询和分析、数据加工、日志消费、日志投递管理、告警、定时SQL等。若您在SDK调试中发现未实现功能,建议您升级到最新版本SDK重试或关注后续SDK版本更新。

使用日志服务SDK的基本流程是什么?

日志服务SDK提供全流程的日志管理,其使用流程和控制台使用流程基本相似。其使用基本流程大致如下:

  1. 开通日志服务。

  2. 获取访问密钥。

  3. 创建项目Project和日志库Logstore。

  4. 日志采集并存储至Logstore。

  5. 为日志创建索引。

  6. 查询和分析日志,可视化展示。

  7. 对日志数据进行加工、投递和告警等操作。

日志服务提供界面化操作控制台,操作更简单。更多信息,请参考日志服务快速入门。

SDK调试常见报错如何处理?

日志服务SDK提供错误处理逻辑。SDK可能出现的异常错误可以分成如下几类:

  • 由日志服务端返回的错误。这类错误由日志服务端返回并由SDK处理。关于这类错误的详细信息可以参见具体的API接口说明、API错误码。关于错误码的更多信息,请参见错误码。

  • 由SDK在向服务端发出请求时出现的网络错误。这类错误包括网络连接不通,服务端返回超时等。

  • 由SDK自身产生的、与平台及语言相关的错误,如内存溢出等。

更多信息,请参见错误处理。

在使用日志服务SDK过程中,您可能遇到日志采集、索引、查询和分析、加工等各类报错,您可以参考日志服务常见问题进行处理。更多信息,请参见常见问题。

使用日志服务SDK是否存在限制?

日志服务对基础资源(例如Project个数、Logstore个数、Shard个数、LogItem大小)设定了合理的限制。建议您在使用前阅读使用限制文档,了解基础资源的使用限制。更多信息,请参见基础资源使用限制。

使用SDK采集日志到日志服务后,您还需要为日志配置合适的索引,之后您就可以进行日志查询和分析、数据加工等操作。更多信息,请参见创建索引和查询与分析快速指引。

是否有使用SDK的代码示例文档?

日志服务提供典型常用操作的代码示例文档,请参考各SDK参考帮助文档。

  • 日志服务Java SDK:

    • 使用GetLogs接口查询日志

    • 使用Java SDK管理日志库Logstore

    • 通过消费组消费日志

    • 使用Aliyun Log Java Producer写入日志数据

  • 日志服务Python SDK:

    • 使用GetLogs接口查询日志

    • 使用Python SDK管理日志库Logstore

    • 使用GetHistograms查询日志分布数量

    • 通过消费组消费日志

  • 日志服务各语言SDK:

    • Go SDK快速入门

    • .NET SDK快速入门

    • Node.js SDK快速入门

    • PHP SDK快速入门

    • C++ SDK快速入门

    • Android SDK快速入门

    • iOS SDK快速入门

    • Flutter SDK快速入门

    • HarmonyOS SDK快速入门

更多源码,请参见GitHub阿里云日志源码库。

相关文档

日志服务SDK调试平台

阿里云OpenAPI开发者门户提供调试、SDK、示例和配套文档。通过OpenAPI,您无需手动封装请求和签名操作,就可以快速对日志服务API进行调试。更多信息,请参见OpenAPI开发者门户。

命令行工具CLI

为满足越来越多的自动化日志服务配置需求,日志服务提供命令行工具CLI。更多信息,请参见命令行工具CLI。

费用说明

使用SDK、OpenAPI开发者门户和日志服务CLI产生的费用和使用控制台产生的费用一致。更多信息,请参见计费概述。

相关文章

SDK参考概述 2025-04-22 10:36

开发人员可以使用.NET Core、Java、Python、PHP、Node.js、C、Go、iOS、Android、C++等语言的SDK采集、查询和分析日志等。

配置访问凭证 2025-04-22 10:36

使用SDK发起请求访问日志服务,您需要配置访问凭证。阿里云服务会通过访问凭证验证您的身份信息和访问权限。您可以根据使用场景对认证和授权的要求,配置不同类型的访问凭证。 访问凭证 访问凭证选型 凭据是指用户证明其身

错误处理 2025-04-22 10:36

在使用SDK访问日志服务端时,可能会出现网络中断、网络延迟导致的请求失败。本文介绍SDK请求失败时的错误处理逻辑。 错误类型及处理原则

接口规范 2025-04-22 10:36

本文介绍SDK接口需要遵循的原则。 Request-Response原则 尽

数据压缩 2025-04-22 10:36

lz4是一种无损压缩算法,具有高速解码与压缩能力。日志服务部分API接口支持lz4压缩算法,使用lz4压缩算法可以减少网络传输流量,降低流量费用,提升接口访问速度。 压缩请求数据

获取RequestId 2025-04-22 10:36

本文以Java、Python和Go语言为例,介绍如何获取日志服务请求的RequestId。 说明 本文的代码是通过GetProject - 获取指定Project接口,分别介绍三种语言如何

目录
Copyright © 2025 your company All Rights Reserved. Powered by 赛尔网络.
京ICP备14022346号-15
gongan beian 京公网安备11010802041014号