7.2. サーバーレス開発者メトリクス

メトリクスを使用すると、開発者は Knative サービスのパフォーマンスを監視できます。OpenShift Container Platform モニターリングスタックを使用して、Knative サービスのヘルスチェックおよびメトリクスを記録し、表示できます。

OpenShift Container Platform Web コンソール Developer パースペクティブの Dashboards に移動すると、OpenShift Serverless のさまざまなメトリクスを表示できます。

警告

サービスメッシュが mTLS で有効にされている場合、サービスメッシュが Prometheus のメトリクスの収集を阻止するため、Knative Serving のメトリクスはデフォルトで無効にされます。

この問題の解決については、Enabling Knative Serving metrics when using Service Mesh with mTLS の有効化を参照してください。

メトリクスの収集は、Knative サービスの自動スケーリングには影響しません。これは、収集要求がアクティベーターを通過しないためです。その結果、Pod が実行していない場合に収集が行われることはありません。

7.2.1. デフォルトで公開される Knative サービスメトリクス

表7.1 ポート 9090 の各 Knative サービスについてデフォルトで公開されるメトリクス
メトリクス名、単位、およびタイプ	説明	メトリックのタグ
`queue_requests_per_second` メトリックの単位: dimensionless メトリックのタイプ: ゲージ	キュープロキシーに到達する、1 秒あたりのリクエスト数。 Formula: `stats.RequestCount / r.reportingPeriodSeconds` `stats.RequestCount` は、指定のレポート期間のネットワーク `pkg` 統計から直接計算されます。	destination_configuration="event-display", destination_namespace="pingsource1", destination_pod="event-display-00001-deployment-6b455479cb-75p6w", destination_revision="event-display-00001"
`queue_proxied_operations_per_second` メトリックの単位: dimensionless メトリックのタイプ: ゲージ	1 秒あたりのプロキシー化された要求の数。 Formula: `stats.ProxiedRequestCount / r.reportingPeriodSeconds` `stats.ProxiedRequestCount` は指定されたレポート期間のネットワーク `pkg` 統計から直接計算されます。
`queue_average_concurrent_requests` メトリックの単位: dimensionless メトリックのタイプ: ゲージ	この Pod で現在処理されている要求の数。平均同時実行性は、ネットワークの `pkg` 側で次のように計算されます。 `req` の変更が行われると、変更間の時間デルタが計算されます。この結果に基づいて、デルタ上の現在の同時実行数が計算され、現在計算されている同時実行数に追加されます。また、デルタの合計が保持されます。デルタでの現在の同時実行処理は、以下のように計算されます。 `global_concurrency` × デルタレポートが実行されるたびに、合計および現在の計算された同時実行性がリセットされます。平均同時実行値を報告すると、現在の計算処理はデルタの合計で除算されます。新しいリクエストが出されると、グローバル同時実行カウンターが増えます。リクエストが完了すると、カウンターが減少します。	destination_configuration="event-display", destination_namespace="pingsource1", destination_pod="event-display-00001-deployment-6b455479cb-75p6w", destination_revision="event-display-00001"
`queue_average_proxied_concurrent_requests` メトリックの単位: dimensionless メトリックのタイプ: ゲージ	この Pod で現在処理されているプロキシー要求の数: `stats.AverageProxiedConcurrency`	destination_configuration="event-display", destination_namespace="pingsource1", destination_pod="event-display-00001-deployment-6b455479cb-75p6w", destination_revision="event-display-00001"
`process_uptime` メトリック単位: 秒メトリックのタイプ: ゲージ	プロセスが起動している秒数。	destination_configuration="event-display", destination_namespace="pingsource1", destination_pod="event-display-00001-deployment-6b455479cb-75p6w", destination_revision="event-display-00001"

