このページは Cloud Translation API によって翻訳されました。

プロジェクトからアラートルールを作成する

GDC コンソールで、プロジェクトの指標またはログのアラートルールを含むグループを作成します。指標ルールは指標データに基づいてアラートを送信し、ログルールはロギングデータに基づいてアラートを送信します。アラートを保留状態にするかどうかを決定するクエリ言語式を入力する必要があります。また、ラベルやアノテーションなどの省略可能な値を含めることもできます。

ラベルを使用すると、アラートの特性を Key-Value ペアのマップとして区別できます。ラベルを使用して、重大度レベル（エラー、重大、警告、情報）、アラートコード、リソースを識別する短い名前などの情報を追加または上書きします。

一方、アノテーションを使用して、非識別的なメタデータをアラートに追加します。たとえば、ユーザーインターフェース（UI）のフィールドに表示されるメッセージや式の値、または解決アクションに役立つランブック URL を含めることができます。

また、Observability API を使用してアラートルールを作成し、カスタムリソースを直接操作して、プロジェクト Namespace の変更を更新することもできます。

始める前に

続行する前に、次の必要な権限があることを確認してください。

ログに基づいてアラートルールを作成する

ログに基づいてアラートルールを作成または表示するために必要な権限を取得するには、プロジェクトの IAM 管理者に、プロジェクトの Namespace で次のいずれかのロールを付与するよう依頼します。

ロギングルール作成者: LoggingRule カスタムリソースを作成します。Logging ルール作成者（loggingrule-creator）ロールをリクエストします。
ロギングルールエディタ: LoggingRule カスタムリソースを編集または変更します。Logging ルール編集者（loggingrule-editor）ロールをリクエストします。
ロギングルール閲覧者: LoggingRule カスタムリソースを表示します。ロギングルール閲覧者（loggingrule-viewer）ロールをリクエストします。

指標に基づいてアラートルールを作成する

指標に基づいてアラートルールを作成または表示するために必要な権限を取得するには、プロジェクトの IAM 管理者に、プロジェクト Namespace で次のいずれかのロールを付与するよう依頼します。

モニタリングルールエディタ: MonitoringRule カスタムリソースを編集または変更します。モニタリングルール編集者（monitoringrule-editor）のロールをリクエストします。
モニタリングルール閲覧者: MonitoringRule カスタムリソースを表示します。モニタリングルール閲覧者（monitoringrule-viewer）ロールをリクエストします。

ロールの割り当ての詳細については、事前定義ロールの説明をご覧ください。

ルールの作成

アラートルールは、推奨の方法である GDC コンソールを使用するか、プロジェクト Namespace で Observability API を使用してカスタムリソースをデプロイすることで作成できます。

コンソール

次の手順に沿って、GDC コンソールからアラートルールを作成します。

GDC コンソールで、プロジェクトを選択します。
ナビゲーションメニューで、[オペレーション] > [アラート] をクリックします。
[アラートポリシー] タブをクリックします。
[ルールグループを作成] をクリックします。
[指標] または [ログ] のどちらのグループを作成するかを選択します。指標ルールはシステムモニタリングデータに基づいてアラートを送信し、ロギングルールはシステムロギングデータに基づいてアラートを送信します。
[アラートルールグループ名] フィールドに、グループの名前を入力します。
[ルール評価間隔] フィールドに、各間隔の秒数を入力します。
[上限] フィールドに、アラートの最大数を入力します。アラートを無制限にする場合は、0 と入力します。
[アラートルール] セクションで、[アラートルールを作成] をクリックします。
アラートルールの名前を入力します。
アラートルールの式を入力します。
- システムロギングルールの場合は、LogQL（ログクエリ言語）式を入力します。
- システムモニタリングルールの場合は、PromQL（Prometheus Query Language）式を入力します。
この式は、アラートを保留状態にするかどうかを決定する真または偽のステートメントに評価される必要があります。

注: アラートルールの条件が最初に発生すると、アラートは保留状態に移行します。次の期間に条件が true になると、アラートはオープン状態に移行します。その時点で、オブザーバビリティシステムがアラートを送信します。
[期間] フィールドに、アクティブなアラートが保留状態からオープン状態に移行するまでの秒数を入力します。注: 期間を 0 に設定すると、条件が満たされた直後に Observability システムからアラートが送信されます。
[重大度] フィールドで、重大度レベル（[エラー] や [警告] など）を選択します。
関連リソースを識別する短縮名（AIS、DHCP など）を入力します。
アラートを識別するためのアラートコードを入力します。
問題の解決に役立つランブックの URL または情報を入力します。
アラートのメッセージまたは説明を入力します。
省略可: [ラベルを追加] をクリックして、ラベルを Key-Value ペアとして追加します。
省略可: [アノテーションを追加] をクリックして、アノテーションを Key-Value ペアとして追加します。
[保存] をクリックして、ルールを作成します。
[作成] をクリックして、ルールグループを作成します。ルールグループが [アラートルールグループ] リストに表示されます。

