This topic describes how to get started with Log Service SDK for Python and perform common operations. For example, you can create a project, create a Logstore, write logs, and query logs.


Log Service SDK for Python is installed. For more information, see Install Log Service SDK for Python.

Sample code

  • Write Python code to collect logs
    In this example, the file is created. The sample code in this file provides an example on how to call API operations to create a project, create a Logstore, create indexes, write logs, and query logs. Example:
    from aliyun.log import LogClient, PutLogsRequest, LogItem, GetLogsRequest, IndexConfig
    import time
    # Configure the required information, such as the AccessKey pair, endpoint, project name, and Logstore name. 
    # The AccessKey pair of your Alibaba Cloud account. For more information, see AccessKey pair. 
    # An Alibaba Cloud account has permissions to call all API operations. If you use the AccessKey pair of an Alibaba Cloud account, security risks may occur. We recommend that you create and use a RAM user to call API operations or perform routine O&M. 
    accessKeyId = "your_access_id"  
    accessKey = "your_access_key" 
    # The Log Service endpoint. For more information, see Endpoints. In this example, the Log Service endpoint for the China (Hangzhou) region is used. Replace the parameter value with the actual endpoint. 
    endpoint = "" 
    # Create a client for Log Service.  
    client = LogClient(endpoint, accessKeyId, accessKey)
    # 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 dev,id from " + logstore_name
    # The indexes. 
    logstore_index = {'line': {
        'token': [',', ' ', "'", '"', ';', '=', '(', ')', '[', ']', '{', '}', '?', '@', '&', '<', '>', '/', ':', '\n', '\t',
                  '\r'], 'caseSensitive': False, 'chn': False}, 'keys': {'dev': {'type': 'text',
                                                                                 'token': [',', ' ', "'", '"', ';', '=',
                                                                                           '(', ')', '[', ']', '{', '}',
                                                                                           '?', '@', '&', '<', '>', '/',
                                                                                           ':', '\n', '\t', '\r'],
                                                                                 'caseSensitive': False, 'alias': '',
                                                                                 'doc_value': True, 'chn': False},
                                                                         'id': {'type': 'long', 'alias': '',
                                                                                'doc_value': True}}, 'log_reduce': False,
        'max_text_len': 2048}
    # The from_time and to_time parameters specify the start time and end time of the time range within which you want to query logs. The values of the parameters are UNIX timestamps. 
    from_time = int(time.time()) - 3600
    to_time = time.time() + 3600
    # Create a project. 
    def create_project():
        print("ready to create project %s" % project_name)
        client.create_project(project_name, project_des="")
        print("create project %s success " % project_name)
    # Create a Logstore. 
    def create_logstore():
        print("ready to create logstore %s" % logstore_name)
        client.create_logstore(project_name, logstore_name, ttl=3, shard_count=2)
        print("create logstore %s success " % project_name)
    # Create indexes. 
    def create_index():
        print("ready to create index for %s" % logstore_name)
        index_config = IndexConfig()
        client.create_index(project_name, logstore_name, index_config)
        print("create index for %s success " % logstore_name)
        time.sleep(60 * 2)
    # 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()
            contents = [
                ('dev', 'test_put'),
                ('id', str(i))
        request = PutLogsRequest(project_name, logstore_name, "", "", log_group, compress=False)
        print("put logs for %s success " % logstore_name)
    # Execute an SQL statement to query logs. 
    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))
    if __name__ == '__main__':
        # Create a project. 
        # Create a Logstore. 
        # Create indexes. 
        # Write data to the Logstore. 
        # Execute an SQL statement to query logs. 

    Sample output:

    ready to create project aliyun-test-project
    create project aliyun-test-project success
    ready to create logstore aliyun-test-logstore
    create logstore aliyun-test-project success
    ready to create index for aliyun-test-logstore
    create index for aliyun-test-logstore success
    ready to put logs for aliyun-test-logstore
    put logs for aliyun-test-logstore success
    ready to query logs from logstore aliyun-test-logstore
    dev : test_put
    id : 0
    dev : test_put
    id : 1
    dev : test_put
    id : 2
    dev : test_put
    id : 3

    For more information about sample code, see aliyun-log-python-sdk.

  • Use Logtail to collect Python logs

    You can use Logtail to collect Python logs from the logging module in Python. For more information, see Collect Python logs.