表7.2 ポート 9091 の各 Knative サービスについてデフォルトで公開されるメトリクス
メトリクス名、単位、およびタイプ	説明	メトリックのタグ
`request_count` メトリックの単位: dimensionless メトリックの型: counter	`queue-proxy` にルーティングされる要求の数。	configuration_name="event-display", container_name="queue-proxy", namespace_name="apiserversource1", pod_name="event-display-00001-deployment-658fd4f9cf-qcnr5", response_code="200", response_code_class="2xx", revision_name="event-display-00001", service_name="event-display"
`request_latencies` メトリックの単位: ミリ秒メトリックのタイプ: histogram	応答時間 (ミリ秒単位)。	configuration_name="event-display", container_name="queue-proxy", namespace_name="apiserversource1", pod_name="event-display-00001-deployment-658fd4f9cf-qcnr5", response_code="200", response_code_class="2xx", revision_name="event-display-00001", service_name="event-display"
`app_request_count` メトリックの単位: dimensionless メトリックの型: counter	`user-container` にルーティングされる要求の数。	configuration_name="event-display", container_name="queue-proxy", namespace_name="apiserversource1", pod_name="event-display-00001-deployment-658fd4f9cf-qcnr5", response_code="200", response_code_class="2xx", revision_name="event-display-00001", service_name="event-display"
`app_request_latencies` メトリックの単位: ミリ秒メトリックのタイプ: histogram	応答時間 (ミリ秒単位)。	configuration_name="event-display", container_name="queue-proxy", namespace_name="apiserversource1", pod_name="event-display-00001-deployment-658fd4f9cf-qcnr5", response_code="200", response_code_class="2xx", revision_name="event-display-00001", service_name="event-display"
`queue_depth` メトリックの単位: dimensionless メトリックのタイプ: ゲージ	提供および待機キューの現在の項目数。無制限の同時実行の場合は報告されません。`breaker.inFlight` が使用されます。	configuration_name="event-display", container_name="queue-proxy", namespace_name="apiserversource1", pod_name="event-display-00001-deployment-658fd4f9cf-qcnr5", response_code="200", response_code_class="2xx", revision_name="event-display-00001", service_name="event-display"

7.2.2. カスタムアプリケーションメトリクスを含む Knative サービス

Knative サービスによってエクスポートされるメトリクスのセットを拡張できます。正確な実装は、使用するアプリケーションと言語によって異なります。

以下のリストは、処理されたイベントカスタムメトリクスの数をエクスポートするサンプル Go アプリケーションを実装します。

package main

import (
  "fmt"
  "log"
  "net/http"
  "os"

  "github.com/prometheus/client_golang/prometheus" 1
  "github.com/prometheus/client_golang/prometheus/promauto"
  "github.com/prometheus/client_golang/prometheus/promhttp"
)

var (
  opsProcessed = promauto.NewCounter(prometheus.CounterOpts{ 2
     Name: "myapp_processed_ops_total",
     Help: "The total number of processed events",
  })
)


func handler(w http.ResponseWriter, r *http.Request) {
  log.Print("helloworld: received a request")
  target := os.Getenv("TARGET")
  if target == "" {
     target = "World"
  }
  fmt.Fprintf(w, "Hello %s!\n", target)
  opsProcessed.Inc() 3
}

func main() {
  log.Print("helloworld: starting server...")

  port := os.Getenv("PORT")
  if port == "" {
     port = "8080"
  }

  http.HandleFunc("/", handler)

  // Separate server for metrics requests
  go func() { 4
     mux := http.NewServeMux()
     server := &http.Server{
        Addr: fmt.Sprintf(":%s", "9095"),
        Handler: mux,
     }
     mux.Handle("/metrics", promhttp.Handler())
     log.Printf("prometheus: listening on port %s", 9095)
     log.Fatal(server.ListenAndServe())
  }()

   // Use same port as normal requests for metrics
  //http.Handle("/metrics", promhttp.Handler()) 5
  log.Printf("helloworld: listening on port %s", port)
  log.Fatal(http.ListenAndServe(fmt.Sprintf(":%s", port), nil))
}

1: Prometheus パッケージの追加。
2: opsProcessed メトリクスの定義。
3: opsProcessed メトリクスのインクリメント。
4: メトリクス要求に別のサーバーを使用するように設定。
5: メトリクスおよび metrics サブパスの通常の要求と同じポートを使用するように設定。

7.2.3. カスタムメトリクスの収集の設定

カスタムメトリクスの収集は、ユーザーワークロードのモニターリング用に設計された Prometheus のインスタンスで実行されます。ユーザーのワークロードのモニターリングを有効にしてアプリケーションを作成した後に、モニターリングスタックがメトリクスを収集する方法を定義する設定が必要になります。

以下のサンプル設定は、アプリケーションの ksvc を定義し、サービスモニターを設定します。正確な設定は、アプリケーションおよびメトリクスのエクスポート方法によって異なります。

apiVersion: serving.knative.dev/v1 1
kind: Service
metadata:
  name: helloworld-go
spec:
  template:
    metadata:
      labels:
        app: helloworld-go
      annotations:
    spec:
      containers:
      - image: docker.io/skonto/helloworld-go:metrics
        resources:
          requests:
            cpu: "200m"
        env:
        - name: TARGET
          value: "Go Sample v1"
---
apiVersion: monitoring.coreos.com/v1 2
kind: ServiceMonitor
metadata:
  labels:
  name: helloworld-go-sm
