mcpField
A
alibabacloud-sls-index-config-management

alibabacloud-sls-index-config-management

github.com/aliyun云与 DevOps281281 次安装1 天前更新
代码仓库

关于 alibabacloud-sls-index-config-management

用于管理 Alibaba Cloud SLS Logstore 索引配置的技能,面向执行索引操作、从日志样本生成配置或优化查询的用户。它按请求路由到对应参考文档,并规定云操作的凭据、安全与写入规则。

主要功能

  1. 01查看、创建、更新和删除索引
  2. 02从结构化日志样本生成索引
  3. 03按查询与 SQL 优化索引
  4. 04检查凭据并遵守 RAM 权限要求
  5. 05写入前查阅场景规则

适用场景

  1. 01查看或修改 Logstore 索引字段与 TTL
  2. 02为尚无索引的 Logstore 生成配置
  3. 03根据查询负载降低成本或提升写入吞吐

安装

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

$npx skills add https://github.com/aliyun/alibabacloud-aiops-skills --skill alibabacloud-sls-index-config-management

安装后在 Claude Code 中输入/alibabacloud-sls-index-config-management确认已加载。

包含的文件

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

references/
acceptance-criteria.md
cli-installation-guide.md
generate-index-from-logs.md
manage-index-config.md
manifest.json
optimize-index-config.md
ram-policies.md
related-apis.md
scripts/
user_agent.py

详细介绍

Alibaba Cloud SLS 索引配置管理器

场景说明

将此技能用于 SLS Logstore 索引配置。

本文档仅涵盖触发时的设置、路由和跨场景安全。根据用户的请求,仅阅读所需的参考文档。


前置条件

执行云操作时需进行以下检查;日志样本生成可离线运行。

安装 Aliyun CLI

运行 aliyun version,确认版本为 >= 3.3.8。如果尚未安装或版本过旧,请按照 references/cli-installation-guide.md 安装或更新。

检查 Alibaba Cloud 凭据是否已配置

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

安全规则:

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

RAM 权限要求

遇到 Unauthorized 错误时,向用户提供 references/ram-policies.md。未经明确确认,不得改用其他账号重试。


可观测性

每个会话运行一次 scripts/user_agent.py 以生成 UA,然后在所有云 API 命令中重复使用,包括仅请求的试运行:

SLS_INDEX_USER_AGENT="$(python3 scripts/user_agent.py)" || exit 1
aliyun sls get-index --project <project> --logstore <logstore> \
  --user-agent "$SLS_INDEX_USER_AGENT"

生成的 UA 示例:

AlibabaCloud-Agent-Skills/alibabacloud-sls-index-config-management/59ae5afe2075fc3dc1f0e7e39539c902 skill-version/0.0.1

请求路由

根据用户的请求查阅相应参考文档:

如果用户想要……前往
查看 / 创建 / 更新 / 删除索引,或更改字段、TTL、max_text_len、全文、自动索引发现、log_reduce 等references/manage-index-config.md
为尚无索引的 Logstore 构建索引,或使用用户提供的结构化日志样本从头重建索引references/generate-index-from-logs.md
调整现有索引以支持新的查询 / SQL、降低成本或提高写入吞吐量references/optimize-index-config.md

混合请求很常见(例如:“为这些日志生成索引,然后在 Logstore X 上更新索引”)。请按顺序阅读相关场景文档。


全局规则

  • 未查阅场景参考文档,不得写入。 执行任何写入操作前,请先阅读相关参考文档,并遵循其中的确认、完整请求体、回滚和时序规则。
  • 保留已发现的索引。 除非明确要求,否则更新时保持 line.auto_text_keys 不变;请参阅自动索引发现。
  • 使用准确的 SLS CLI 名称。 产品为 sls;子命令和标志使用 kebab-case。仅在验证命令格式或调试 CLI 调用问题时使用 references/acceptance-criteria.md。

参考文档

文档描述
references/manage-index-config.md索引配置格式,以及 get / create / update / delete 命令示例
references/generate-index-from-logs.md根据用户提供的结构化日志样本推断完整的索引配置
references/optimize-index-config.md针对查询/SQL 工作负载、成本和写入吞吐量优化现有索引
references/related-apis.mdGetIndex / CreateIndex / UpdateIndex / DeleteIndex API 和 CLI 参考
related_apis.yaml此技能依赖的 API 元数据,采用机器可读格式
references/ram-policies.md索引管理所需的最低和完整 RAM 策略
references/acceptance-criteria.mdCLI 调用验收测试
references/cli-installation-guide.mdAliyun CLI 安装、身份验证模式和配置文件

评论

支持 Markdown