ソフトウェア運用の未来を形作るために、2021 年の State of DevOps アンケートに参加して、あなたの声を聞かせてください。

Cloud Monitoring API の概要

このページでは、Cloud Monitoring API v3 の機能の一部について説明します。

API リファレンス ドキュメントについては、次のいずれかのページをご覧ください。

Monitoring API のプロジェクト名

Monitoring API のすべてのメソッドは、必要な name パラメータを持っています。通常、このパラメータの説明は次のようになります。

必須です。リクエストを実行するプロジェクトです。形式:
projects/[PROJECT_ID_OR_NUMBER]

Monitoring API では、PROJECT_ID_OR_NUMBER の値は次のいずれかを識別します。

  • Google Cloud プロジェクト
  • 指標スコープのスコープ プロジェクトでもある Google Cloud プロジェクト

Monitoring API の一部のメソッドでは、プロジェクトが指標スコープのスコープ プロジェクトであることが必要です。他のメソッドではその必要がありません。一部のメソッドでは、プロジェクトのタイプに応じて、異なる結果を返すことがあります。

これらのメソッドを説明するために、ここでは Monitoring API の以下のリソースを参照する用語である metrics API を使用します。

必要な指標スコープのスコープ プロジェクト

指標 API に含まれていないすべての Monitoring API メソッドには、指標スコープのスコープ プロジェクトを参照するための name パラメータが必要です。

指標スコープのスコープ プロジェクトは不要

指標 API のいずれのメソッドも、指標スコープのスコープ対象プロジェクトを参照するために name パラメータを必要としませんが、一部のメソッドは次の場合に異なる動作をします。

  • 指標 API の次のメソッドは、指定された Cloud プロジェクトで動作します。これらのメソッドは、プロジェクトが指標スコープのスコープ対象プロジェクトであるかどうかにかかわらず、指定されたプロジェクト内のデータにのみ影響します。

    • timeSeries.create
    • metricDescriptors.create
    • metricDescriptors.delete
    • metricDescriptors.get
    • monitoredResourceDescriptors.get

  • Metrics API の残りのメソッドは次のように動作します。

    • 指定されたプロジェクトが指標スコープのスコープ対象プロジェクトでない場合、このメソッドは指定されたプロジェクトからのみデータを取得します。
    • 指定されたプロジェクトが、指標スコープのスコープ対象プロジェクトである場合、このメソッドは指定したプロジェクトとそのモニタリング対象プロジェクトの両方からデータを取得します。

    このグループのメソッドは次のとおりです。

    • timeSeries.list
    • timeSeries.query
    • metricDescriptors.list
    • monitoredResourceDescriptors.list

Cloud プロジェクトを指標スコープのスコープ プロジェクトとして設定する方法については、Monitoring 用のプロジェクトの構成を参照してください。

API リソース

指標

Monitoring API を使用すると、Google Cloud と Amazon Web Services から 1,500 種類を超える Cloud Monitoring 指標にアクセスできます。独自のカスタム指標を作成したり、グループを使用してクラウド リソースを整理することができます。

指標概念とそれらを表すデータ構造の概要については、指標、時系列、リソースを参照してください。

カスタム指標や組込み指標を管理する方法については、カスタム指標の使用を参照してください。

使用可能な指標の詳細リストについては、指標リストを参照してください。

モニタリング対象リソース

モニタリング対象リソースは、指標が収集される対象です。たとえば、VM インスタンスやハードウェアの一部のアクティビティなどがあります。

使用可能なモニタリング対象リソースの一覧については、モニタリング対象リソースの一覧をご覧ください。

モニタリング対象リソースのグループ

グループは、監視対象リソースの動的コレクションです。 いつも Monitoring Console でグループを手動で作成できていました。また、Cloud Monitoring API を使用して、グループを作成して使用するコードを作成することもできます。

詳しくは、Group の API リファレンスをご覧ください。

通知ポリシー

通知ポリシーは、インシデントを生成するための条件と、インシデントが作成されたときに通知する方法を記述する構成リソースです。通知のコンセプトでは、通知ポリシーの基本コンセプトについて説明します。詳しくは、AlertPolicy の API リファレンスをご覧ください。

この API では、2 つの指標の比率に基づいてアラート ポリシーを作成することもできます。現時点では、Google Cloud Console で Monitoring を使用して比率を作成することはできません。詳細については、AlertPolicy リファレンスの MetricThreshold をご覧ください。

通知チャネル

通知チャネルは、インシデントが発生したときに通知する方法を記述する構成リソースです。通知チャネルは、さまざまな種類の通信サービスとエンドポイントを参照できます。これらは記述子で指定します。記述子によって、チャネル オブジェクトに含まれる構成パラメータのセットが決まります。

詳細については、NotificationChannel リファレンスと NotificationChannelDescriptor リファレンスをご覧ください。

サービスのモニタリング

サービスのモニタリング リソースを使用して、サービスの状態のモニタリングに使用できるサービスレベルの目標を設定します。

Service Monitoring は、Monitoring API に次のリソースを追加します。

これらのサービス モニタリングのコンセプトと API の使用方法について詳しくは、SLO のモニタリングをご覧ください。

ダッシュボード

Dashboards エンドポイントを使用して、ダッシュボードとグラフの両方をプログラムで作成して操作できます。このエンドポイントを使用してダッシュボードとグラフを管理する方法については、API によるダッシュボードの管理をご覧ください。

Monitoring Query Language

Monitoring Query Language（MQL）では、Cloud Monitoring 時系列データをクエリするためのテキストベースのインターフェースが提供されています。MQL はパイプクエリ モデルを使用し、Monitoring フィルタよりも表現力があります。MQL クエリは Monitoring API またはクエリエディタから使用できます。

MQL の一般的な情報については、Monitoring Query Language の使用をご覧ください。

Monitoring API を使用し、MQL を使用して時系列データを取得する方法については、timeSeries.query メソッドの API リファレンスをご覧ください。

Monitoring API を使用して、MQL ベースのグラフを含むダッシュボードを作成する方法については、TimeSeriesQuery オブジェクトの API リファレンスをご覧ください。このオブジェクトは、グラフまたはスコアカードのデータセットを取得するメカニズムを提供します。

フィルタ

Monitoring API は、フィルタを使用して、指標の選択、時系列データの取得、グループへのモニタリング対象リソースの収集を行います。 詳細については、モニタリング フィルタをご覧ください。

Monitoring API では、フィルタを使用して特定の list オペレーションの結果のセットを制限します。alertPolicies.list メソッドと notificationChannels.list メソッドの結果の管理の詳細については、並べ替えとフィルタリングをご覧ください。

次のステップ