文档

使用Python SDK管理快速查询

更新时间:

当您需要频繁查看某一查询和分析结果时,可以将对应查询和分析语句另存为快速查询。本文通过代码示例介绍如何创建、修改、查询、删除快速查询等。

前提条件

  • 已创建RAM用户并完成授权。具体操作,请参见创建RAM用户并完成授权

  • 已配置环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET。具体操作,请参见在Linux、macOS和Windows系统配置环境变量

    重要
    • 阿里云账号的AccessKey拥有所有API的访问权限,建议您使用RAM用户的AccessKey进行API访问或日常运维。

    • 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下所有资源的安全。

  • 已安装Python SDK。更多信息,请参见安装Python SDK

  • 已写入日志到Logstore。具体操作,请参见数据采集概述

注意事项

本示例以华东1(杭州)的公网Endpoint为例,其公网Endpoint为https://cn-hangzhou.log.aliyuncs.com。如果您通过与Project同地域的其他阿里云产品访问日志服务,请使用内网Endpointhttps://cn-hangzhou-intranet.log.aliyuncs.com。关于日志服务支持的地域与Endpoint的对应关系,请参见服务入口

原始日志样例

body_bytes_sent:1750
host:www.example.com
http_referer:www.example.com
http_user_agent:Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_6; it-it) AppleWebKit/533.20.25 (KHTML, like Gecko) Version/5.0.4 Safari/533.20.27
http_x_forwarded_for:203.0.XX.XX
remote_addr:203.0.XX.XX
remote_user:p288
request_length:13741
request_method:GET
request_time:71
request_uri:/request/path-1/file-1
http_code:200
time_local:11/Aug/2021:06:52:27
upstream_response_time:0.66

创建快速查询示例代码

以下代码用于创建名为ali-test-savedsearch的快速查询。

from aliyun.log import LogClient
import os

# 本示例从环境变量中获取AccessKey ID和AccessKey Secret。
accessKeyId = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID', '')
accessKey = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET', '')
# 日志服务的服务接入点。此处以杭州为例,其它地域请根据实际情况填写。
endpoint = "cn-hangzhou.log.aliyuncs.com"
# 创建日志服务Client。
client = LogClient(endpoint, accessKeyId, accessKey)

# Project名称。
project_name = "ali-test-project"
# Logstore名称。
logstore_name = "ali-test-logstore"
# 快速查询名称。
savedsearch_name = "ali-test-savedsearch"

# 统计GET请求或POST请求失败的日志数量。
query = "(request_method:GET or request_method:POST) not status in [200 299]|select COUNT(*) as pv,status group by status"

if __name__ == '__main__':
    print("ready to create savedsearch")

    # JSON格式的快速查询配置信息。在这里定义快速查询名称、查询和分析语句、目标Logstore等。
    my_json_query_str = {
        "savedsearchName": savedsearch_name,
        "searchQuery": query,
        "logstore": logstore_name,
        "topic": "",
        "displayName": ""
    }
    # 调用接口创建快速查询。
    client.create_savedsearch(project_name, detail=my_json_query_str)
    print("create savedsearch success")        

预期结果如下:

ready to create savedsearch
create savedsearch success

修改快速查询示例代码

以下代码用于修改名为ali-test-savedsearch的快速查询。

from aliyun.log import LogClient
import os

# 本示例从环境变量中获取AccessKey ID和AccessKey Secret。
accessKeyId = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID', '')
accessKey = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET', '')
# 日志服务的服务接入点。此处以杭州为例,其它地域请根据实际情况填写。
endpoint = "cn-hangzhou.log.aliyuncs.com"
# 创建日志服务Client。
client = LogClient(endpoint, accessKeyId, accessKey)

# Project名称。
project_name = "ali-test-project"
# Logstore名称。
logstore_name = "ali-test-logstore"
# 快速查询名称。
savedsearch_name = "ali-test-savedsearch"

# 查询GET请求或POST请求失败的日志。
query = "(request_method:GET or request_method:POST) not status in [200 299]"

if __name__ == '__main__':
    print("ready to update savedsearch")

    print("Before update, the savedsearch is:")
    res = client.get_savedsearch(project_name, savedsearch_name)
    print(res.get_body())

    # JSON格式的快速查询配置信息。该示例中修改query为:查询GET请求或POST请求失败的日志。
    my_json_query_str = {
        "savedsearchName": savedsearch_name,
        "searchQuery": query,
        "logstore": logstore_name,
        "topic": "",
        "displayName": ""
    }
    # 调用接口修改快速查询。
    client.update_savedsearch(project_name, detail=my_json_query_str)

    print("After update, the savedsearch is:")
    res = client.get_savedsearch(project_name, savedsearch_name)
    print(res.get_body())

    print("update savedsearch success")