API

カスタムリソースをデプロイすることで、Observability API を使用して GDC でシステムモニタリングとロギングのルールを作成できます。MonitoringRule または LoggingRule カスタムリソースは、条件を形成する 1 つ以上のクエリと式、評価の頻度、必要に応じて条件が満たされる期間で構成されます。

次の手順に沿って、プロジェクト Namespace にカスタムリソースをデプロイしてアラートルールを作成します。

モニタリングまたはロギングのアラートルールに次のテンプレートを使用して、カスタムリソースの YAML ファイルを作成します。
- システムモニタリングルールを作成し、指標データに基づいてアラートを送信するには、MonitoringRule カスタムリソースを使用します。
- システムロギングルールを作成し、ロギングデータに基づいてアラートを送信するには、LoggingRule カスタムリソースを使用します。
カスタムリソースの namespace フィールドに、プロジェクトの Namespace を入力します。
[name] フィールドに、アラートルールの構成の名前を入力します。
省略可: ロギングルールの LoggingRule カスタムリソースを構成する場合は、source フィールドでアラートのログソースを選択できます。たとえば、operational や audit などの値を入力します。
[interval] フィールドに、ルール評価間隔の期間（秒単位）を入力します。
省略可: [limit] フィールドに、アラートの最大数を入力します。アラートを無制限にする場合は、「0」と入力します。
省略可: 指標を計算して記録ルールを構成する場合は、recordRules フィールドに次の情報を入力します。
- [record] フィールドに録音名を入力します。この値は、記録ルールを書き込む時系列を定義します。有効な指標名である必要があります。
- expr フィールドに、次のように記録ルールの式を入力します。
  - システムロギングルールの場合は、LogQL（ログクエリ言語）式を入力します。
  - システムモニタリングルールの場合は、PromQL（Prometheus Query Language）式を入力します。
  この式は、新しい指標として記録される数値に解決される必要があります。
- 省略可: labels フィールドで、追加または上書きするラベルを Key-Value ペアとして定義します。
alertRules フィールドに次の情報を入力して、アラートルールを構成します。
- [alert] フィールドにアラート名を入力します。
- [expr] フィールドに、アラートルールの式を入力します。
  - システムロギングルールの場合は、LogQL 式を入力します。
  - システムモニタリングルールの場合は、PromQL 式を入力します。
  この式は、アラートを保留状態にするかどうかを決定する真または偽のステートメントに評価される必要があります。
- 省略可: [for] フィールドに、アラートを保留状態からオープン状態に移行するために、指定された条件を満たす必要がある期間（秒単位）を入力します。別の値を指定しない場合のデフォルトの期間は 0 秒です。
  
  注: アラートルールの条件が最初に発生すると、アラートは保留状態に移行します。次の期間に条件が true になると、アラートはオープン状態に移行します。その時点で、オブザーバビリティシステムがアラートを送信します。また、期間を 0 の値に設定すると、条件が満たされた直後にアラートが送信されます。
- labels フィールドで、追加または上書きするラベルを Key-Value ペアとして定義します。次のラベルが必要です。
  - severity: 重大度レベル（error、critical、warning、info など）を選択します。
  - code: アラートを識別するアラートコードを入力します。
  - resource: 関連するリソースを識別する短縮名（AIS や DHCP など）を入力します。
- 省略可: annotations フィールドに、Key-Value ペアとしてアノテーションを追加します。
カスタムリソースの YAML ファイルを保存します。
管理クラスタのプロジェクト Namespace にカスタムリソースをデプロイして、アラートルールを作成します。

カスタムリソースからシステムロギングとモニタリングのルールを構成する

このセクションには、カスタムリソースをデプロイしてアラートルールを作成するために使用する必要がある YAML テンプレートが含まれています。GDC コンソールからアラートを作成する場合は、このセクションをスキップできます。

`MonitoringRule` カスタムリソース

システムモニタリングルールを作成するには、MonitoringRule カスタムリソースを作成する必要があります。MonitoringRule は、アラートを送信する条件を記述する記録ルールとアラートルールで構成されます。

次の YAML ファイルは、MonitoringRule カスタムリソースのテンプレートを示しています。

