Skip to content

Update sls_toolkit.py #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update sls_toolkit.py #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
70965e8
Update sls_toolkit.py
hcl00521 May 28, 2025
38adab7
Update sls_toolkit.py
hcl00521 May 29, 2025
5ba40e1
Update README.md
hcl00521 May 29, 2025
3b0bccd
Update README.md
hcl00521 May 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 14 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,20 @@

### 工具列表
#### 日志相关
| 工具名称 | 用途 | 关键参数 | 最佳实践 |
|---------|------|---------|---------|
| `sls_list_projects` | 列出SLS项目，支持模糊搜索和分页 | `projectName`：项目名称（可选，模糊搜索）<br>`limit`：返回项目数量上限（默认50，范围1-100）<br>`regionId`：阿里云区域ID | - 在不确定可用项目时，首先使用此工具<br>- 使用合理的`limit`值避免返回过多结果 |
| `sls_list_logstores` | 列出项目内的日志存储，支持名称模糊搜索 | `project`：SLS项目名称（必需）<br>`logStore`：日志存储名称（可选，模糊搜索）<br>`limit`：返回结果数量上限（默认10）<br>`isMetricStore`：是否筛选指标存储<br>`logStoreType`：日志存储类型<br>`regionId`：阿里云区域ID | - 确定项目后使用此工具查找相关日志存储<br>- 可通过`logStoreType`筛选特定类型日志存储 |
| `sls_describe_logstore` | 检索日志存储的结构和索引信息 | `project`：SLS项目名称（必需）<br>`logStore`：SLS日志存储名称（必需）<br>`regionId`：阿里云区域ID | - 在查询前使用此工具了解可用字段及其类型<br>- 检查所需字段是否启用了索引 |
| `sls_execute_sql_query` | 在指定时间范围内对日志存储执行SQL查询 | `project`：SLS项目名称（必需）<br>`logStore`：SLS日志存储名称（必需）<br>`query`：SQL查询语句（必需）<br>`fromTimestampInSeconds`：查询开始时间戳（必需）<br>`toTimestampInSeconds`：查询结束时间戳（必需）<br>`limit`：返回结果数量上限（默认10）<br>`regionId`：阿里云区域ID | - 使用适当的时间范围优化查询性能<br>- 限制返回结果数量避免获取过多数据 |
| `sls_translate_text_to_sql_query` | 将自然语言描述转换为SLS SQL查询语句 | `text`：查询的自然语言描述（必需）<br>`project`：SLS项目名称（必需）<br>`logStore`：SLS日志存储名称（必需）<br>`regionId`：阿里云区域ID | - 适用于不熟悉SQL语法的用户<br>- 对于复杂查询，可能需要优化生成的SQL |
| `sls_diagnose_query` | 诊断SLS查询问题，提供失败原因分析 | `query`：待诊断的SLS查询（必需）<br>`errorMessage`：查询失败的错误信息（必需）<br>`project`：SLS项目名称（必需）<br>`logStore`：SLS日志存储名称（必需）<br>`regionId`：阿里云区域ID | - 查询失败时使用此工具了解根本原因<br>- 根据诊断建议修改查询语句 |
| 工具名称 | 用途 | 关键参数 | 最佳实践 |
|---------|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|
| `sls_list_projects` | 列出SLS项目，支持模糊搜索和分页 | `projectName`：项目名称（可选，模糊搜索）<br>`limit`：返回项目数量上限（默认50，范围1-100）<br>`regionId`：阿里云区域ID | - 在不确定可用项目时，首先使用此工具<br>- 使用合理的`limit`值避免返回过多结果 |
| `sls_list_logstores` | 列出项目内的日志存储，支持名称模糊搜索 | `project`：SLS项目名称（必需）<br>`logStore`：日志存储名称（可选，模糊搜索）<br>`limit`：返回结果数量上限（默认10）<br>`isMetricStore`：是否筛选指标存储<br>`logStoreType`：日志存储类型<br>`regionId`：阿里云区域ID | - 确定项目后使用此工具查找相关日志存储<br>- 可通过`logStoreType`筛选特定类型日志存储 |
| `sls_describe_logstore` | 检索日志存储的结构和索引信息 | `project`：SLS项目名称（必需）<br>`logStore`：SLS日志存储名称（必需）<br>`regionId`：阿里云区域ID | - 在查询前使用此工具了解可用字段及其类型<br>- 检查所需字段是否启用了索引 |
| `sls_execute_sql_query` | 在指定时间范围内对日志存储执行SQL查询 | `project`：SLS项目名称（必需）<br>`logStore`：SLS日志存储名称（必需）<br>`query`：SQL查询语句（必需）<br>`fromTimestampInSeconds`：查询开始时间戳（必需）<br>`toTimestampInSeconds`：查询结束时间戳（必需）<br>`limit`：返回结果数量上限（默认10）<br>`regionId`：阿里云区域ID | - 使用适当的时间范围优化查询性能<br>- 限制返回结果数量避免获取过多数据 |
| `sls_translate_text_to_sql_query` | 将自然语言描述转换为SLS SQL查询语句 | `text`：查询的自然语言描述（必需）<br>`project`：SLS项目名称（必需）<br>`logStore`：SLS日志存储名称（必需）<br>`regionId`：阿里云区域ID | - 适用于不熟悉SQL语法的用户<br>- 对于复杂查询，可能需要优化生成的SQL |
| `sls_diagnose_query` | 诊断SLS查询问题，提供失败原因分析 | `query`：待诊断的SLS查询（必需）<br>`errorMessage`：查询失败的错误信息（必需）<br>`project`：SLS项目名称（必需）<br>`logStore`：SLS日志存储名称（必需）<br>`regionId`：阿里云区域ID | - 查询失败时使用此工具了解根本原因<br>- 根据诊断建议修改查询语句 |
| `sls_list_etls` | 列出项目内的数据加工任务 | `project`：SLS项目名称（必需）<br>`logstore`：日志存储名称（可选，默认值为空）<br>`size`：返回结果数量上限（默认10）<br>`regionId`：阿里云区域ID | - 确定项目后使用此工具查找相关数据加工任务<br>- 限制返回结果数量避免获取过多数据 |
| `sls_list_maxcompute_exports` | 列出项目内的MaxCompute投递任务 | `project`：SLS项目名称（必需）<br>`logstore`：日志存储名称（可选，默认值为空）<br>`size`：返回结果数量上限（默认10）<br>`regionId`：阿里云区域ID | - 确定项目后使用此工具查找相MaxCompute投递任务<br>- 限制返回结果数量避免获取过多数据 |
| `sls_list_oss_exports` | 列出项目内的OSS投递任务 | `project`：SLS项目名称（必需）<br>`logstore`：日志存储名称（可选，默认值为空）<br>`size`：返回结果数量上限（默认10）<br>`regionId`：阿里云区域ID | - 确定项目后使用此工具查找相关OSS投递任务<br>- 限制返回结果数量避免获取过多数据 |
| `sls_list_osshdfs_exports` | 列出项目内的OSS-HDFS投递任务 | `project`：SLS项目名称（必需）<br>`logstore`：日志存储名称（可选，默认值为空）<br>`size`：返回结果数量上限（默认10）<br>`regionId`：阿里云区域ID | - 确定项目后使用此工具查找相关OSS-HDFS投递任务<br>- 限制返回结果数量避免获取过多数据 |
| `sls_list_scheduled_sqls` | 列出项目内的定时SQL任务 | `project`：SLS项目名称（必需）<br>`logstore`：日志存储名称（可选，默认值为空）<br>`size`：返回结果数量上限（默认10）<br>`regionId`：阿里云区域ID | - 确定项目后使用此工具查找相关定时SQL任务<br>- 限制返回结果数量避免获取过多数据 |
| `sls_list_ingestions` | 列出项目内的OSS导入任务 | `project`：SLS项目名称（必需）<br>`logstore`：日志存储名称（可选，默认值为空）<br>`size`：返回结果数量上限（默认10）<br>`regionId`：阿里云区域ID | - 确定项目后使用此工具查找相关OSS导入任务<br>- 限制返回结果数量避免获取过多数据 |

##### 应用相关
| 工具名称 | 用途 | 关键参数 | 最佳实践 |
Expand Down
Loading