预期结果如下:

ready to update savedsearch
Before update, the savedsearch is:
{'displayName': '', 'logstore': 'ali-test-logstore', 'savedsearchName': 'ali-test-savedsearch', 'searchQuery': "*|select date_format(__time__-__time__%60, '%H:%i:%s') as time, COUNT(*) as pv group by time", 'topic': ''}
After update, the savedsearch is:
{'displayName': '', 'logstore': 'ali-test-logstore', 'savedsearchName': 'ali-test-savedsearch', 'searchQuery': '(request_method:GET or request_method:POST) not status in [200 299]', 'topic': ''}
update savedsearch success

查询所有快速查询示例代码

以下代码用于查询目标Project下的所有快速查询。

from aliyun.log import LogClient
import os

# 本示例从环境变量中获取AccessKey ID和AccessKey Secret。
accessKeyId = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID', '')
accessKey = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET', '')
# 日志服务的服务接入点。此处以杭州为例,其它地域请根据实际情况填写。
endpoint = "cn-hangzhou.log.aliyuncs.com"
# 创建日志服务Client。
client = LogClient(endpoint, accessKeyId, accessKey)

# Project名称。
project_name = "ali-test-project"

if __name__ == '__main__':
    print("ready to list savedsearch")
    # 查询所有快速查询。
    res = client.list_savedsearch(project_name, 0 ,100)
    print(res.get_entities())

    print("list savedsearch success")

预期结果如下:

ready to list savedsearch
['ali-test-savedsearch', 'testali-test-savedsearch2', 'ali-test-savedsearch2']
update savedsearch success

查询指定快速查询示例代码

以下代码用于查询指定快速查询信息。

from aliyun.log import LogClient
import os

# 本示例从环境变量中获取AccessKey ID和AccessKey Secret。
accessKeyId = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID', '')
accessKey = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET', '')
# 日志服务的服务接入点。此处以杭州为例,其它地域请根据实际情况填写。
endpoint = "cn-hangzhou.log.aliyuncs.com"
# 创建日志服务Client。
client = LogClient(endpoint, accessKeyId, accessKey)

# Project名称。
project_name = "ali-test-project"

# 快速查询名称。
savedsearch_name = "ali-test-savedsearch"

if __name__ == '__main__':
    print("ready to get savedsearch")
    # 查询指定快速查询。
    res = client.get_savedsearch(project_name, savedsearch_name)
    print(res.get_body())

    print("get savedsearch success")

预期结果如下:

ready to get savedsearch
{'displayName': 'ali-test-savedsearch', 'logstore': 'ali-test-logstore', 'savedsearchName': 'ali-test-savedsearch', 'searchQuery': '(request_method:GET or request_method:POST) not status in [200 299]', 'topic': ''}
get savedsearch success

删除快速查询示例代码

以下代码用于删除目标Project下的快速查询。

from aliyun.log import LogClient
import os

# 本示例从环境变量中获取AccessKey ID和AccessKey Secret。
accessKeyId = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID', '')
accessKey = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET', '')
# 日志服务的服务接入点。此处以杭州为例,其它地域请根据实际情况填写。
endpoint = "cn-hangzhou.log.aliyuncs.com"
# 创建日志服务Client。
client = LogClient(endpoint, accessKeyId, accessKey)

# Project名称。
project_name = "ali-test-project"

# 快速查询名称。
savedsearch_name = "ali-test-savedsearch"

if __name__ == '__main__':
    print("ready to delete savedsearch")

    print("Before delete, the savedsearch is:")
    res = client.list_savedsearch(project_name, 0, 100)
    print(res.get_entities())

    print("After delete, the savedsearch is:")
    res = client.list_savedsearch(project_name, 0, 100)
    print(res.get_entities())

    # 调用接口删除目标快速查询。
    client.delete_savedsearch(project_name, savedsearch_name)
    print("delete savedsearch success")

预期结果如下:

ready to delete savedsearch
Before delete, the savedsearch is:
['ali-test-savedsearch', 'testali-test-savedsearch2', 'ali-test-savedsearch2']
After delete, the savedsearch is:
['testali-test-savedsearch2', 'ali-test-savedsearch2']
delete savedsearch success

相关文档