spec:
  endpoints:
  - port: queue-proxy-metrics
    scheme: http
  - port: app-metrics
    scheme: http
  namespaceSelector: {}
  selector:
    matchLabels:
       name:  helloworld-go-sm
---
apiVersion: v1 3
kind: Service
metadata:
  labels:
    name:  helloworld-go-sm
  name:  helloworld-go-sm
spec:
  ports:
  - name: queue-proxy-metrics
    port: 9091
    protocol: TCP
    targetPort: 9091
  - name: app-metrics
    port: 9095
    protocol: TCP
    targetPort: 9095
  selector:
    serving.knative.dev/service: helloworld-go
  type: ClusterIP

1: アプリケーション仕様。
2: アプリケーションのメトリクスが収集される設定。
3: メトリクスの収集方法の設定。

7.2.4. サービスのメトリックの検証

メトリクスとモニターリングスタックをエクスポートするようにアプリケーションを設定したら、Web コンソールでメトリクスを検査できます。

前提条件

OpenShift Container Platform Web コンソールにログインしている。
OpenShift Serverless Operator および Knative Serving がインストールされていること。

手順

オプション: メトリクスに表示できるアプリケーションに対する要求を実行します。

$ hello_route=$(oc get ksvc helloworld-go -n ns1 -o jsonpath='{.status.url}') && \
    curl $hello_route

出力例

Hello Go Sample v1!

Web コンソールで、Monitoring Metrics インターフェイスに移動します。

入力フィールドに、監視するメトリクスのクエリーを入力します。以下に例を示します。

revision_app_request_count{namespace="ns1", job="helloworld-go-sm"}

別の例:

myapp_processed_ops_total{namespace="ns1", job="helloworld-go-sm"}

可視化されたメトリクスを確認します。

7.2.4.1. キュープロキシーメトリクス

各 Knative サービスには、アプリケーションコンテナーへの接続をプロキシーするプロキシーコンテナーがあります。キュープロキシーのパフォーマンスについて多くのメトリクスが報告されます。

以下のメトリクスを使用して、要求がプロキシー側でキューに入れられているかどうか、およびアプリケーション側で要求を処理する際の実際の遅延を測定できます。

メトリクス名	説明	タイプ	タグ	単位
`revision_request_count`	`queue-proxy` Pod にルーティングされる要求の数。	カウンター	`configuration_name`、`container_name`、`namespace_name`、`pod_name`、`response_code`、`response_code_class`、`revision_name`、`service_name`	整数 (単位なし)
`revision_request_latencies`	リビジョン要求の応答時間。	ヒストグラム	`configuration_name`、`container_name`、`namespace_name`、`pod_name`、`response_code`、`response_code_class`、`revision_name`、`service_name`	ミリ秒
`revision_app_request_count`	`user-container` Pod にルーティングされる要求の数。	カウンター	`configuration_name`、`container_name`、`namespace_name`、`pod_name`、`response_code`、`response_code_class`、`revision_name`、`service_name`	整数 (単位なし)
`revision_app_request_latencies`	リビジョンアプリケーション要求の応答時間。	ヒストグラム	`configuration_name`、`namespace_name`、`pod_name`、`response_code`、`response_code_class`、`revision_name`、`service_name`	ミリ秒
`revision_queue_depth`	`serving` および `waiting` キューの現在の項目数。無制限の同時実行が設定されている場合には、このメトリクスは報告されません。	ゲージ	`configuration_name`、`event-display`、`container_name`、`namespace_name`、`pod_name`、`response_code_class`、`revision_name`、`service_name`	整数 (単位なし)

7.2.5. ダッシュボードでのサービスのメトリクスの検証

namespace でキュープロキシーメトリクスを集約する専用のダッシュボードを使用してメトリクスを検査できます。

前提条件

OpenShift Container Platform Web コンソールにログインしている。
OpenShift Serverless Operator および Knative Serving がインストールされていること。

手順

Web コンソールで、Monitoring Metrics インターフェイスに移動します。
Knative User Services (Queue Proxy metrics) ダッシュボードを選択します。
アプリケーションに対応する Namespace、Configuration、および Revision を選択します。
可視化されたメトリクスを確認します。

7.2. サーバーレス開発者メトリクス

7.2.1. デフォルトで公開される Knative サービスメトリクス

7.2.2. カスタムアプリケーションメトリクスを含む Knative サービス

7.2.3. カスタムメトリクスの収集の設定

7.2.4. サービスのメトリックの検証

7.2.4.1. キュープロキシーメトリクス

7.2.5. ダッシュボードでのサービスのメトリクスの検証

7.2.6. 関連情報

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

多様性を受け入れるオープンソースの強化

会社概要

Red Hat legal and privacy links

Red Hat legal and privacy links