Simple Log Service:Início rápido: Envie e analise logs com o SDK do SLS

1,1 Criar um projeto

Faça login no console do Simple Log Service. Na seção Projects, clique em Create Project. No painel Create Project, selecione uma Region e insira um Project Name. Este documento usa como exemplo um projeto chamado aliyun-test-project na região China (Hangzhou). Mantenha os valores padrão para os demais parâmetros.

1,2 Criar um logstore

# Import the SLS package.
from aliyun.log import *
# Import this module to get the AccessKey pair from environment variables.
import os
# Obtain the AccessKey ID and AccessKey secret from environment variables.
access_key_id = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID', '')
access_key_secret = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET', '')
# The endpoint of Simple Log Service.
endpoint = "cn-hangzhou.log.aliyuncs.com"
# Create a LogClient instance.
client = LogClient(endpoint, access_key_id, access_key_secret)

10.0.*.1 - - [14/Jul/2025:12:00:03 +0000] "POST /login HTTP/1.1" 302 0 "http://example.com/login.html" "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.4896.88 Safari/537.36"  

# The name of the project.
project_name = "aliyun-test-project"
# The name of the logstore.
logstore_name = "aliyun-test-logstore"
# Write data to the logstore.
def put_logs():
    print("ready to put logs for %s" % logstore_name)
    log_group = []
    for i in range(0, 100):
        log_item = LogItem()
        # Set the log content by field.
        contents = [
            ('remote_addr', '192.168.0.%d' % (i % 255)),
            ('remote_user', 'user%d' % i),
            ('time_local', time.strftime('%d/%b/%Y:%H:%M:%S +0000', time.gmtime())),
            ('request_method', 'GET' if i % 2 == 0 else 'POST'),
            ('request_uri', '/index.html' if i % 3 == 0 else '/api/data'),
            ('status', str(200 + (i % 100))),  # Status codes are between 200 and 299.
            ('body_bytes_sent', str(1024 + i)),
            ('http_referer', 'http://example.com/page%d' % (i // 10)),
            ('http_user_agent',
             'Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.%d Safari/537.36' % (i * 10))
        ]
        log_item.set_contents(contents)
        log_group.append(log_item)
    request = PutLogsRequest(project_name, logstore_name, "", "", log_group, compress=False)
    client.put_logs(request)
    print("put logs for %s success " % logstore_name)
    time.sleep(60)

# The name of the project.
project_name = "aliyun-test-project"
# The name of the logstore.
logstore_name = "aliyun-test-logstore"
# The index.
logstore_index = {'line': {
    'token': [',', ' ', "'", '"', ';', '=', '(', ')', '[', ']', '{', '}', '?', '@', '&', '<', '>', '/', ':', '\n', '\t',
              '\r'], 'caseSensitive': False, 'chn': False},
    'keys': {'remote_addr': {'type': 'text', 'token': [',', ' ', "'", '"', ';', '=', '(', ')', '[', ']', '{', '}', '?', '@', '&', '<', '>', '/', ':', '\n', '\t', '\r'], 'caseSensitive': False, 'alias': 'remote_addr', 'doc_value': True, 'chn': False},
            'remote_user': {'type': 'text', 'token': [',', ' ', "'", '"', ';', '=', '(', ')', '[', ']', '{', '}', '?', '@', '&', '<', '>', '/', ':', '\n', '\t', '\r'], 'caseSensitive': False, 'alias': 'remote_user', 'doc_value': True, 'chn': False},
            'time_local': {'type': 'text', 'token': [',', ' ', "'", '"', ';', '=', '(', ')', '[', ']', '{', '}', '?', '@', '&', '<', '>', '/', ':', '\n', '\t', '\r'], 'caseSensitive': False, 'alias': 'time_local', 'doc_value': True, 'chn': False},
            'request_method': {'type': 'text', 'token': [',', ' ', "'", '"', ';', '=', '(', ')', '[', ']', '{', '}', '?', '@', '&', '<', '>', '/', ':', '\n', '\t', '\r'], 'caseSensitive': False, 'alias': 'request_method', 'doc_value': True, 'chn': False},
            'request_uri': {'type': 'text', 'token': [',', ' ', "'", '"', ';', '=', '(', ')', '[', ']', '{', '}', '?', '@', '&', '<', '>', '/', ':', '\n', '\t', '\r'], 'caseSensitive': False, 'alias': 'request_uri', 'doc_value': True, 'chn': False},
            'status': {'type': 'long', 'alias': 'status', 'doc_value': True},
            'body_bytes_sent': {'type': 'long', 'alias': 'body_bytes_sent', 'doc_value': True},
            'http_referer': {'type': 'text', 'token': [',', ' ', "'", '"', ';', '=', '(', ')', '[', ']', '{', '}', '?', '@', '&', '<', '>', '/', ':', '\n', '\t', '\r'], 'caseSensitive': False, 'alias': 'http_referer', 'doc_value': True, 'chn': False},
            'http_user_agent': {'type': 'text', 'token': [',', ' ', "'", '"', ';', '=', '(', ')', '[', ']', '{', '}', '?', '@', '&', '<', '>', '/', ':', '\n', '\t', '\r'], 'caseSensitive': False, 'alias': 'http_user_agent', 'doc_value': True, 'chn': False}}}
# Create an index.
def create_index():
    print("ready to create index for %s" % logstore_name)
    index_config = IndexConfig()
    index_config.from_json(logstore_index)
    client.create_index(project_name, logstore_name, index_config)
    print("create index for %s success " % logstore_name)
    time.sleep(60 * 2)

# The name of the project.
project_name = "aliyun-test-project"
# The name of the logstore.
logstore_name = "aliyun-test-logstore"
# The query statement.
query = "*| select request_method,status from " + logstore_name
# from_time and to_time specify the time range for the query, in UNIX timestamp format.
from_time = int(time.time()) - 3600
to_time = time.time() + 3600
# Query logs by using SQL.
def get_logs():
    print("ready to query logs from logstore %s" % logstore_name)
    request = GetLogsRequest(project_name, logstore_name, from_time, to_time, query=query)
    response = client.get_logs(request)
    for log in response.get_logs():
        for k, v in log.contents.items():
            print("%s : %s" % (k, v))
        print("*********************")

ready to query logs from logstore aliyun-test-logstore
request_method : GET
status : 200
*********************
request_method : POST
status : 201
*********************
request_method : GET
status : 202
*********************
request_method : POST
status : 203
*********************
Process finished with exit code 0

8,1 Criar uma política de ação

1. No painel de navegação à esquerda, escolha Alerts > Notification Policy > Action Policy e clique em Create.

2. Na caixa de diálogo Add Action Policy, crie uma política de ação com o Identifier definido como test-action-policy e o Name definido como New Alert Rule-My Action Policy test. Essa política envia notificações via DingTalk quando um alerta é acionado. As configurações específicas do grupo de ações são as seguintes:

   • Channel : Selecione DingTalk-Custom.

   • Request URL : Insira o webhook do seu chatbot do DingTalk, por exemplo, https://oapi.dingtalk.com/robot/send?access_token=4dff******6bfe.

   • Reminder : Selecione No Reminder para evitar menções (@) na notificação de alerta do DingTalk.

   • Content template : Selecione SLS Built-in Content Template.

   • Sending period : Selecione Any time para enviar notificações de alerta sempre que um alerta ocorrer.

O Simple Log Service fornece SDKs para gerencie usuários, grupos de usuários, integrações de webhook, políticas de ação, políticas de alerta e modelos de conteúdo. Para mais informações, consulte Gerenciar dados de recursos de alerta.

8,2 Criar uma regra de alerta

1. No painel de navegação à esquerda, escolha Alerts > Alert Monitoring Rule e clique em Create Alert.

2. Na página Create Alert, configure uma regra para acionar uma notificação de alerta do DingTalk a cada 15 minutos quando dados forem detectados. Configure a regra da seguinte forma:

   • Rule Name: New Alert Rule.

   • Check Frequency: Fixed interval of 15 minutes.

   • Query statistics:

     • Type: Logstore.

     • Region: China (Hangzhou).

     • Project: aliyun-test-project.

     • Logstore: aliyun-test-logstore.

     • Query: * | select *.

     • Query Time Range: Today.

   • Group evaluation: No grouping.

   • Trigger Condition: Quando there is data, um alerta com Severity de Medium é acionado.

   • Add Annotation: Defina as chaves como title e desc, e defina o valor de ambas como ${alert_name} alert is triggered.

   • Destination: Para notificações do SLS, defina a política de ação como a test-action-policy criada.

   Além disso, ative os destinos EventStore e CloudMonitor Event Center. Para a política de alerta, selecione Normal Mode e defina o intervalo de repetição como 1 minute.

# The name of the project.
project_name = "aliyun-test-project"

# Delete the specified project.
def main():
    try:
        response = client.delete_project(project_name)
        response.log_print()
    except Exception as error:
        print(error)

Quais recursos os SDKs do Simple Log Service suportam?

Os SDKs do SLS oferecem suporte à maioria dos recursos do SLS, incluindo coleta de logs, criação de índices, consulta e análise, transformação de dados, consumo de logs, gerenciamento de entrega de logs, alertas e jobs SQL agendados. Caso algum recurso não seja suportado, atualize para a versão mais recente do SDK ou verifique se há atualizações em lançamentos futuros.

Qual é o procedimento básico para usar um SDK do Simple Log Service?

O uso de um SDK segue um fluxo de trabalho semelhante ao do console:

1. Ative o Simple Log Service.

2. Obtenha um par de AccessKey.

3. Crie um projeto e um Logstore.

4. Colete logs e armazene-os no Logstore.

5. Crie um índice para os logs.

6. Consulte e analise logs e visualize os resultados.

7. Execute operações nos dados de log, como transformação de dados, entrega e alertas.

Para operações mais simples, use o console do SLS. Início rápido.

Como lidar com erros comuns ao depurar um SDK?

Os SDKs do SLS possuem tratamento de erros integrado. As exceções se enquadram nas seguintes categorias:

• Exceções retornadas pelo Simple Log Service. O SDK lida com essas exceções. Para mais informações, consulte as descrições das operações da API e Códigos de erro.

• Exceções de rede que ocorrem quando o SDK envia solicitações, como desconexão de rede e tempo limite de resposta do servidor.

• Exceções específicas de plataforma e linguagem geradas pelo SDK, como estouro de memória.

Tratamento de erros.

Para soluções de erros comuns relacionados à coleta de logs, indexação, consulta, análise e transformação, consulte as Perguntas frequentes.

Existem limites para o uso dos SDKs do Simple Log Service?

O SLS impõe limites em projetos, Logstores, shards e tamanho de LogItem. Revise os Limites de recursos básicos antes de usar um SDK.

Existem documentos com exemplos de código para usar os SDKs?

O SLS fornece exemplos de código para operações comuns. Consulte os documentos de referência de cada SDK.

• SDK do Simple Log Service para Java:

  • Use a operação GetLogs para consultar logs

  • Use o SDK Java para gerenciar Logstores

  • Consuma logs usando um grupo de consumidores

  • Use o Aliyun Log Java Producer para gravar dados de log

• SDK do Simple Log Service para Python:

  • Use a operação GetLogs para consultar logs

  • Use o SDK Python para gerenciar Logstores

  • Use GetHistograms para consultar a distribuição de logs

  • Consuma logs usando um grupo de consumidores

• SDKs do Simple Log Service para várias linguagens:

  • Início rápido do SDK Go

  • Início rápido do SDK .NET

  • Início rápido do SDK Node.js

  • Início rápido do SDK PHP

  • Início rápido do SDK C++

  • Início rápido do SDK Android

  • Início rápido do SDK iOS

  • Início rápido do SDK Flutter

  • Início rápido do SDK HarmonyOS

Para mais source de código, consulte os repositórios de logs do Alibaba Cloud no GitHub.