Todos os produtos
Search
Central de documentação

Simple Log Service:use an sdk to consume logs based on spl

Última atualização: Jul 03, 2026

Use um SDK para consumir logs com base em um Consume Processor (SPL). Este tópico fornece exemplos de código em Java, Python e Go.

Pré-requisitos

  • Crie um usuário do Resource Access Management (RAM) e conceda as permissões necessárias. Para mais informações, consulte Criar um usuário RAM e conceder permissões.

  • Configure as variáveis de ambiente ALIBABA_CLOUD_ACCESS_KEY_ID e ALIBABA_CLOUD_ACCESS_KEY_SECRET. Para mais detalhes, consulte Configurar variáveis de ambiente no Linux, macOS e Windows.

    Importante
    • O par de AccessKey de uma conta Alibaba Cloud tem permissões em todas as operações de API. Recomendamos usar o par de AccessKey de um usuário RAM para chamar operações de API ou executar tarefas rotineiras de operação e manutenção.

    • Não inclua seu AccessKey ID ou AccessKey secret no código do projeto. O vazamento dessas credenciais pode comprometer a segurança de todos os recursos da sua conta.

  • Criar um Consumer Processor

Exemplos de código

Java

  1. Instale o SDK do Simple Log Service. No diretório raiz do projeto Java, abra o arquivo pom.xml e adicione as dependências Maven a seguir. Para mais informações, consulte Instalar o SDK para Java.

    O SDK do Simple Log Service para Java deve ser da versão 0.6.126 ou superior.
    <dependency>
      <groupId>com.google.protobuf</groupId>
      <artifactId>protobuf-java</artifactId>
      <version>2.5.0</version>
    </dependency>
    <!-- Import the Simple Log Service SDK -->
    <dependency>
      <groupId>com.aliyun.openservices</groupId>
      <artifactId>aliyun-log</artifactId>
      <version>0.6.126</version>
    </dependency>
  2. Crie o arquivo PullLogsWithSPLDemo.java. Este exemplo chama a operação PullLog para consumir dados de log com base em SPL.

    import com.aliyun.openservices.log.Client;
    import com.aliyun.openservices.log.common.*;
    import com.aliyun.openservices.log.request.PullLogsRequest;
    import com.aliyun.openservices.log.response.ListShardResponse;
    import com.aliyun.openservices.log.response.PullLogsResponse;
    import java.util.HashMap;
    import java.util.List;
    import java.util.Map;
    
    public class PullLogsWithSPLDemo {
        // The endpoint of Simple Log Service. This example uses the China (Hangzhou) region. Replace it with the endpoint of your region.
        private static final String endpoint = "cn-hangzhou.log.aliyuncs.com";
        // This example obtains the AccessKey ID and AccessKey secret from environment variables.
        private static final String accessKeyId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
        private static final String accessKeySecret = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET");
        // The project name. Replace it with your actual project name.
        private static final String project = "ali-project-test";
        // The Logstore name. Replace it with your actual Logstore name.
        private static final String logStore = "test-logstore";
    
        public static void main(String[] args) throws Exception {
            // The ID of the Consume Processor.
            String processorName = "processor-test";
            // Create a Simple Log Service client.
            Client client = new Client(endpoint, accessKeyId, accessKeySecret);
            // Query the shards of the Logstore.
            ListShardResponse resp = client.ListShard(project, logStore);        System.out.printf("%s has %d shards\n", logStore, resp.GetShards().size());
            Map<Integer, String> cursorMap = new HashMap<>();
            for (Shard shard : resp.GetShards()) {
                int shardId = shard.getShardId();
                // Start consumption from the beginning and get a cursor. To start from the end, use Consts.CursorMode.END.
                cursorMap.put(shardId, client.GetCursor(project, logStore, shardId, Consts.CursorMode.BEGIN).GetCursor());
            }
            try {
                while (true) {
                    // Get logs from each shard.
                    for (Shard shard : resp.GetShards()) {
                        int shardId = shard.getShardId();
                        PullLogsRequest request = new PullLogsRequest(project, logStore, shardId, 1000, cursorMap.get(shardId));
                        // The ID of the Consume Processor.
                        request.setProcessor(processorName);
                        PullLogsResponse response = client.pullLogs(request);
                        // Logs are in log groups. Split them as needed.
                        List<LogGroupData> logGroups = response.getLogGroups();
                        System.out.printf("Get %d logGroup from logstore:%s:\tShard:%d\n", logGroups.size(), logStore, shardId);
    
                        // Move the cursor after you process the pulled logs.
                        cursorMap.put(shardId, response.getNextCursor());
                    }
                }
            } catch (LogException e) {
                System.out.println("error code :" + e.GetErrorCode());
                System.out.println("error message :" + e.GetErrorMessage());
                throw e;
            }
        }
    }
  3. Execute a função main e visualize a saída.

    Get 41 logGroup from logstore:test-logstore:	Shard:0
    Get 49 logGroup from logstore:test-logstore:	Shard:1
    Get 43 logGroup from logstore:test-logstore:	Shard:0
    Get 39 logGroup from logstore:test-logstore:	Shard:1
    ... ...

