stanctl-integration – 統合パッケージ管理のための Instana CLI
CLI stanctl-integration は、 Instana 統合パッケージの管理を効率化するために設計された強力なコマンドラインツールです。 これにより、プラットフォームエンジニア、開発者、および DevOps チームは、 Instana でカスタム要素を定義する統合パッケージを効率的にダウンロード、インポート、エクスポート、lintチェック、初期化、公開できるようになります。
概要
CLI stanctl-integration は、 Instana 統合パッケージの完全なライフサイクルを管理するための包括的なソリューションとして機能します。 統合パッケージを活用することで、カスタムダッシュボードとイベント定義を一貫した自動化された方法で管理します。
主な機能
- パッケージ管理 ：統合パッケージのダウンロード、初期化、リンティング、公開を簡単に行えます。
- リントプロセスによる検証 : パッケージが公開前に品質および書式設定基準を満たしていることを確認する。
メリット
- 効率性 ：手動でのUI操作やカスタム API スクリプトを必要とする反復的なタスクを自動化します。
- 一貫性 ：開発環境、テスト環境、本番環境全体で統一された構成を維持する。
- エラー削減 ：標準化されたパッケージ検証と自動化されたデプロイメントにより、人的ミスを最小限に抑える。
公式設定リポジトリ
実世界の事例、コミュニティ提供のパッケージ、およびツールのサポートについては、公式の GitHub リポジトリ「 Observability as Code Repository」 を参照してください。
このリポジトリは、 IBM Instana チームによって管理されており、以下の中心的な情報源として機能します：
Instana 公式統合パッケージ：様々な技術向けに事前構築され、コミュニティによってレビューされたパッケージ。
パッケージ構成ガイダンス: CLI
stanctl-integrationを使用してダッシュボードとイベント定義を定義する方法を学びます。CLIツール: 事前ビルド済みバイナリをダウンロードするか、提供されている手順に従ってソースからCLIをビルドしてください。
貢献ワークフロー: 新規パッケージや改善点を構造化されたプルリクエストを通じて提出してください。
このCLIツールは、統合パッケージを活用することで、チームが Instana の設定を効率的に管理・標準化するのに役立ちます。 Instana の設定をコードとして採用することで、チームはアプリケーションコードと同様の厳格なバージョン管理、テスト、デプロイメント手法を適用できます。
構文
ターミナルウィンドウからコマンド stanctl-integration を実行するには、次の構文を使用してください：
$ stanctl-integration [command] [options]
利用可能なコマンドとオプションは以下の通りです：
コマンド: 実行したい操作を指定します。例えば
download、import、export、init、lint、、などですpublish。オプション: コマンドの動作を変更するための追加のパラメータやフラグを提供します。例えば
--package、,--server--token,--location, などです。
コマンド
以下の表には、利用可能なすべての stanctl-integration コマンドとその説明が含まれています：
| コマンド | 説明 |
|---|---|
| ダウンロード | レジストリから統合パッケージをローカルディレクトリにダウンロードする。 |
| インポート | 指定された Instana 環境に統合パッケージをインポートします。 |
| エクスポート | Instana 環境から統合要素をローカルファイルにエクスポートする。 |
| 初期化 | 新しい統合パッケージを初期化するための対話型セットアップを開始します。 |
| LINT | 統合パッケージの構造、書式設定、および必須フィールドを検証する。 |
| 公開 | ローカル統合パッケージを共有レジストリに公開する。 |
{: caption="表 1. stanctl-integration コマンド" caption-side="top"} |
コマンドリファレンスと使用例
このセクションでは、各コマンド stanctl-integration の詳細な構文、利用可能なオプション、および実際の使用例について説明します。
ダウンロード
レジストリから統合パッケージをローカルマシンにダウンロードします。
$ stanctl-integration download [options]
| オプション | 説明 |
|---|---|
--package, -p |
(必須): パッケージ名。 |
--location, -l |
(オプション): 統合パッケージを保存する場所（デフォルト: 現在の作業ディレクトリ）。 |
例:
$ stanctl-integration download --package @instana-integration/nodejs --location ./my-packages
インポート
Instana 環境に統合パッケージをインポートします。
$ stanctl-integration import [options]
| オプション | 説明 |
|---|---|
--package, -p |
(必須): パッケージ名またはパッケージへのパス。 |
--server, -S |
(必須): Instana 環境のアドレス。 |
--token, -t |
(必須): 統合パッケージをインポートするための API トークン。 |
--location, -L |
(オプション): 統合パッケージを保存する場所（デフォルト: 現在の作業ディレクトリ）。 |
--include, -i |
(オプション): 統合要素ファイルを一致させて含めるフォルダまたはパターン。 |
--set, -s |
(オプション): パラメータ値は key=value の形式で指定します。 |
--debug, -d |
(オプション): デバッグモードを有効にする (デフォルト: false)。 |
例:
$ stanctl-integration import --package @instana-integration/nodejs --server example.instana.io --token YOUR_API_TOKEN --include "dashboards/**/test-*.json" --set key1=value1 --set key2=value2
エクスポート
Instana 環境から統合要素をエクスポートします。
$ stanctl-integration export [options]
| オプション | 説明 |
|---|---|
--server, -S |
(必須): Instana 環境のアドレス。 |
--token, -t |
(必須): 統合要素をエクスポートするための API トークン。 |
--location, -L |
(オプション): 統合要素を保存する場所（デフォルト: 現在の作業ディレクトリ）。 |
--include, -F |
(オプション): 統合要素のエクスポート対象となる、タイトルなどの異なる側面を一致させるパターン。 |
--debug, -d |
(オプション): デバッグモードを有効にする (デフォルト: false)。 |
例:
$ stanctl-integration export --server example.instana.io --token YOUR_API_TOKEN --include title="foo.*" --location ./my-package
初期化
ガイド付き対話型セットアップで新しい統合パッケージを初期化します。
$ stanctl-integration init
このコマンドは次の入力を求めます：
- パッケージ名
- パッケージ・バージョン
- パッケージの説明
- キーワード
- 作成者
- ライセンス
- 含めるべき統合要素の種類
例:
$ stanctl-integration init
公開
ローカル統合パッケージをレジストリに公開します。
$ stanctl-integration publish [options]
| オプション | 説明 |
|---|---|
--package, -p |
(必須): パッケージ名またはパッケージへのパス。 |
--registry-username, -U |
(必須): 統合パッケージレジストリにアクセスするためのユーザー名。 |
--registry-email, -E |
(必須): 統合パッケージレジストリにアクセスするには Email が必要です。 |
例:
$ stanctl-integration publish --package @instana-integration/nodejs --registry-username your-username --registry-email your-email@example.com
LINT
統合パッケージがベストプラクティスに従っていることを保証するためのリンティングを提供します。
$ stanctl-integration lint [options]
| オプション | 説明 |
|---|---|
--path, -p |
(オプション): パッケージへのパス。 |
--strict-mode, -s |
(オプション): 検証を制限します。 |
--debug, -d |
(オプション): デバッグモードを有効にする (デフォルト: false)。 |
例:
$ stanctl-integration lint --path ./my-package --strict-mode --debug
トラブルシューティング
よくある問題
認証の失敗
- API トークンに必要な権限が設定されていることを確認してください。
- 正しいサーバーアドレスを使用していることを確認してください。
- トークンが期限切れでないことを確認してください。
パッケージが見つかりません
- パッケージ名が正しいことを確認してください。
- パッケージがレジストリに存在するかどうかを確認する。
- レジストリへのネットワーク接続が確立されていることを確認してください。
インポート/エクスポートの失敗
- より詳細なエラー情報を取得するには
--debug、`-debug` オプションでデバッグモードを有効にしてください。 - JSON ファイルが適切にフォーマットされていることを確認してください。
- サーバーアドレスが正しく、アクセス可能であることを確認してください。
- より詳細なエラー情報を取得するには
SSL / TLS Issues
- CLIは、自己署名証明書エラーを無視するカスタム HTTPS エージェントを使用します。
- 企業プロキシ経由でアクセスしている場合は、プロキシ設定が正しく構成されていることを確認してください。
デバッグ・モード
ほとんどのコマンドは、より詳細なログ情報を --debug 提供するオプションをサポートしています。 このフラグを使用して問題をトラブルシューティングしてください:
$ stanctl-integration import --package my-package --server example.com --token YOUR_TOKEN --debug
終了コード
CLIは以下の終了コードを使用します：
0コマンドは正常に実行されました。1コマンド実行中に発生した一般的なエラー。-1リンティングがエラーで失敗しました。