# Configures either an alert or a target record for precomputation
apiVersion: monitoring.gdc.goog/v1
kind: MonitoringRule
metadata:
  # Choose namespace that matches the project namespace
  # Note: The alert or record will be produced in the same namespace
  namespace: PROJECT_NAMESPACE
  name: alerting-config
spec:
  # Rule evaluation interval
  interval: 60s

  # Configure limit for number of alerts (0: no limit)
  # Optional. Default: 0 (no limit)
  limit: 0

  # Configure recording rules to generate new metrics based on pre-existing metrics.
  # Recording rules precompute expressions that are frequently needed or computationally expensive.
  # These rules save their result as a new set of time series.
  recordRules:
    # Define which timeseries to write to. The value must be a valid metric name.
  - record: MyMetricsName

    # Define PromQL expression to evaluate for this rule
    expr: rate({service_name="bob-service"} [1m])

    # Define labels to add or overwrite
    # Optional. Map of key-value pairs
    labels:
      <label_key>: <label_value>

  # Configure alert rules
  alertRules:
    # Define alert name 
  - alert: <string>

    # Define PromQL expression to evaluate for this rule
    # https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/
    expr: rate({service_name="bob-service"} [1m])

    # Define when an active alert moves from pending to open
    # Optional. Default: 0s
    for: 0s

    # Define labels to add or overwrite
    # Required, Map of key-value pairs
    # Required labels:
    #     severity: [error, critical, warning, info]
    #     code:
    #     resource: component/service/hardware related to the alert
    #     additional labels are optional
    labels:
      severity: error
      code: 202
      resource: AIS
      <label_key>: <label_value>

    # Define annotations to add
    # Optional. Map of key-value pairs
    # Recommended annotations:
    #     message: value of Message field in UI
    #     expression: value of Rule field in UI
    #     runbookurl: URL for link in Actions to take field in UI
    annotations:
      <label_key>: <label_value>

PROJECT_NAMESPACE は、プロジェクトの Namespace に置き換えます。

`LoggingRule` カスタムリソース

システムロギングルールを作成するには、LoggingRule カスタムリソースを作成する必要があります。LoggingRule は、アラートを送信する条件を記述する記録ルールとアラートルールで構成されます。

# Configures either an alert or a target record for precomputation
apiVersion: logging.gdc.goog/v1
kind: LoggingRule
metadata:
  # Choose namespace that matches the project namespace
  # Note: The alert or record will be produced in the same namespace
  namespace: PROJECT_NAMESPACE
  name: alerting-config
spec:
  # Choose which log source to base alerts on (Operational/Audit Logs)
  # Optional. Default: Operational
  source: operational

  # Rule evaluation interval
  interval: 60s

  # Configure limit for number of alerts (0: no limit)
  # Optional. Default: 0 (no limit)
  limit: 0

  # Configure recording rules to generate new metrics based on pre-existing logs.
  # Recording rules generate metrics based on logs.
  # Use recording rules for complex alerts, which query the same expression repeatedly every time they are evaluated.
  recordRules:
    # Define which timeseries to write to. The value must be a valid metric name.
  - record: MyMetricsName

    # Define LogQL expression to evaluate for this rule
    # https://grafana.com/docs/loki/latest/rules/
    expr: rate({service_name="bob-service"} [1m])

    # Define labels to add or overwrite
    # Optional. Map of key-value pairs
    labels:
      <label_key>: <label_value>

  # Configure alert rules
  alertRules:
    # Define alert name
  - alert: <string>

    # Define LogQL expression to evaluate for this rule
    expr: rate({service_name="bob-service"} [1m])

    # Define when an active alert moves from pending to open
    # Optional. Default: 0s
    for: 0s

    # Define labels to add or overwrite
    # Required, Map of key-value pairs
    # Required labels:
    #     severity: [error, critical, warning, info]
    #     code:
    #     resource: component/service/hardware related to alert
    #     additional labels are optional
    labels:
      severity: warning
      code: 202
      resource: AIS
      <label_name>: <label_value>

    # Define annotations to add
    # Optional. Map of key-value pairs
    # Recommended annotations:
    #     message: value of Message field in UI
    #     expression: value of Rule field in UI
    #     runbookurl: URL for link in Actions to take field in UI
    annotations:
      <label_name>: <label_value>

PROJECT_NAMESPACE は、プロジェクトの Namespace に置き換えます。

プロジェクトからアラートルールを作成する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

始める前に

ログに基づいてアラート ルールを作成する

指標に基づいてアラート ルールを作成する