Python

  1. Instale o SDK do Simple Log Service. Crie uma pasta de projeto chamada spl_demo e execute o comando a seguir nessa pasta. Para mais informações, consulte Instalar o SDK do Simple Log Service para Python.

    O SDK do Alibaba Cloud Simple Log Service deve ser da versão 0.9.28 ou superior.
    pip install -U aliyun-log-python-sdk
  2. Na pasta spl_demo, crie o arquivo main.py. Este código cria um grupo de consumidores e inicia uma thread de consumo para ler dados do Logstore especificado.

    # encoding: utf-8
    
    import time
    import os
    from aliyun.log import *
    
    def main():
        # The endpoint of Simple Log Service. This example uses the China (Hangzhou) region. Replace it with the endpoint of your region.
        endpoint = 'cn-hangzhou.log.aliyuncs.com'
        # This example obtains the AccessKey ID and AccessKey secret from environment variables.
        access_key_id = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID', '')
        access_key = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET', '')
        # The project name. Replace it with your actual project name.
        project_name = 'ali-project-test'
        # The Logstore name. Replace it with your actual Logstore name.
        logstore_name = 'test-logstore'
        # The ID of the Consume Processor.
        processor = "processor-test"
        init_cursor = 'end'
        log_group_count = 10
    
        # Create a Simple Log Service client.
        client = LogClient(endpoint, access_key_id, access_key)
    
        cursor_map = {}
        # List the shards of the logstore.
        res = client.list_shards(project_name, logstore_name)
        res.log_print()
        shards = res.shards
    
        # Get the initial cursor.
        for shard in shards:
            shard_id = shard.get('shardID')
            res = client.get_cursor(project_name, logstore_name, shard_id, init_cursor)
            cursor_map[shard_id] = res.get_cursor()
    
        # Read data from each shard in a loop.
        while True:
            for shard in shards:
                shard_id = shard.get('shardID')
                res = client.pull_logs(project_name, logstore_name, shard_id, cursor_map.get(shard_id), log_group_count,
                                       processor=processor)
                res.log_print()
                if cursor_map[shard_id] == res.next_cursor:
                    # only for debug
                    time.sleep(3)
                else:
                    cursor_map[shard_id] = res.next_cursor
    
    if __name__ == '__main__':
        main()
  3. Execute a função main e visualize a saída.

    ListShardResponse:
    headers: {'Server': 'AliyunSLS', 'Content-Type': 'application/json', 'Content-Length': '335', 'Connection': 'keep-alive', 'Access-Control-Allow-Origin': '*', 'Date': 'Wed, 26 Feb 2025 09:46:17 GMT', 'x-log-time': '1740563177', 'x-log-requestid': '67BEE2E9132069E22A1F967D'}
    res: [{'shardID': 0, 'status': 'readwrite', 'inclusiveBeginKey': '00000000000000000000000000000000', 'exclusiveEndKey': '80000000000000000000000000000000', 'createTime': 1737010019}, {'shardID': 1, 'status': 'readwrite', 'inclusiveBeginKey': '80000000000000000000000000000000', 'exclusiveEndKey': 'ffffffffffffffffffffffffffffffff', 'createTime': 1737010019}]
    PullLogResponse
    next_cursor MTczNz********c3ODgyMjQ0MQ==
    log_count 0
    headers: {'Server': 'AliyunSLS', 'Content-Type': 'application/x-protobuf', 'Content-Length': '1', 'Connection': 'keep-alive', 'Access-Control-Allow-Origin': '*', 'Date': 'Wed, 26 Feb 2025 09:46:17 GMT', 'x-log-cursor-time': '0', 'x-log-end-of-cursor': '1', 'x-log-failedlines': '0', 'x-log-rawdatacount': '0', 'x-log-rawdatalines': '0', 'x-log-rawdatasize': '0', 'x-log-read-last-cursor': '0', 'x-log-resultlines': '0', 'x-log-time': '1740563177', 'x-log-bodyrawsize': '0', 'x-log-compresstype': 'gzip', 'x-log-count': '0', 'x-log-cursor': 'MTczNzAx********ODgyMjQ0MQ==', 'x-log-requestid': '67BEE2E974CA9ABCE7DDC7D6'}
    detail: []
    PullLogResponse
    next_cursor MTczNz********c3OTg5NzE3NA==
    log_count 0
    headers: {'Server': 'AliyunSLS', 'Content-Type': 'application/x-protobuf', 'Content-Length': '1', 'Connection': 'keep-alive', 'Access-Control-Allow-Origin': '*', 'Date': 'Wed, 26 Feb 2025 09:46:21 GMT', 'x-log-cursor-time': '0', 'x-log-end-of-cursor': '1', 'x-log-failedlines': '0', 'x-log-rawdatacount': '0', 'x-log-rawdatalines': '0', 'x-log-rawdatasize': '0', 'x-log-read-last-cursor': '0', 'x-log-resultlines': '0', 'x-log-time': '1740563181', 'x-log-bodyrawsize': '0', 'x-log-compresstype': 'gzip', 'x-log-count': '0', 'x-log-cursor': 'MTczNzAx********OTg5NzE3NA==', 'x-log-requestid': '67BEE2EDF2B58CF1756526EF'}
    detail: []
    PullLogResponse
    ... ...

