ログと指標

このページでは、Google Distributed Cloud がオペレーションに関するさまざまな種類の情報をログに記録する方法と、その情報を表示する方法について説明します。一部の種類のログと指標の収集には追加料金が発生します。詳細については、ログと指標の課金をご覧ください。

ロギングとモニタリングの構成

ログと指標の収集を開始する前に、次の操作を行う必要があります。

  1. 次のコマンドを使用して、ロギング API を有効にします。

    gcloud services enable opsconfigmonitoring.googleapis.com --project PROJECT_ID
    gcloud services enable logging.googleapis.com --project PROJECT_ID
    gcloud services enable monitoring.googleapis.com --project PROJECT_ID
    

    PROJECT_ID は、ターゲット Google Cloud プロジェクトの ID に置き換えます。

  2. ログと指標の書き込みに必要なロールを付与します。

    gcloud projects add-iam-policy-binding PROJECT_ID \
        --role roles/opsconfigmonitoring.resourceMetadata.writer \
        --member "serviceAccount:PROJECT_ID.svc.id.goog[kube-system/metadata-agent]"
    
    gcloud projects add-iam-policy-binding PROJECT_ID \
        --role roles/logging.logWriter \
         --member "serviceAccount:PROJECT_ID.svc.id.goog[kube-system/stackdriver-log-forwarder]"
    
    gcloud projects add-iam-policy-binding PROJECT_ID \
        --role roles/monitoring.metricWriter \
        --member "serviceAccount:PROJECT_ID.svc.id.goog[kube-system/gke-metrics-agent]"
    

    PROJECT_ID は、ターゲット Google Cloud プロジェクトの ID に置き換えます。

ログ

このセクションでは、Distributed Cloud でサポートされている Cloud Logging リソースタイプの一覧を示します。Distributed Cloud ログを表示するには、 Google Cloud コンソールのログ エクスプローラを使用します。Distributed Cloud ロギングは常に有効になっています。

Distributed Cloud でロギングされるリソースタイプは、次の標準 Kubernetes リソースです。

  • k8s_container
  • k8s_node

Cloud Logging API を使用して、Distributed Cloud ログをキャプチャして取得することもできます。このロギング メカニズムの構成方法については、Cloud Logging クライアント ライブラリのドキュメントをご覧ください。

指標

このセクションでは、Distributed Cloud でサポートされている Cloud Monitoring 指標を示します。Distributed Cloud 指標を表示するには、Google Cloud コンソールの Metrics Explorer を使用します。

Distributed Cloud クラスタの指標

Distributed Cloud クラスタの場合、Distributed Cloud は Distributed Cloud ノードによって生成される次のタイプの指標を提供します。

  • リソース指標は、CPU 負荷やメモリ使用量など、Distributed Cloud ノードと Pod のパフォーマンスに関する情報を提供します。
  • システム アプリケーション指標は、coredns などの Distributed Cloud システム ワークロードに関する情報を提供します。

これらの指標のリストについては、Google Distributed Cloud と Google Distributed Cloud の指標をご覧ください。

Distributed Cloud は、Distributed Cloud クラスタに関連付けられた Kubernetes コントロール プレーンによって生成された指標を提供しません。

Distributed Cloud ハードウェアの指標

Distributed Cloud は、次のリソースタイプを使用して、Distributed Cloud ハードウェアの指標を提供します。

  • edgecontainer.googleapis.com/Machine
  • edgecontainer.googleapis.com/Rack

Machine リソース指標

Distributed Cloud は、edgecontainer.googleapis.com/Machine リソースに対して次の Cloud Monitoring API 指標を書き込みます。

指標 説明
/machine/cpu/total_cores
  • 種類: GAUGE
  • タイプ: INT
マシンに存在する物理プロセッサ コアの合計数。
/machine/cpu/usage_time
  • 種類: CUMULATIVE
  • タイプ: DOUBLE
  • 単位: Seconds
マシン上のすべてのコアの CPU 使用時間の累積。タイプは workload(お客様のワークロード)または system(その他すべて)にできます。
/machine/cpu/utilization
  • 種類: GAUGE
  • タイプ: DOUBLE
