mcpField
A
alibabacloud-flink-sql-skill

alibabacloud-flink-sql-skill

github.com/aliyunデータ・データベース28121 回インストール1 日前に更新
リポジトリ

alibabacloud-flink-sql-skill について

Alibaba Cloud Flink SQL ジョブの全ライフサイクルを扱うスキルです。リアルタイム処理ジョブを作成・運用するユーザー向けに、統一 CLI で要件整理、SQL レビュー、検証、デプロイ、運用、性能評価、トラブルシューティングを支援し、クラウド操作には確認と検証の手順を設けています。

主な機能

  1. 01Flink SQL ジョブの全工程をカバー
  2. 02SQL の作成と静的レビュー
  3. 03設定確認とクラウド検証
  4. 04ドラフト、デプロイ、稼働ジョブの管理
  5. 05性能評価と障害調査

活用シーン

  1. 01データ要件から Flink SQL を作成
  2. 02SQL を検証してジョブをデプロイ
  3. 03状態確認と許可された変更の実施
  4. 04実行時の証拠に基づく性能問題の診断

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/aliyun/alibabacloud-aiops-skills --skill alibabacloud-flink-sql-skill

インストール後、Claude Code で/alibabacloud-flink-sql-skillを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

assets/
flink-sql-manager.example.json
requirements.txt
references/
command-reference.md
configuration.md
error-handling.md
execution-protocol.md
git-sync.md
lifecycle.md
manifest.json
output-schemas.md
product-model.md
ram-policies.md
related-apis.md
verification.md
references/diagnosis/
job-deep-anlysis.md
job-observability.md
README.md
sql-perf-diagnosis.md
sql-perf-knowledge.md
references/sql/
concepts.md
connectors.md
engine-versions.md
quickstart.md
README.md
sql-development.md
scripts/
client.py
config_cmd.py
flink_sql_manager.py
git_sync.py
job_operations.py

詳細

Alibaba Cloud Flink SQL スキル

このスキルでは、要件分析、SQL の作成、検証、デプロイから、運用、パフォーマンス評価、トラブルシューティングまで、Flink SQL ジョブのライフサイクル全体を統一 CLI で扱います。

クイックエントリー

  • 統一コマンド:python3 scripts/flink_sql_manager.py <command> [args...]。
  • このスキルにバンドルされているスクリプトとリファレンスを優先してください。必要なワークスペース操作がローカルでは対応されていない場合、またはドキュメントに記載されたローカル手順が失敗した場合に限り、alibabacloud-flink-workspace-ops にフォールバックしてください。まず、そのスキルが読み込まれていることを確認し、読み込まれていない場合はユーザーにインストールを案内してください。
  • クラウドへのリクエストを行う前に、references/manifest.json を読み、references/configuration.md の説明に従って SKILL_SESSION_ID を初期化してください。ID データが欠落しているか無効な場合、クラウドへのリクエストはブロックされます。
  • 複数ステップのタスクを開始する前に、references/lifecycle.md を読んでください。
  • Ververica OpenAPI を初めて呼び出す前に、references/configuration.md に従って設定を確認し、必要に応じて Git を初期化してください。
  • 現在の段階に必要なリファレンスだけを読み込み、ドキュメントを一度にすべて読み込まないでください。
  • プラットフォームのコマンドを実際に実行できない場合は、不足している前提条件を伝え、未実行のコマンドをすべて提示してください。例示用のコマンドを実行済みとして説明してはいけません。

1 つのライフサイクル

ユーザーの現在の段階から開始し、同じライフサイクルに沿って進めてください。

  1. 要件とデータ契約:計算の目的、入力と出力、正確性の制約、実行時の要件を定義します。
  2. SQL の作成と静的レビュー:データ契約を完全な SQL に落とし込み、セマンティクス、設定、バージョン互換性を確認します。
  3. 設定の確認とクラウドでの検証:対象環境、ID、メタデータを確認し、クラウド環境で SQL を検証します。
  4. ドラフトとデプロイ:SQL、設定、デプロイ済みバージョンの整合性を保ちながら、ドラフトとデプロイメントのリソースを管理します。
  5. 起動と受け入れ確認:必要な復元動作を指定してジョブを起動し、実行時の状態と、要求された受け入れ基準を確認します。
  6. 運用と変更:実行中のジョブインスタンス、状態、関連リソースを管理し、読み戻しによる検証を行いながら、安全に変更を完了します。
  7. パフォーマンス評価とトラブルシューティング:実行時の動作を評価し、証拠に基づいてボトルネックや障害を特定し、対応策を提案します。

ユーザーの目的に必要な段階のみを完了してください。許可なくリソースをデプロイ、起動、停止、削除してはいけません。コマンドの実行順序については、references/lifecycle.md を参照してください。

プラットフォーム設定ゲート

Ververica OpenAPI の操作を行う前に、次を実行してください。

python3 scripts/flink_sql_manager.py config_doctor