Go

  1. Instale o SDK do Simple Log Service. Crie uma pasta de projeto chamada spl_demo e execute o comando a seguir nessa pasta. Para mais informações, consulte Instalar o SDK para Go.

    O SDK do Alibaba Cloud Simple Log Service deve ser da versão 0.1.107 ou superior.
    go get -u github.com/aliyun/aliyun-log-go-sdk
  2. Na pasta spl_demo, crie o arquivo main.go. Este código cria um grupo de consumidores e inicia uma thread de consumo para ler dados do Logstore especificado.

    package main
    
    import (
    	"fmt"
    	"os"
    	"time"
    
    	sls "github.com/aliyun/aliyun-log-go-sdk"
    )
    
    func main() {
    	client := &sls.Client{
    		AccessKeyID:     os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"),
    		AccessKeySecret: os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"),
    		Endpoint:        "cn-chengdu.log.aliyuncs.com",
    	}
    
    	project := "ali-project-test"
    	logstore := "test-logstore"
    	initCursor := "end"
        // The ID of the Consume Processor.
    	consumeProcessor := "ali-test-consume-processor"
    	shards, err := client.ListShards(project, logstore)
    	if err != nil {
    		fmt.Println("ListShards error", err)
    		return
    	}
    
    	shardCursorMap := map[int]string{}
    	for _, shard := range shards {
    		cursor, err := client.GetCursor(project, logstore, shard.ShardID, initCursor)
    		if err != nil {
    			fmt.Println("GetCursor error", shard.ShardID, err)
    			return
    		}
    		shardCursorMap[shard.ShardID] = cursor
    	}
    
    	for {
    		for _, shard := range shards {
    			pullLogRequest := &sls.PullLogRequest{
    				Project:          project,
    				Logstore:         logstore,
    				ShardID:          shard.ShardID,
    				LogGroupMaxCount: 10,
    				Processor:        consumeProcessor,
    				Cursor:           shardCursorMap[shard.ShardID],
    			  }
    			lg, nextCursor, err := client.PullLogsV2(pullLogRequest)
    			fmt.Println("shard: ", shard.ShardID, "loggroups: ", len(lg.LogGroups), "nextCursor: ", nextCursor)
    			if err != nil {
    				fmt.Println("PullLogsV2 error", shard.ShardID, err)
    				return
    			}
    			shardCursorMap[shard.ShardID] = nextCursor
    			if len(lg.LogGroups) == 0 {
    				// only for debug
    				time.Sleep(time.Duration(3) * time.Second)
    			}
    		}
    	}
    }
  3. Execute a função main e visualize a saída.

    shard:  0 loggroups:  41 nextCursor:  MTY5Mz*******TIxNjcxMDcwMQ==
    shard:  1 loggroups:  49 nextCursor:  MTY5Mz*******DYwNDIyNDQ2Mw==
    shard:  0 loggroups:  43 nextCursor:  MTY5Mz*******TIxNjcxMDcwMQ==
    shard:  1 loggroups:  39 nextCursor:  MTY5Mz*******DYwNDIyNDQ2Mw==
    ... ...