マシンの CPU 使用率。範囲は 0 ~ 1 です。タイプは workload(お客様のワークロード)または system(その他すべて)にできます。
/machine/memory/total_bytes
  • 種類: GAUGE
  • タイプ: INT64
マシンの合計メモリのバイト数。
/machine/memory/used_bytes
  • 種類: GAUGE
  • タイプ: INT64
マシンで使用されているメモリのバイト数。memory_typeevictable(カーネルで再利用可能)または non-evictable(再利用不可)のいずれかです。
/machine/memory/utilization
  • 種類: GAUGE
  • タイプ: DOUBLE
マシン上のメモリ使用率。範囲は 0 ~ 1 です。memory_typeevictable(カーネルで再利用可能)または non-evictable(再利用不可)のいずれかです。
/machine/network/up
  • 種類: GAUGE
  • タイプ: BOOL
ネットワーク インターフェースが稼働中かどうかを示します。プライマリ カード、セカンダリ カード、ポートが含まれます。
/machine/network/link_speed
  • 種類: GAUGE
  • タイプ: DOUBLE
  • 単位: バイト/秒
プライマリ ネットワーク インターフェース カードのリンク速度。
/machine/network/received_bytes_count
  • 種類: CUMULATIVE
  • タイプ: DOUBLE
プライマリ ネットワーク インターフェース カードで受信したバイト数。
/machine/network/sent_bytes_count
  • 種類: CUMULATIVE
  • タイプ: DOUBLE
プライマリ ネットワーク インターフェース カードの送信バイト数。
/machine/network/connectivity
  • 種類: GAUGE
  • タイプ: BOOL
プライマリ ネットワーク インターフェース カードがインターネットに接続されているかどうかを示します。
/machine/disk/total_bytes
  • 種類: GAUGE
  • タイプ: INT64
マシン上のディスク容量の合計のバイト数。
/machine/disk/used_bytes
  • 種類: GAUGE
  • タイプ: INT64
マシンで使用されているディスク容量のバイト数。
/machine/disk/utilization
  • 種類: GAUGE
  • タイプ: DOUBLE
マシン上のディスク使用率(パーセント)。範囲は 0 ~ 1 です。
/machine/restart_count
  • 種類: CUMULATIVE
  • タイプ: INT
マシンが再起動した回数。
/machine/uptime
  • 種類: GAUGE
  • タイプ: INT
  • 単位: Seconds
最後の再起動からのマシンの稼働時間。
/machine/connected
  • 種類: GAUGE
  • タイプ: INT64
マシンが Google Cloudに接続されているかどうかを示します。

Rack リソース指標

Distributed Cloud は、edgecontainer.googleapis.com/Rack リソースに対して次の Cloud Monitoring API 指標を書き込みます。

指標 説明
/router/bgp_up
  • 種類: GAUGE
  • タイプ: BOOL
ルーターの BGP ピアリング セッションが稼働中で正常かどうかを示します。router_id は、特定ルーター(ラックあたり最大 2 台)を識別します。
/router/connected
  • 種類: GAUGE
  • タイプ: BOOL
BGP ルーターが Google Cloudに接続されているかどうかを示します。router_id は、特定ルーター(ラックあたり最大 2 台)を識別します。

カスタム アプリケーションのログと指標をエクスポートする

Distributed Cloud は、Distributed Cloud ワークロードで実行されているアプリケーションのログを自動的にエクスポートします。Distributed Cloud ワークロードで実行されているアプリケーションの指標をエクスポートするには、次のセクションで説明するようにアノテーションを付ける必要があります。

ワークロードにアノテーションを付けて指標のエクスポートを有効にする

アプリケーションのカスタム指標の収集を有効にするには、アプリケーションの Service マニフェストまたは Deployment マニフェストに次のアノテーションを追加します。

  • prometheus.io/scrape: "true"
  • prometheus.io/path: "ENDPOINT_PATH"ENDPOINT_PATH は、ターゲット アプリケーションの指標エンドポイントへのフルパスに置き換えます。
  • prometheus.io/port: "PORT_NUMBER": アプリケーションの指標エンドポイントが接続をリッスンするポート。

サンプル アプリケーションを実行する