workspace、namespace、または region が不足している場合は、references/configuration.md に従ってください。不足している実際のスコープのみを尋ね、ユーザーが任意で指定した Git 設定も同じ config_init 呼び出しで保存します。初期化後、config_doctor を再実行してください。終了コードが 0 で、成功が明示的に報告された場合に限り、クラウド操作を続行してください。それ以外の結果(未確認の結果を含む)の場合は、後続のプラットフォームコマンドを停止し、実際のエラーに対処してから、再度チェックを実行してください。

ローカルのみの SQL 設計、作成、または説明では、プラットフォーム設定を待たずに現在の段階を完了してください。クラウドでの検証、またはそれ以降の段階に進む際にゲートを適用してください。

履歴 Metrics では、別途 Cookie 認証を使用するため、SDK の認証情報チェックは適用されません。

必ず実際のリソース識別子を使用してください。workspace、namespace、または region が不足している場合は、上記の初回初期化フローを使用してください。Draft ID、Deployment ID、または Job ID が不足している場合は、ユーザーから提供された情報または読み取り専用クエリから取得してください。プレースホルダー ID を使用して API を呼び出してはいけません。履歴 Metrics 用にユーザーから提供された Cookie を除き、AccessKey ID、AccessKey secret、トークン、パスワードは受け付けないでください。認証情報を表示したり、コミットしたりしてはいけません。

安全性ゲート

CLI では、すべての変更コマンドに --confirm が必要です。エージェントは、次のリスクルールも適用する必要があります。

  • 読み取り専用:スコープが明確で、config_doctor が成功した後に直接実行します。
  • 通常の変更:作成、更新、検証後のデプロイ、開始、登録、および同様の操作です。操作を実行する明示的な依頼は許可とみなし、コマンドに --confirm を追加します。選択肢を尋ねる依頼は許可ではありません。
  • 高リスク:すべての stop_* および delete_* コマンド、停止を伴う再起動やデプロイのフロー、DROP や TRUNCATE などの破壊的な execute_sql 文です。操作の実行を求めるだけでは、高リスク操作への事前確認にはなりません。現在の依頼で高リスク操作とその影響が明示的に確認されており、読み取り専用の解決によって実際の対象と戦略が確認済みのスコープ内に収まると判明した場合は、解決した対象を報告し、再確認を求めずに --confirm を付けて CLI を実行してください。それ以外の場合は、references/output-schemas.md を使って対象、影響、戦略または不可逆な結果、および完全なコマンドを改めて提示し、明示的な確認を待ってください。

事前確認を含む確認は、現在の依頼に含まれる操作と対象にのみ適用されます。複数の対象が該当する場合、スコープが変わる場合、または戦略に重大な曖昧さがある場合は、不足している情報のみを尋ね、確認を再利用しないでください。コマンドが失敗した場合は、依存する手順を停止してください。ID、チケット、状態、または成功した結果を捏造してはいけません。

自動 Git 事後処理は、許可され、成功した Deployment の変更後にのみ実行します。これはプラットフォームの変更自体を許可するものではありません。Git の失敗によってプラットフォームの結果がロールバックされることはありません。ルールの詳細については、references/git-sync.md を参照してください。

ステージ別リファレンス

SQL ソースの優先順位

  1. ユーザーから提供された実際のスキーマ、SQL、エラー、エンジンバージョン、プラットフォームの応答。
  2. 対象の VVR バージョンに対応する Alibaba Cloud Realtime Compute for Apache Flink のドキュメント。
  3. 対応する Flink バージョンの Apache Flink ドキュメント。
  4. references/sql/README.md にある同梱のオフラインリファレンス。

最新の動作、オンラインでのサポート範囲、または現在の Connector オプションについてユーザーから尋ねられた場合は、最新の公式オンラインドキュメントを参照してください。オフラインリファレンスだけでは、プラットフォームの現在の動作を確認できません。

出力ゲート

プラットフォームへのクエリ、診断、操作結果、操作確認を報告する前に、現在のターンで references/output-schemas.md を読み、該当するテンプレートに厳密に従い、送信前にフィールド名、順序、必須フィールドを確認してください。各ステージの結果をまとめてください。高リスク操作の確認は、引き続き操作の前に行います。

すべての結論は、実際のコマンド出力と読み戻しによる証拠に基づく必要があります。失敗した場合は、失敗したステージ、主なエラー、完了した手順と未実行の手順、次に実行可能な復旧アクションを記載してください。リクエストが受け付けられた状態、タイムアウト、一部完了、未確認の状態を、完全な成功として説明しないでください。

開発と評価

  • エージェントの評価には bash evals/run_skill_up.sh を使用します。eval.yaml とケースの両方で Skill Up v1alpha1 を使用し、JSON および HTML のレポートを生成します。
  • ライブのエンドツーエンドテストは、許可されている場合に限り python3 tests/live_api_e2e.py で実行してください。最初に RUN_LIVE_FLINK_E2E=1 を明示的に設定し、SKILL_SESSION_ID を初期化して、テスト用のワークスペースを使用してください。

コメント