可観測性アクセスAPI
- プラン: Free、Premium、Ultimate
- 提供形態: GitLab.com、GitLab Self-Managed
- ステータス: 実験的機能
GitLab可観測性APIを使用して、トレース、メトリクス、ログをクエリし、ダッシュボードとアラートをプログラムで管理します。
前提条件
- グループで可観測性を有効にする必要があります。セットアップ手順については、GitLab.comでの可観測性のセットアップまたはGitLab Self-Managedでの可観測性のセットアップを参照してください。
- グループのデベロッパー、メンテナー、またはオーナーロールが必要です。
APIキーを取得
- 上部のバーで、検索または移動先を選択して、グループを見つけます。
- 左サイドバーで、可観測性 > API Keysを選択します。
- APIキーをコピーします。
APIリクエストを行う際には、このキーをSIGNOZ-API-KEYヘッダーで使用します。
APIエンドポイント
APIエンドポイントは、GitLabの提供形態によって異なります。
GitLab.com
APIベースURLは次のパターンに従います:
https://<group_id>.gitlab-o11y.com<group_id>をGitLabグループIDに置き換えます。
GitLab Self-Managed
APIベースURLは、グループ用にo11y_service_urlとして設定したURLと同じです。例:
http://<your-instance-ip>:8080APIリクエストを行う
各リクエストにAPIキーをSIGNOZ-API-KEYヘッダーに含めます。
次の例では、ヘルスエンドポイントをクエリします:
curl --header "SIGNOZ-API-KEY: <your_api_key>" \
https://<group_id>.gitlab-o11y.com/api/v1/health<your_api_key>をAPI Keysページのキーに、<group_id>をGitLabグループID (またはSelf-ManagedインスタンスのURL) に置き換えます。
利用可能なAPIエンドポイント
GitLab可観測性はSigNoz APIを使用します。利用可能なエンドポイント、リクエストとレスポンスの形式、および使用例の完全なリストについては、SigNoz API参照を参照してください。