このセクションでは、カスタムログを書き込み、カスタム指標エンドポイントを公開するアプリケーションを作成します。

  1. 次の Service マニフェストと Deployment マニフェストを my-app.yaml という名前のファイルに保存します。Service に prometheus.io/scrape: "true" というアノテーションが付いていることに注意してください。

    kind: Service
    apiVersion: v1
    metadata:
      name: "monitoring-example"
      namespace: "default"
      annotations:
        prometheus.io/scrape: "true"
    spec:
      selector:
        app: "monitoring-example"
      ports:
        - name: http
          port: 9090
    ---
    apiVersion: apps/v1
    kind: Deployment
    metadata:
      name: "monitoring-example"
      namespace: "default"
      labels:
        app: "monitoring-example"
    spec:
      replicas: 1
      selector:
        matchLabels:
          app: "monitoring-example"
      template:
        metadata:
          labels:
            app: "monitoring-example"
        spec:
          containers:
          - image: gcr.io/google-samples/prometheus-dummy-exporter:latest
            name: prometheus-example-exporter
            imagePullPolicy: Always
            command:
            - /bin/sh
            - -c
            - ./prometheus-dummy-exporter --metric-name=example_monitoring_up --metric-value=1 --port=9090
            resources:
              requests:
                cpu: 100m
    
  2. Deployment と Service を作成します。

    kubectl --kubeconfig apply -f my-app.yaml

アプリケーション ログを表示

コンソール

  1. Google Cloud コンソールで、[ログ エクスプローラ] ページに移動します。

    [ログ エクスプローラ] に移動

  2. [リソース] をクリックします。

  3. [すべてのリソースタイプ] リストで、[Kubernetes Container] を選択します。

  4. [クラスタ名] で、ユーザー クラスタの名前を選択します。

  5. [Namespace name] で default を選択します。

  6. [追加] をクリックしてから、[クエリを実行] をクリックします。

  7. [クエリ結果] セクションで、monitoring-example Deployment からのログエントリを確認できます。次に例を示します。

    {
      "textPayload": "2020/11/14 01:24:24 Starting to listen on :9090\n",
      "insertId": "1oa4vhg3qfxidt",
      "resource": {
        "type": "k8s_container",
        "labels": {
          "pod_name": "monitoring-example-7685d96496-xqfsf",
          "cluster_name": ...,
          "namespace_name": "default",
          "project_id": ...,
          "location": "us-west1",
          "container_name": "prometheus-example-exporter"
        }
      },
      "timestamp": "2020-11-14T01:24:24.358600252Z",
      "labels": {
        "k8s-pod/pod-template-hash": "7685d96496",
        "k8s-pod/app": "monitoring-example"
      },
      "logName": "projects/.../logs/stdout",
      "receiveTimestamp": "2020-11-14T01:24:39.562864735Z"
    }
    

gcloud

  1. gcloud logging read コマンドを使用します。

    gcloud logging read 'resource.labels.project_id="PROJECT_ID" AND \
        resource.type="k8s_container" AND resource.labels.namespace_name="default"'

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

  2. 出力で、monitoring-example Deployment からのログエントリを確認できます。次に例を示します。

    insertId: 1oa4vhg3qfxidt
    labels:
      k8s-pod/app: monitoring-example
      k8s- pod/pod-template-hash: 7685d96496
    logName: projects/.../logs/stdout
    receiveTimestamp: '2020-11-14T01:24:39.562864735Z'
    resource:
      labels:
        cluster_name: ...
        container_name: prometheus-example-exporter
        location: us-west1
        namespace_name: default
        pod_name: monitoring-example-7685d96496-xqfsf
        project_id: ...
      type: k8s_container
    textPayload: |
      2020/11/14 01:24:24 Starting to listen on :9090
    timestamp: '2020-11-14T01:24:24.358600252Z'
    

アプリケーション指標を表示する

サンプル アプリケーションでは、example_monitoring_up という名前のカスタム指標が公開されています。 Google Cloud コンソールで、その指標の値を確認できます。

  1. Google Cloud コンソールで、[Metrics Explorer] ページに移動します。

    [Metrics Explorer] に移動

  2. [Resource types] で [Kubernetes Pod] を選択します。

  3. [指標] で [external/prometheus/example_monitoring_up] を選択します。

  4. このチャートでは、example_monitoring_up の繰り返し値が 1 であることがわかります。

次のステップ