mcpField
A
alibabacloud-sls-cli-guidance

alibabacloud-sls-cli-guidance

github.com/aliyun云与 DevOps14215 次安装17 周前更新
代码仓库

关于 alibabacloud-sls-cli-guidance

alibabacloud-sls-cli-guidance 是一项技能，通过 aliyun-cli 及其 SLS 插件管理阿里云日志服务资源。它聚焦资源运维而非日志查询，并提供安全更新、删除和凭证处理指引。

主要功能

  1. 01管理项目和 Logstore
  2. 02配置索引与 Logtail 管道
  3. 03管理机器组及配置分配
  4. 04向 Logstore 写入 JSON 日志
  5. 05使用 dry-run 验证命令

适用场景

  1. 01创建或更新 SLS 项目和 Logstore
  2. 02配置日志采集与索引
  3. 03将 Logtail 配置应用到机器组
  4. 04在破坏性操作前检查命令参数

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/aliyun/aliyun-sls-agent-skills --skill alibabacloud-sls-cli-guidance

安装后在 Claude Code 中输入/alibabacloud-sls-cli-guidance确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
alibabacloud-sls-query-installation.md
cli-installation-guide.md
index.md
logstore.md
logtail-config.md
machine-group.md
project.md
put-json-logs.md
troubleshooting.md

详细介绍

Aliyun SLS CLI

用于管理阿里云日志服务（SLS）资源的命令行界面，包括项目、日志库、Logtail 配置、机器组以及其他非查询操作。

前置条件

开始前，请确认已安装 aliyun-cli 和 sls 插件：

aliyun version
aliyun sls version

预期输出：aliyun-cli-sls 0.1.0 (5e6288421) 或类似内容

安装（如果尚未安装）

如果检查失败，请按照 references/cli-installation-guide.md 安装 aliyun-cli，然后安装 sls 插件：

aliyun plugin install --names sls
更新插件
aliyun plugin update sls
检查是否已配置阿里云凭证

运行 aliyun configure list 检查是否已配置凭证。 如果没有显示有效的配置文件，请在此处停止，并要求用户在本会话之外运行 aliyun configure。

安全规则：

  • 绝不读取、回显或打印 AK/SK 值
  • 绝不要求用户在对话中粘贴 AK/SK
  • 仅使用 aliyun configure list 检查凭证状态

可观测性

加载此技能时，为本次会话生成一个随机会话 ID：一个由 32 个小写十六进制字符组成的字符串。

每个调用云 API 的 aliyun 命令都必须包含此 User-Agent 标志：

--user-agent "AlibabaCloud-Agent-Skills/alibabacloud-sls-cli-guidance/{session-id}"

本地实用程序命令不会调用云 API，因此不应包含 --user-agent，包括 aliyun version、aliyun configure ...、aliyun plugin ... 和 aliyun help ...。

示例：

aliyun sls list-project \
  --offset 0 --size 50 \
  --user-agent "AlibabaCloud-Agent-Skills/alibabacloud-sls-cli-guidance/a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"

日志查询与分析

所有日志查询和分析任务都请使用 alibabacloud-sls-query 技能。该技能涵盖 SLS 查询与分析语法（索引搜索、SQL、SPL）、场景示例、故障排查以及端到端查询工作流，是查询 SLS 日志的必需技能。

当用户要求进行以下操作时，请使用 alibabacloud-sls-query：

  • 查询日志、分析日志或排查查询结果
  • 编写、解释、优化或执行 SLS 索引搜索、SQL、SQL 扫描或 SPL
  • 将自然语言转换为 SLS 查询、SQL 或 SPL 语句
  • 调试 get-logs-v2、查询语法、索引／统计信息前置条件

如果该技能已可用，请直接使用。如果尚不可用，请参阅 alibabacloud-sls-query-installation 进行安装并加载。

常见操作

对于项目、日志库、索引管理、Logtail 配置、机器组、put-logs 及其他非查询 SLS 操作，请继续使用此技能，并参阅下方的参考文档。执行任何操作前，请先阅读相应的参考文件。

参考文档相关命令描述
projectlist-project create-project get-project update-project delete-project管理 SLS 项目
logstorelist-log-stores create-log-store get-log-store update-log-store delete-log-store管理项目中的日志库
indexget-index create-index update-index delete-index配置索引以启用查询和 SQL 分析
put-json-logsput-json-logs向日志库写入日志
logtail-configcreate-logtail-pipeline-config update-logtail-pipeline-config get-logtail-pipeline-config list-logtail-pipeline-config delete-logtail-pipeline-config管理用于日志采集的 Logtail 管道配置（文件输入、JSON／分隔符／正则表达式解析、多行、时间提取）
machine-groupcreate-machine-group update-machine-group get-machine-group list-machine-group delete-machine-group apply-config-to-machine-group remove-config-from-machine-group get-applied-configs管理机器组，并向其应用 Logtail 配置

CLI 用法

发现 API
aliyun help sls
aliyun help sls <apiName>
验证命令语法（试运行）

添加 --cli-dry-run，可在不执行命令的情况下验证参数：

aliyun sls list-project --offset 0 --size 50 --cli-dry-run
输出格式

默认情况下，所有命令都返回 JSON。使用 --cli-query 和 JMESPath 表达式筛选输出：

aliyun sls list-project --cli-query "projects[*].name"
全局参数
  • --cli-dry-run：验证命令，但不执行
  • --cli-query <jmespath>：使用 JMESPath 筛选输出
  • --region <region>：覆盖区域设置
  • --help：显示命令帮助

故障排查

当命令失败或返回意外结果时，请阅读 references/troubleshooting.md 查看完整检查清单，其中包括：

  • CLI 和插件版本问题
  • 凭证和区域配置
  • 常见错误（ProjectNotExist、Unauthorized、InvalidParameter 等）
  • 跨区域项目发现（针对 ProjectNotExist）

规则

  1. 不要使用已弃用的 API——请使用当前的替代项，以确保行为持续受支持且可预测。

    已弃用替代项
    get-logsget-logs-v2

  2. 执行任何删除操作前，必须先获得用户明确批准——删除操作不可撤销。

  3. 对于破坏性操作（删除、更新），请先使用 --cli-dry-run。

  4. 更新 API 需要完整参数——先调用对应的 Get API 获取当前参数，然后在更新调用中包含所有有意义的参数（包括未更改的参数）。省略参数可能会将其重置为默认值。

  5. 如果命令失败：请按照 references/troubleshooting.md 中的说明操作。

  6. 使用技能 alibabacloud-sls-query 进行日志查询和分析。

评论

支持 Markdown