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. 01Logstoreのインデックス項目や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 を1回実行して 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 です。サブコマンドとフラグにはケバブケースを使用します。コマンドの形式の検証または CLI 呼び出しの問題のデバッグを行う場合に限り、references/acceptance-criteria.md を使用します。

参考ドキュメント

ドキュメント説明
references/manage-index-config.mdインデックス設定の形式と、取得/作成/更新/削除コマンドの例
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 のインストール、認証モード、プロファイル

コメント