Simple Log Service provides SDKs for different programming languages, such as .NET, .NET Core, Java, Python, PHP, Node.js, C, Go, iOS, Android, and C++. You can use Simple Log Service SDKs to collect, query, and analyze logs.
Usage notes
Simple Log Service SDKs for different programming languages vary in terms of implementation. However, Simple Log Service SDKs for different programming languages encapsulate the same API operations and provide similar features. Simple Log Service SDKs provide the following features:
Encapsulation of Simple Log Service API operations. Simple Log Service SDKs implement the underlying API request creation and response parsing. The API operations in different programming languages are similar. This simplifies the switchover between different programming languages. For more information, see API regulations.
Automatic digital signature of API requests. You do not need to specify the digital signature logic of the Simple Log Service API. This simplifies the use of the Simple Log Service API. For more information, see Request signatures.
Protocol Buffer-formatted encapsulation of logs. The logs that are collected by Simple Log Service are encapsulated in the Protocol Buffer format. You do not need to specify a format. For more information, see Protocol Buffer format.
Log compression by using the method that is defined in the Simple Log Service API. Simple Log Service SDKs for several programming languages allow you to specify whether logs can be written to Simple Log Service in compression mode. By default, the compression mode is used.
Unified exception handling mechanism. You can use a Simple Log Service SDK to handle exceptions based on the programming language. For more information, see Exception handling.
Support only for synchronous requests.
Simple Log Service SDKs for different programming languages
The following table provides links to the references and GitHub source code of Simple Log Service SDKs for different programming languages.
Simple Log Service imposes limits on basic resources, such as the number of projects, the number of Logstores, the number of shards, and the size of LogItem. We recommend that you read the topic about the limits before you use Simple Log Service SDKs. For more information, see Limits on basic resources.
After you collect logs to Simple Log Service by using a Simple Log Service SDK, you must configure indexes for the logs. Then, you can perform various operations such as query, analysis, and transformation on the logs. For more information, see Create indexes and Query and analyze logs.
SDK programming language | References | Source code on GitHub |
Java | ||
.NET Core | ||
.NET | ||
PHP | ||
Python | ||
Node.js | ||
C | ||
GO | ||
iOS | ||
Android | ||
C++ |
Examples of calling API operations
For information about how to use a Simple Log Service SDK to call API operations, see Use Simple Log Service SDK for Python to call the ListProject operation.
FAQ
What features do Simple Log Service SDKs support?
Simple Log Service SDKs support most features of Simple Log Service. For example, you can use a Simple Log Service SDK to collect, index, query, analyze, transform, consume, and ship logs. You can also configure alert rules for logs and manage Scheduled SQL jobs. If you identify a feature that is not supported when you use a Simple Log Service SDK, we recommend that you update the Simple Log Service SDK to the latest version and try again or pay attention to subsequent SDK version updates.
How do I use Simple Log Service SDKs?
Simple Log Service SDKs provide end-to-end log management. You can use a Simple Log Service SDK in the similar manner as you perform operations in the Simple Log Service console. You can perform the following steps to use a Simple Log Service SDK:
Activate Simple Log Service.
Obtain an AccessKey pair.
Create a project and a Logstore.
Collect logs and store the logs to the Logstore.
Create indexes for the logs.
Query and analyze the logs and visualize the query and analysis results.
Transform and ship the logs, and configure alert rules for the logs.
Simple Log Service provides a console in which you can perform operations in an efficient manner. For more information, see Getting Started.
How do I handle common errors that may occur when I use a Simple Log Service SDK?
Simple Log Service SDKs provide error handing logic. The following errors may occur when you use a Simple Log Service SDK:
Exceptions that are returned by Simple Log Service. This type of exceptions are handled by Simple Log Service SDK. For more information about this type of exceptions, see the description and error codes of each API operation. For more information about the error codes, see Error codes.
Network exceptions that occur when you use Simple Log Service SDK to send requests. This type of exceptions include network disconnection and server response timeout.
Exceptions that are generated by Simple Log Service SDK and related to platforms and programming languages, such as, memory overflow.
For more information, see Exception handling.
When you use a Simple Log Service SDK to perform operations such as log collection, index management, data query and analysis, and data transformation, errors may occur. You can handle the errors based on the Simple Log Service FAQ. For more information, see FAQ.
Are limits imposed when I use a Simple Log Service SDK?
Yes, Simple Log Service imposes limits on basic resources such as the number of projects, the number of Logstores, the number of shards, and the size of LogItem. We recommend that you read the topic about the limits before you use Simple Log Service SDKs. For more information, see Limits on basic resources.
After you collect logs to Simple Log Service by using a Simple Log Service SDK, you must configure indexes for the logs. Then, you can perform various operations such as query, analysis, and transformation on the logs. For more information, see Create indexes and Query and analyze logs.
Are documents that provide sample code of Simple Log Service SDKs available?
Yes, Simple Log Service provides documents for you to obtain sample code of commonly used operations. For more information, see related SDK documents.
Simple Log Service SDK for Java:
Simple Log Service SDK for Python:
For more information about source code, visit Alibaba Cloud GitHub.
References
Debugging platform for Simple Log Service SDKs
Alibaba Cloud OpenAPI Explorer provides debugging capabilities, SDKs, examples, and related documents. If you use OpenAPI Explorer, you can debug Simple Log Service API operations without the need to manually encapsulate requests or sign the requests. For more information, visit OpenAPI Explorer.
Alibaba Cloud CLI
Simple Log Service provides the command-line interface (CLI) to meet the requirements for automated configurations in Simple Log Service. For more information, see Simple Log Service CLI.
Billing
The fees that are incurred when you manage specific resources by using Simple Log Service SDKs, OpenAPI Explorer, and Simple Log Service CLI are the same as the fees that are incurred when you manage the resources in the Simple Log Service console. For more information, see Billing overview.