可観測性

Red Hat OpenShift Serverless 1.35

管理者および開発者メトリクス、クラスターロギング、トレースなどの可観測性機能

Red Hat OpenShift Documentation Team

概要

このドキュメントでは、Knative サービスのパフォーマンスを監視する方法を説明します。また、OpenShift Serverless で OpenShift Logging および OpenShift 分散トレーシングを使用する方法も詳しく説明します。

第1章管理者メトリクス
リンクのコピー

1.1. サーバーレス管理者のメトリクス
リンクのコピー

メトリクスにより、クラスター管理者は OpenShift Serverless クラスターコンポーネントおよびワークロードのパフォーマンスを監視できます。

モニタリングダッシュボードについて で、OpenShift Serverless のさまざまなメトリクスを表示できます。

1.1.1. 前提条件
リンクのコピー

クラスターのメトリクスの有効化に関する詳細は、OpenShift Container Platform ドキュメントのメトリクスの管理を参照する。
クラスター管理者アクセス権 (または OpenShift Dedicated または Red Hat OpenShift Service on AWS の専用管理者アクセス権) が割り当てられたアカウントにアクセスできる。

警告

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

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

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

1.2. Serverless コントローラーメトリクス
リンクのコピー

以下のメトリクスは、コントローラーロジックを実装するコンポーネントによって出力されます。これらのメトリクスは、調整要求がワークキューに追加される調整操作とワークキューの動作に関する詳細を示します。

Expand

メトリクス名	説明	タイプ	タグ	単位
`work_queue_depth`	ワークキューの深さ。	ゲージ	`reconciler`	整数 (単位なし)
`reconcile_count`	調整操作の数。	カウンター	`reconciler`、`success`	整数 (単位なし)
`reconcile_latency`	調整操作のレイテンシー。	ヒストグラム	`reconciler`、`success`	ミリ秒
`workqueue_adds_total`	ワークキューによって処理される追加アクションの合計数。	カウンター	`name`	整数 (単位なし)
`workqueue_queue_latency_seconds`	アイテムが要求される前にワークキューにとどまる時間の長さ。	ヒストグラム	`name`	秒
`workqueue_retries_total`	ワークキューによって処理された再試行回数。	カウンター	`name`	整数 (単位なし)
`workqueue_work_duration_seconds`	ワークキューからの項目の処理にかかる時間の長さ。	ヒストグラム	`name`	秒
`workqueue_unfinished_work_seconds`	未処理のワークキュー項目が進行中であった時間の長さ。	ヒストグラム	`name`	秒
`workqueue_longest_running_processor_seconds`	最も長い間未処理のワークキュー項目が進行中であった時間の長さ。	ヒストグラム	`name`	秒

1.3. Webhook メトリクス
リンクのコピー

Webhook メトリクスは操作に関する有用な情報を表示します。たとえば、多数の操作が失敗する場合は、これはユーザーが作成したリソースに問題があることを示している可能性があります。

Expand

メトリクス名	説明	タイプ	タグ	単位
`request_count`	Webhook にルーティングされる要求の数。	カウンター	`admission_allowed`、`kind_group`、`kind_kind`、`kind_version`、`request_operation`、`resource_group`、`resource_namespace`、`resource_resource`、`resource_version`	整数 (単位なし)
`request_latencies`	Webhook 要求の応答時間。	ヒストグラム	`admission_allowed`、`kind_group`、`kind_kind`、`kind_version`、`request_operation`、`resource_group`、`resource_namespace`、`resource_resource`、`resource_version`	ミリ秒

1.4. Knative Eventing メトリクス
リンクのコピー

クラスター管理者は、Knative Eventing コンポーネントの以下のメトリクスを表示できます。

HTTP コードからメトリクスを集計することで、イベントは正常なイベント (2xx) および失敗したイベント (5xx) の 2 つのカテゴリーに分類できます。

1.4.1. ブローカー Ingress メトリクス
リンクのコピー

以下のメトリクスを使用してブローカー Ingress をデバッグし、どのように実行されているかを確認し、どのイベントが Ingress コンポーネントによってディスパッチされているかを確認できます。

Expand

メトリクス名	説明	タイプ	タグ	単位
`event_count`	ブローカーによって受信されるイベントの数。	カウンター	`broker_name`、`event_type`、`namespace_name`、`response_code`、`response_code_class`、`unique_name`	整数 (単位なし)
`event_dispatch_latencies`	イベントのチャネルへのディスパッチにかかる時間。	ヒストグラム	`broker_name`、`event_type`、`namespace_name`、`response_code`、`response_code_class`、`unique_name`	ミリ秒

1.4.2. ブローカーフィルターメトリクス
リンクのコピー

以下のメトリクスを使用してブローカーフィルターをデバッグし、それらがどのように実行されているかを確認し、どのイベントがフィルターによってディスパッチされているかを確認できます。イベントでフィルタリングアクションのレイテンシーを測定することもできます。

Expand

メトリクス名	説明	タイプ	タグ	単位
`event_count`	ブローカーによって受信されるイベントの数。	カウンター	`broker_name`、`container_name`、`filter_type`、`namespace_name`、`response_code`、`response_code_class`、`trigger_name`、`unique_name`	整数 (単位なし)
`event_dispatch_latencies`	イベントのチャネルへのディスパッチにかかる時間。	ヒストグラム	`broker_name`、`container_name`、`filter_type`、`namespace_name`、`response_code`、`response_code_class`、`trigger_name`、`unique_name`	ミリ秒
`event_processing_latencies`	トリガーサブスクライバーにディスパッチされる前にイベントの処理にかかる時間。	ヒストグラム	`broker_name`、`container_name`、`filter_type`、`namespace_name`、`trigger_name`、`unique_name`	ミリ秒

1.4.3. InMemoryChannel dispatcher メトリクス
リンクのコピー

以下のメトリクスを使用して InMemoryChannel チャネルをデバッグし、それらがどのように実行されているかを確認し、どのイベントがチャネルによってディスパッチされているかを確認できます。

Expand

メトリクス名	説明	タイプ	タグ	単位
`event_count`	`InMemoryChannel` チャネルでディスパッチされるイベントの数。	カウンター	`broker_name`、`container_name`、`filter_type`、`namespace_name`、`response_code`、`response_code_class`、`trigger_name`、`unique_name`	整数 (単位なし)
`event_dispatch_latencies`	`InMemoryChannel` チャネルからのイベントのディスパッチにかかる時間。	ヒストグラム	`broker_name`、`container_name`、`filter_type`、`namespace_name`、`response_code`、`response_code_class`、`trigger_name`、`unique_name`	ミリ秒

1.4.4. イベントソースメトリクス
リンクのコピー

以下のメトリクスを使用して、イベントがイベントソースから接続されたイベントシンクに配信されていることを確認できます。

Expand

メトリクス名	説明	タイプ	タグ	単位
`event_count`	イベントソースによって送信されるイベントの数。	カウンター	`broker_name`、`container_name`、`filter_type`、`namespace_name`、`response_code`、`response_code_class`、`trigger_name`、`unique_name`	整数 (単位なし)
`retry_event_count`	最初に配信に失敗した後にイベントソースによって送信される再試行イベントの数。	カウンター	`event_source`、`event_type`、`name`、`namespace_name`、`resource_group`、`response_code`、`response_code_class`、`response_error`、`response_timeout`	整数 (単位なし)

1.4.5. Knative Kafka ブローカーメトリクス
リンクのコピー

次のメトリクスを使用して、Kafka ブローカーのパフォーマンスをデバッグおよび視覚化できます。

Expand

メトリクス名	説明	タイプ	タグ	単位
`event_count_1_total{job="kafka-broker-receiver-sm-service", namespace="knative-eventing"}`	ブローカーによって受信されるイベントの数。	カウンター	`name` broker name `namespace_name` ブローカー namespace `event_type` イベントタイプ `response_code` ブローカーから返された HTTP レスポンスコード `response_code_class` ブローカーから返される HTTP レスポンスコードクラス: 2xx、3xx、4xx、5xx	無次元
`event_dispatch_latencies_ms_bucket{job="kafka-broker-receiver-sm-service", namespace="knative-eventing"}`	Kafka クラスターにイベントを送信するのに費やされた時間	ヒストグラム	`name` broker name `namespace_name` ブローカー namespace `event_type` イベントタイプ `response_code` ブローカーから返された HTTP レスポンスコード `response_code_class` ブローカーから返される HTTP レスポンスコードクラス: 2xx、3xx、4xx、5xx	ミリ秒
`kafka_broker_controller_consumer_group_expected_replicas`	特定の Kafka コンシューマーグループリソースの予想されるレプリカの数	ゲージ	`consumer_name` リソース名 `namespace_name` リソースの namespace `consumer_kind` リソースの種類、列挙: `KafkaSource`、`Trigger`、`Subscription` 注記このコンテキストでは、リソースとは、Kafka ソース、トリガー、サブスクリプションなどのユーザー向けのエンティティーを指します。これらのリソースを使用するときは、内部名または生成された名前を使用しないでください。	無次元
`kafka_broker_controller_consumer_group_ready_replicas`	特定の Kafka コンシューマーグループリソースの準備完了レプリカの数	ゲージ	`consumer_name` リソース名 `namespace_name` リソースの namespace `consumer_kind` リソースの種類、列挙: `KafkaSource`、`Trigger`、`Subscription` 注記このコンテキストでは、リソースとは、Kafka ソース、トリガー、サブスクリプションなどのユーザー向けのエンティティーを指します。これらのリソースを使用するときは、内部名または生成された名前を使用しないでください。	無次元

1.4.6. Knative Kafka トリガーメトリクス
リンクのコピー

次のメトリクスを使用して、Kafka トリガーのパフォーマンスをデバッグおよび視覚化できます。

Expand

メトリクス名	説明	タイプ	タグ	単位
`event_count_1_total{job="kafka-broker-dispatcher-sm-service", namespace="knative-eventing"}`	トリガーがサブスクライバーに送信するイベントの数	カウンター	`consumer_name` トリガー名 `namespace_name` トリガー namespace `name` broker name `event_type` イベントタイプ `response_code` トリガーサブスクライバーサービスにより返された HTTP レスポンスコード `response_code_class` トリガーサブスクライバーサービスにより返される HTTP レスポンスコードクラス: 2xx、3xx、4xx、5xx	無次元
`event_dispatch_latencies_ms_bucket{job="kafka-broker-dispatcher-sm-service", namespace="knative-eventing"}`	サブスクライバーにイベントを送信するのに費やされた時間	ヒストグラム	`consumer_name` トリガー名 `namespace_name` トリガー namespace `name` broker name `event_type` イベントタイプ `response_code` トリガーサブスクライバーサービスにより返された HTTP レスポンスコード `response_code_class` トリガーサブスクライバーサービスにより返される HTTP レスポンスコードクラス: 2xx、3xx、4xx、5xx	ミリ秒
`event_processing_latencies_ms_bucket{job="kafka-broker-dispatcher-sm-service", namespace="knative-eventing"}`	イベントの処理とフィルタリングに費やされた時間	ヒストグラム	`consumer_name` トリガー名 `namespace_name` トリガー namespace `name` broker name `event_type` イベントタイプ	ミリ秒

1.4.7. Knative Kafka チャネルメトリクス
リンクのコピー

次のメトリクスを使用して、Kafka チャネルのパフォーマンスをデバッグおよび視覚化できます。

Expand

メトリクス名	説明	タイプ	タグ	単位
`event_count_1_total{job="kafka-channel-receiver-sm-service", namespace="knative-eventing"}`	Kafka チャネルで受信したイベントの数	カウンター	`name` Kafka チャネル名 `namespace_name` Kafka チャネル namespace `event_type` イベントタイプ `response_code` Kafka チャネルから返される HTTP レスポンスコード `response_code_class` Kafka チャネルにより返される HTTP レスポンスコードクラス: 2xx、3xx、4xx、5xx	無次元
`event_dispatch_latencies_ms_bucket{job="kafka-channel-receiver-sm-service", namespace="knative-eventing"}`	Kafka クラスターにイベントを送信するのに費やされた時間	ヒストグラム	`name` Kafka チャネル名 `namespace_name` Kafka チャネル namespace `event_type` イベントタイプ `response_code` Kafka チャネルから返される HTTP レスポンスコード `response_code_class` Kafka チャネルにより返される HTTP レスポンスコードクラス: 2xx、3xx、4xx、5xx	ミリ秒

1.4.8. Knative Kafka サブスクリプションメトリクス
リンクのコピー

次のメトリクスを使用して、Kafka チャネルに関連付けられたサブスクリプションのパフォーマンスをデバッグおよび視覚化できます。

Expand

メトリクス名	説明	タイプ	タグ	単位
`event_count_1_total{job="kafka-channel-dispatcher-sm-service", namespace="knative-eventing"}`	サブスクリプションからサブスクライバーにディスパッチされたイベントの数	カウンター	`consumer_name` サブスクリプション名 `namespace_name` サブスクリプション namespace `name` KafkaChannel 名 `event_type` イベントタイプ `response_code` `Subscription` スクライバーサービスから返される HTTP レスポンスコード `response_code_class` `Subscription` スクライバーサービスにより返される HTTP レスポンスコードクラス: 2xx、3xx、4xx、5xx	無次元
`event_dispatch_latencies_ms_bucket{job="kafka-channel-dispatcher-sm-service", namespace="knative-eventing"}`	サブスクライバーにイベントを送信するのに費やされた時間	ヒストグラム	`consumer_name` サブスクリプション名 `namespace_name` サブスクリプション namespace `name` KafkaChannel 名 `event_type` イベントタイプ `response_code` `Subscription` スクライバーサービスから返される HTTP レスポンスコード `response_code_class` `Subscription` スクライバーサービスにより返される HTTP レスポンスコードクラス: 2xx、3xx、4xx、5xx	ミリ秒
`event_processing_latencies_ms_bucket{job="kafka-channel-dispatcher-sm-service", namespace="knative-eventing"}`	イベントの処理に要した時間	ヒストグラム	`consumer_name` サブスクリプション名 `namespace_name` サブスクリプション namespace `name` KafkaChannel 名 `event_type` イベントタイプ	無次元

1.4.9. Knative Kafka ソースメトリクス
リンクのコピー

次のメトリクスを使用して、Kafka ソースのパフォーマンスをデバッグおよび視覚化できます。

Expand

メトリクス名	説明	タイプ	タグ	単位
`event_count_1_total{job="kafka-source-dispatcher-sm-service", namespace="knative-eventing"}`	Kafka ソースによってディスパッチされたイベントの数	カウンター	`consumer_name` Kafka ソース名 `namespace_name` Kafka ソース namespace `name` Kafka ソース名 `event_type` イベントタイプ `response_code` Kafka ソースシンクサービスから返される HTTP レスポンスコード `response_code_class` Kafka ソースシンクサービスにより返される HTTP レスポンスコードクラス: 2xx、3xx、4xx、5xx	無次元
`event_dispatch_latencies_ms_bucket{job="kafka-source-dispatcher-sm-service", namespace="knative-eventing"}`	イベントをシンクに送信するのに費やされた時間	ヒストグラム	`consumer_name` Kafka ソース名 `namespace_name` Kafka ソース namespace `name` Kafka ソース名 `event_type` イベントタイプ `response_code` Kafka ソースシンクサービスから返される HTTP レスポンスコード `response_code_class` Kafka ソースシンクサービスにより返される HTTP レスポンスコードクラス: 2xx、3xx、4xx、5xx	ミリ秒
`event_processing_latencies_ms_bucket{job="kafka-source-dispatcher-sm-service", namespace="knative-eventing"}`	イベントの処理に要した時間	ヒストグラム	`consumer_name` Kafka ソース名 `namespace_name` Kafka ソース namespace `name` Kafka ソース名 `event_type` イベントタイプ	ミリ秒
`kafka_broker_controller_consumer_group_expected_replicas`	特定の Kafka コンシューマーグループリソースの予想されるレプリカの数	ゲージ	`consumer_name` リソース名 `namespace_name` リソースの namespace `consumer_kind` リソースの種類、列挙: `KafkaSource`、`Trigger`、`Subscription` 注記このコンテキストでは、リソースとは、Kafka ソース、トリガー、サブスクリプションなどのユーザー向けのエンティティーを指します。これらのリソースを使用するときは、内部名または生成された名前を使用しないでください。	無次元
`kafka_broker_controller_consumer_group_ready_replicas`	特定の Kafka コンシューマーグループリソースの準備完了レプリカの数	ゲージ	`consumer_name` リソース名 `namespace_name` リソースの namespace `consumer_kind` リソースの種類、列挙: `KafkaSource`、`Trigger`、`Subscription` 注記このコンテキストでは、リソースとは、Kafka ソース、トリガー、サブスクリプションなどのユーザー向けのエンティティーを指します。これらのリソースを使用するときは、内部名または生成された名前を使用しないでください。	無次元

1.4.10. Knative Kafka シンクメトリクス
リンクのコピー

次のメトリクスを使用して、Kafka シンクのパフォーマンスをデバッグおよび視覚化できます。

Expand

メトリクス名	説明	タイプ	タグ	単位
`event_count_1_total{job="kafka-sink-receiver-sm-service", namespace="knative-eventing"}`	ブローカーによって受信されるイベントの数。	カウンター	`name` Kafka シンク名 `namespace_name` Kafka シンク namespace `event_type` イベントタイプ `response_code` Kafka シンクから返される HTTP レスポンスコード `response_code_class` Kafka シンクにより返される HTTP レスポンスコードクラス: 2xx、3xx、4xx、5xx	無次元
`event_dispatch_latencies_ms_bucket{job="kafka-sink-receiver-sm-service", namespace="knative-eventing"}`	Kafka クラスターにイベントを送信するのに費やされた時間	ヒストグラム	`name` Kafka シンク名 `namespace_name` Kafka シンク namespace `event_type` イベントタイプ `response_code` Kafka シンクから返される HTTP レスポンスコード `response_code_class` Kafka シンクにより返される HTTP レスポンスコードクラス: 2xx、3xx、4xx、5xx	ミリ秒

1.5. Knative Serving メトリクス
リンクのコピー

クラスター管理者は、Knative Serving コンポーネントの以下のメトリクスを表示できます。

1.5.1. activator メトリクス
リンクのコピー

以下のメトリクスを使用して、トラフィックが activator 経由で渡されるときにアプリケーションがどのように応答するかを理解することができます。

Expand

メトリクス名	説明	タイプ	タグ	単位
`request_concurrency`	activator にルーティングされる同時要求の数、またはレポート期間における平均同時実行数。	ゲージ	`configuration_name`、`container_name`、`namespace_name`、`pod_name`、`revision_name`、`service_name`	整数 (単位なし)
`request_count`	activator にルーティングされる要求の数。これらは、activator ハンドラーから実行された要求です。	カウンター	`configuration_name`、`container_name`、`namespace_name`、`pod_name`、`response_code`、`response_code_class`、`revision_name`、`service_name`	整数 (単位なし)
`request_latencies`	実行され、ルーティングされた要求の応答時間 (ミリ秒単位)。	ヒストグラム	`configuration_name`、`container_name`、`namespace_name`、`pod_name`、`response_code`、`response_code_class`、`revision_name`、`service_name`	ミリ秒

1.5.2. Autoscaler メトリクス
リンクのコピー

Autoscaler コンポーネントは、それぞれのリビジョンの Autoscaler の動作に関連する多数のメトリクスを公開します。たとえば、任意の時点で、Autoscaler がサービスに割り当てようとする Pod のターゲット数、安定期間中の 1 秒あたりの要求の平均数、または Knative Pod Autoscaler (KPA) を使用している場合に Autoscaler がパニックモードであるかどうかなどを監視できます。

Expand

メトリクス名	説明	タイプ	タグ	単位
`desired_pods`	Autoscaler がサービスへの割り当てを試みる Pod 数。	ゲージ	`configuration_name`、`namespace_name`、`revision_name`、`service_name`	整数 (単位なし)
`excess_burst_capacity`	stable ウインドウで提供される追加のバースト容量。	ゲージ	`configuration_name`、`namespace_name`、`revision_name`、`service_name`	整数 (単位なし)
`stable_request_concurrency`	stable ウィンドウで監視される各 Pod の要求数の平均。	ゲージ	`configuration_name`、`namespace_name`、`revision_name`、`service_name`	整数 (単位なし)
`panic_request_concurrency`	panic ウィンドウで監視される各 Pod の要求数の平均。	ゲージ	`configuration_name`、`namespace_name`、`revision_name`、`service_name`	整数 (単位なし)
`target_concurrency_per_pod`	Autoscaler が各 Pod への送信を試みる同時要求の数。	ゲージ	`configuration_name`、`namespace_name`、`revision_name`、`service_name`	整数 (単位なし)
`stable_requests_per_second`	stable ウィンドウで監視される各 Pod の 1 秒当たりの要求数の平均。	ゲージ	`configuration_name`、`namespace_name`、`revision_name`、`service_name`	整数 (単位なし)
`panic_requests_per_second`	panic ウィンドウで監視される各 Pod の 1 秒当たりの要求数の平均。	ゲージ	`configuration_name`、`namespace_name`、`revision_name`、`service_name`	整数 (単位なし)
`target_requests_per_second`	Autoscaler が各 Pod をターゲットとする 1 秒あたりの要求の数。	ゲージ	`configuration_name`、`namespace_name`、`revision_name`、`service_name`	整数 (単位なし)
`panic_mode`	この値は、Autoscaler がパニックモードの場合は `1` になります。Autoscaler がパニックモードではない場合は `0` になります。	ゲージ	`configuration_name`、`namespace_name`、`revision_name`、`service_name`	整数 (単位なし)
`requested_pods`	Autoscaler が Kubernetes クラスターから要求した Pod 数。	ゲージ	`configuration_name`、`namespace_name`、`revision_name`、`service_name`	整数 (単位なし)
`actual_pods`	割り当てられ、現在準備完了状態にある Pod 数。	ゲージ	`configuration_name`、`namespace_name`、`revision_name`、`service_name`	整数 (単位なし)
`not_ready_pods`	準備未完了状態の Pod 数。	ゲージ	`configuration_name`、`namespace_name`、`revision_name`、`service_name`	整数 (単位なし)
`pending_pods`	現在保留中の Pod 数。	ゲージ	`configuration_name`、`namespace_name`、`revision_name`、`service_name`	整数 (単位なし)
`terminating_pods`	現在終了中の Pod 数。	ゲージ	`configuration_name`、`namespace_name`、`revision_name`、`service_name`	整数 (単位なし)

1.5.3. Go ランタイムメトリクス
リンクのコピー

各 Knative Serving コントロールプレーンプロセスは、Go ランタイムメモリーの統計を多数出力します (MemStats)。

注記

各メトリクスの name タグは空のタグです。

Expand

メトリクス名	説明	タイプ	タグ	単位
`go_alloc`	割り当てられたヒープオブジェクトのバイト数。このメトリクスは `heap_alloc` と同じです。	ゲージ	`name`	整数 (単位なし)
`go_total_alloc`	ヒープオブジェクトに割り当てられる累積バイト数。	ゲージ	`name`	整数 (単位なし)
`go_sys`	オペレーティングシステムから取得したメモリーの合計バイト数。	ゲージ	`name`	整数 (単位なし)
`go_lookups`	ランタイムが実行したポインター検索の数。	ゲージ	`name`	整数 (単位なし)
`go_mallocs`	割り当てられるヒープオブジェクトの累積数。	ゲージ	`name`	整数 (単位なし)
`go_frees`	解放されているヒープオブジェクトの累積数。	ゲージ	`name`	整数 (単位なし)
`go_heap_alloc`	割り当てられたヒープオブジェクトのバイト数。	ゲージ	`name`	整数 (単位なし)
`go_heap_sys`	オペレーティングシステムから取得したヒープメモリーのバイト数。	ゲージ	`name`	整数 (単位なし)
`go_heap_idle`	アイドル状態の未使用スパンのバイト数。	ゲージ	`name`	整数 (単位なし)
`go_heap_in_use`	現在使用中のスパンのバイト数。	ゲージ	`name`	整数 (単位なし)
`go_heap_released`	オペレーティングシステムに返された物理メモリーのバイト数。	ゲージ	`name`	整数 (単位なし)
`go_heap_objects`	割り当てられるヒープオブジェクトの数。	ゲージ	`name`	整数 (単位なし)
`go_stack_in_use`	現在使用中のスタックスパンのバイト数。	ゲージ	`name`	整数 (単位なし)
`go_stack_sys`	オペレーティングシステムから取得したスタックメモリーのバイト数。	ゲージ	`name`	整数 (単位なし)
`go_mspan_in_use`	割り当てられた `mspan` 構造のバイト数。	ゲージ	`name`	整数 (単位なし)
`go_mspan_sys`	`mspan` 構造のオペレーティングシステムから取得したメモリーのバイト数。	ゲージ	`name`	整数 (単位なし)
`go_mcache_in_use`	割り当てられた `mcache` 構造のバイト数。	ゲージ	`name`	整数 (単位なし)
`go_mcache_sys`	`mcache` 構造のためにオペレーティングシステムから取得したメモリーのバイト数。	ゲージ	`name`	整数 (単位なし)
`go_bucket_hash_sys`	バケットハッシュテーブルのプロファイリングにおけるメモリーのバイト数。	ゲージ	`name`	整数 (単位なし)
`go_gc_sys`	ガべージコレクションメタデータのメモリーのバイト数。	ゲージ	`name`	整数 (単位なし)
`go_other_sys`	その他のオフヒープランタイム割り当てのメモリーのバイト数。	ゲージ	`name`	整数 (単位なし)
`go_next_gc`	次のガベージコレクションサイクルのターゲットヒープサイズ。	ゲージ	`name`	整数 (単位なし)
`go_last_gc`	最後のガベージコレクションが完了した時間 (Epoch または Unix 時間)。	ゲージ	`name`	ナノ秒
`go_total_gc_pause_ns`	プログラム開始以降のガベージコレクションの stop-the-world 停止の累積時間。	ゲージ	`name`	ナノ秒
`go_num_gc`	完了したガベージコレクションサイクルの数。	ゲージ	`name`	整数 (単位なし)
`go_num_forced_gc`	ガベージコレクションの機能を呼び出すアプリケーションが原因で強制されたガベージコレクションサイクルの数。	ゲージ	`name`	整数 (単位なし)
`go_gc_cpu_fraction`	プログラムの開始以降にガベージコレクターによって使用されたプログラムの使用可能な CPU 時間の一部。	ゲージ	`name`	整数 (単位なし)

第2章開発者メトリクス
リンクのコピー

2.1. Serverless 開発者メトリクスの概要
リンクのコピー

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

OpenShift Serverless のさまざまなメトリクスは、モニタリングダッシュボードについて で確認できます。

警告

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

2.2. デフォルトで公開される Knative サービスメトリクス
リンクのコピー

Expand

表2.1 ポート 9091 の各 Knative サービスについてデフォルトで公開されるメトリクス
メトリクス名、単位、およびタイプ	説明	メトリクスのタグ
`request_count` メトリクスの単位: 無次元メトリクスのタイプ: カウンター	`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` メトリクスの単位: ミリ秒メトリクスのタイプ: ヒストグラム	応答時間 (ミリ秒単位)。	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` メトリクスの単位: 無次元メトリクスのタイプ: カウンター	`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` メトリクスの単位: ミリ秒メトリクスのタイプ: ヒストグラム	応答時間 (ミリ秒単位)。	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` メトリクスの単位: 無次元メトリクスのタイプ: ゲージ	提供および待機キューの現在の項目数。無制限の同時実行の場合は報告されません。`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"

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

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

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

package main

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

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

var (
  opsProcessed = promauto.NewCounter(prometheus.CounterOpts{ 
     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() 
}

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() { 
     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()) 
  log.Printf("helloworld: listening on port %s", port)
  log.Fatal(http.ListenAndServe(fmt.Sprintf(":%s", port), nil))
}

package main

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

  "github.com/prometheus/client_golang/prometheus"


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

var (
  opsProcessed = promauto.NewCounter(prometheus.CounterOpts{


     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()


}

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() {


     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())


  log.Printf("helloworld: listening on port %s", port)
  log.Fatal(http.ListenAndServe(fmt.Sprintf(":%s", port), nil))
}

Copy to Clipboard

Toggle word wrap

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

2.4. カスタムメトリクスの収集の設定
リンクのコピー

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

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

apiVersion: serving.knative.dev/v1 
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 
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 
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

apiVersion: serving.knative.dev/v1


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


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


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

Copy to Clipboard

Toggle word wrap

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

2.5. サービスのメトリクスの検証
リンクのコピー

メトリクスとモニタリングスタックをエクスポートするようにアプリケーションを設定したら、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_route=$(oc get ksvc helloworld-go -n ns1 -o jsonpath='{.status.url}') && \
    curl $hello_route

Copy to Clipboard

Toggle word wrap

出力例

Hello Go Sample v1!

Hello Go Sample v1!

Copy to Clipboard

Toggle word wrap

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

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

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

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

Copy to Clipboard

Toggle word wrap

別の例:

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

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

Copy to Clipboard

Toggle word wrap

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

2.5.1. キュープロキシーメトリクス
リンクのコピー

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

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

Expand

メトリクス名	説明	タイプ	タグ	単位
`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`	整数 (単位なし)

2.6. サービスメトリクスのダッシュボード
リンクのコピー

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

2.6.1. ダッシュボードでのサービスのメトリクスの検証
リンクのコピー

前提条件

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

手順

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

第3章クラスターロギング
リンクのコピー

3.1. Serving と Eventing のログ設定の構成
リンクのコピー

KnativeServing および KnativeEventing カスタムリソース (CR) を使用して、OpenShift Serverless Serving および OpenShift Serverless Eventing のログ記録を設定できます。ロギングのレベルは、指定された loglevel 値によって決まります。

3.1.1. サポート対象のログレベル
リンクのコピー

次の loglevel 値がサポートされています。

Expand

表3.1 サポート対象のログレベル
ログレベル	説明
`debug`	きめ細かなデバッグ
`info`	通常のロギング
`warn`	予期しないが重大ではないエラー
`error`	重大なエラー。通常操作中の予期しないエラー
`dpanic`	デバッグモードでパニック (クラッシュ) をトリガーする

警告

実稼働環境で debug レベルを使用すると、パフォーマンスに影響を及ぼす場合があります。

3.1.2. ログ設定の構成
リンクのコピー

KnativeServing カスタムリソース (CR) と KnativeEventing CR で、Serving と Eventing のログ記録を設定できます。

手順

KnativeServing および KnativeEventing CR でそれぞれ loglevel 値を設定または変更して、Serving および Eventing のログ設定を構成します。以下に、すべての可能なログオプションをレベル info に設定した 2 つの設定例を示します。

KnativeServing CR

apiVersion: operator.knative.dev/v1beta1
kind: KnativeServing
metadata:
  name: knative-serving
  namespace: knative-serving
spec:
  config:
    logging:
      loglevel.controller: "info"
      loglevel.autoscaler: "info"
      loglevel.queueproxy: "info"
      loglevel.webhook: "info"
      loglevel.activator: "info"
      loglevel.hpaautoscaler: "info"
      loglevel.net-certmanager-controller: "info"
      loglevel.net-istio-controller: "info"
      loglevel.net-kourier-controller: "info"

apiVersion: operator.knative.dev/v1beta1
kind: KnativeServing
metadata:
  name: knative-serving
  namespace: knative-serving
spec:
  config:
    logging:
      loglevel.controller: "info"
      loglevel.autoscaler: "info"
      loglevel.queueproxy: "info"
      loglevel.webhook: "info"
      loglevel.activator: "info"
      loglevel.hpaautoscaler: "info"
      loglevel.net-certmanager-controller: "info"
      loglevel.net-istio-controller: "info"
      loglevel.net-kourier-controller: "info"

Copy to Clipboard

Toggle word wrap

KnativeEventing CR

apiVersion: operator.knative.dev/v1beta1
kind: KnativeEventing
metadata:
  name: knative-eventing
  namespace: knative-eventing
spec:
  config:
    logging:
      loglevel.controller: "info"
      loglevel.eventing-webhook: "info"
      loglevel.inmemorychannel-dispatcher: "info"
      loglevel.inmemorychannel-webhook: "info"
      loglevel.mt-broker-controller: "info"
      loglevel.mt_broker_filter: "info"
      loglevel.mt_broker_ingress: "info"
      loglevel.pingsource-mt-adapter: "info"

apiVersion: operator.knative.dev/v1beta1
kind: KnativeEventing
metadata:
  name: knative-eventing
  namespace: knative-eventing
spec:
  config:
    logging:
      loglevel.controller: "info"
      loglevel.eventing-webhook: "info"
      loglevel.inmemorychannel-dispatcher: "info"
      loglevel.inmemorychannel-webhook: "info"
      loglevel.mt-broker-controller: "info"
      loglevel.mt_broker_filter: "info"
      loglevel.mt_broker_ingress: "info"
      loglevel.pingsource-mt-adapter: "info"

Copy to Clipboard

Toggle word wrap

3.1.3. リクエストログ設定の構成
リンクのコピー

KnativeServing カスタムリソース (CR) の observability フィールドで、サービスのリクエストログを設定できます。

リクエストロギングを設定するのに使用できるパラメーターの詳細は、「リクエストログのパラメーター」を参照してください。

手順

KnativeServing CR の observability フィールドを変更して、サービスのリクエストログを設定します。

KnativeServing CR の例

apiVersion: operator.knative.dev/v1beta1
kind: KnativeServing
metadata:
  name: knative-serving
  namespace: knative-serving
# ...
spec:
  config:
    observability:
        logging.enable-request-log: true
        logging.enable-probe-request-log: true
        logging.request-log-template: '{"httpRequest": {"requestMethod": "{{.Request.Method}}", "requestUrl": "{{js .Request.RequestURI}}", "requestSize": "{{.Request.ContentLength}}", "status": {{.Response.Code}}, "responseSize": "{{.Response.Size}}", "userAgent": "{{js .Request.UserAgent}}", "remoteIp": "{{js .Request.RemoteAddr}}", "serverIp": "{{.Revision.PodIP}}", "referer": "{{js .Request.Referer}}", "latency": "{{.Response.Latency}}s", "protocol": "{{.Request.Proto}}"}, "traceId": "{{index .Request.Header "X-B3-Traceid"}}"}'
# ...

apiVersion: operator.knative.dev/v1beta1
kind: KnativeServing
metadata:
  name: knative-serving
  namespace: knative-serving
# ...
spec:
  config:
    observability:
        logging.enable-request-log: true
        logging.enable-probe-request-log: true
        logging.request-log-template: '{"httpRequest": {"requestMethod": "{{.Request.Method}}", "requestUrl": "{{js .Request.RequestURI}}", "requestSize": "{{.Request.ContentLength}}", "status": {{.Response.Code}}, "responseSize": "{{.Response.Size}}", "userAgent": "{{js .Request.UserAgent}}", "remoteIp": "{{js .Request.RemoteAddr}}", "serverIp": "{{.Revision.PodIP}}", "referer": "{{js .Request.Referer}}", "latency": "{{.Response.Latency}}s", "protocol": "{{.Request.Proto}}"}, "traceId": "{{index .Request.Header "X-B3-Traceid"}}"}'
# ...

Copy to Clipboard

Toggle word wrap

3.1.4. リクエストロギングのパラメーター
リンクのコピー

次の表は、リクエストロギングを構成するのに使用されるパラメーターを説明しています。

Expand

表3.2 リクエストロギング設定パラメーター
パラメーター	タイプ	説明
`logging.enable-request-log`	ブール値 (`true` または `false`)	リクエストのロギングを有効にするには `true` に設定します。
`logging.enable-probe-request-log`	ブール値 (`true` または `false`)	キュープロキシーがプローブ要求を stdout に記録できるようにするには、`true` に設定します。`logging.request-log-template` で指定されたテンプレートを使用します。
`logging.request-log-template`	Go `text/template` 文字列	リクエストログの形状を決定します。ログが複数のレコードに分割されないようにするには、1 行を使用します。

logging.request-log-template パラメーターには次の機能が含まれます。

Request は、サーバーが受け取った HTTP リクエストを表す http.Request です。
Response は HTTP レスポンスを表し、次のフィールドが含まれます。
- Code は HTTP ステータスコードです。
- Size はバイト単位の応答サイズです。
- Latency は、秒単位での応答レイテンシーです。
Revision にはリビジョンの詳細が含まれ、次のフィールドが含まれます。
- Name はリビジョンの名前です。
- Namespace はリビジョンの namespace です。
- Service はサービスの名前です。
- Configuration は設定の名前です。
- PodName は、リビジョンをホストする Pod の名前です。
- PodIP はホスティング Pod の IP アドレスです。

第4章トレーシング
リンクのコピー

4.1. リクエストのトレース
リンクのコピー

分散トレースは、アプリケーションを設定する各種のサービスを使用した要求のパスを記録します。これは、各種の異なる作業単位の情報を連携させ、分散トランザクションでのイベントチェーン全体を把握できるようにするために使用されます。作業単位は、異なるプロセスまたはホストで実行される場合があります。

4.1.1. 分散トレースの概要
リンクのコピー

サービスの所有者は、分散トレースを使用してサービスをインストルメント化し、サービスアーキテクチャーに関する洞察を得ることができます。分散トレースを使用して、現代的なクラウドネイティブのマイクロサービスベースのアプリケーションにおける、コンポーネント間の対話の監視、ネットワークプロファイリング、およびトラブルシューティングを行うことができます。

分散トレースを使用すると、以下の機能を実行できます。

分散トランザクションの監視
パフォーマンスとレイテンシーの最適化
根本原因分析の実行

Red Hat OpenShift の分散トレースは、2 つの主要コンポーネントで構成されています。

Red Hat OpenShift 分散トレースプラットフォーム: このコンポーネントは、オープンソースの Jaeger プロジェクトに基づいています。
Red Hat OpenShift 分散トレースデータ収集: このコンポーネントは、オープンソースの OpenTelemetry プロジェクトに基づいています。

これらのコンポーネントは共に、特定のベンダーに依存しない OpenTracing API およびインストルメンテーションに基づいています。

4.2. Red Hat OpenShift 分散トレースの使用
リンクのコピー

OpenShift Serverless で Red Hat OpenShift 分散トレースを使用して、サーバーレスアプリケーションを監視およびトラブルシューティングできます。

4.2.1. Red Hat OpenShift 分散トレースを使用して分散トレースを有効にする
リンクのコピー

Red Hat OpenShift 分散トレースは、複数のコンポーネントで構成されており、トレースデータを収集し、保存し、表示するためにそれらが連携します。

前提条件

クラスター管理者のアクセスを持つ OpenShift Container Platform アカウントを使用できる。
OpenShift Container Platform の「分散トレーシングのインストール」ドキュメントに従って、Red Hat OpenShift の分散トレーシングをインストールしている。
OpenShift CLI (oc) がインストールされている。
OpenShift Container Platform でアプリケーションおよび他のワークロードを作成するために、プロジェクトを作成しているか、適切なロールおよびパーミッションを持つプロジェクトにアクセスできる。

手順

OpenTelemetryCollector カスタムリソース (CR) を作成します。

OpenTelemetryCollector CR の例

apiVersion: opentelemetry.io/v1alpha1
kind: OpenTelemetryCollector
metadata:
  name: cluster-collector
  namespace: <namespace>
spec:
  mode: deployment
  config: |
    receivers:
      zipkin:
    processors:
    exporters:
      jaeger:
        endpoint: jaeger-all-in-one-inmemory-collector-headless.tracing-system.svc:14250
        tls:
          ca_file: "/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt"
      logging:
    service:
      pipelines:
        traces:
          receivers: [zipkin]
          processors: []
          exporters: [jaeger, logging]

apiVersion: opentelemetry.io/v1alpha1
kind: OpenTelemetryCollector
metadata:
  name: cluster-collector
  namespace: <namespace>
spec:
  mode: deployment
  config: |
    receivers:
      zipkin:
    processors:
    exporters:
      jaeger:
        endpoint: jaeger-all-in-one-inmemory-collector-headless.tracing-system.svc:14250
        tls:
          ca_file: "/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt"
      logging:
    service:
      pipelines:
        traces:
          receivers: [zipkin]
          processors: []
          exporters: [jaeger, logging]

Copy to Clipboard

Toggle word wrap

Red Hat OpenShift 分散トレースがインストールされているネームスペースで 2 つの Pod が実行されていることを確認します。

oc get pods -n <namespace>

$ oc get pods -n <namespace>

Copy to Clipboard

Toggle word wrap

出力例

NAME                                          READY   STATUS    RESTARTS   AGE
cluster-collector-collector-85c766b5c-b5g99   1/1     Running   0          5m56s
jaeger-all-in-one-inmemory-ccbc9df4b-ndkl5    2/2     Running   0          15m

NAME                                          READY   STATUS    RESTARTS   AGE
cluster-collector-collector-85c766b5c-b5g99   1/1     Running   0          5m56s
jaeger-all-in-one-inmemory-ccbc9df4b-ndkl5    2/2     Running   0          15m

Copy to Clipboard

Toggle word wrap

次のヘッドレスサービスが作成されていることを確認します。

oc get svc -n <namespace> | grep headless

$ oc get svc -n <namespace> | grep headless

Copy to Clipboard

Toggle word wrap

出力例

cluster-collector-collector-headless            ClusterIP   None             <none>        9411/TCP                                 7m28s
jaeger-all-in-one-inmemory-collector-headless   ClusterIP   None             <none>        9411/TCP,14250/TCP,14267/TCP,14268/TCP   16m

cluster-collector-collector-headless            ClusterIP   None             <none>        9411/TCP                                 7m28s
jaeger-all-in-one-inmemory-collector-headless   ClusterIP   None             <none>        9411/TCP,14250/TCP,14267/TCP,14268/TCP   16m

Copy to Clipboard

Toggle word wrap

これらのサービスは、Jaeger、Knative Serving、および Knative Eventing を設定するのに使用されます。Jaeger サービスの名前は異なる場合があります。

「OpenShift Serverless Operator のインストール」ドキュメントに従って、OpenShift Serverless Operator をインストールします。

以下の KnativeServing CR を作成して Knative Serving をインストールします。

KnativeServing CR の例

apiVersion: operator.knative.dev/v1beta1
kind: KnativeServing
metadata:
    name: knative-serving
    namespace: knative-serving
spec:
  config:
    tracing:
      backend: "zipkin"
      zipkin-endpoint: "http://cluster-collector-collector-headless.tracing-system.svc:9411/api/v2/spans"
      debug: "false"
      sample-rate: "0.1"

apiVersion: operator.knative.dev/v1beta1
kind: KnativeServing
metadata:
    name: knative-serving
    namespace: knative-serving
spec:
  config:
    tracing:
      backend: "zipkin"
      zipkin-endpoint: "http://cluster-collector-collector-headless.tracing-system.svc:9411/api/v2/spans"
      debug: "false"
      sample-rate: "0.1"

Copy to Clipboard

Toggle word wrap

1: sample-rate はサンプリングの可能性を定義します。sample-rate: "0.1" を使用すると、10 トレースの 1 つがサンプリングされます。

次の KnativeEventing CR を作成して、Knative Eventing をインストールします。

KnativeEventing CR の例

apiVersion: operator.knative.dev/v1beta1
kind: KnativeEventing
metadata:
    name: knative-eventing
    namespace: knative-eventing
spec:
  config:
    tracing:
      backend: "zipkin"
      zipkin-endpoint: "http://cluster-collector-collector-headless.tracing-system.svc:9411/api/v2/spans"
      debug: "false"
      sample-rate: "0.1"

apiVersion: operator.knative.dev/v1beta1
kind: KnativeEventing
metadata:
    name: knative-eventing
    namespace: knative-eventing
spec:
  config:
    tracing:
      backend: "zipkin"
      zipkin-endpoint: "http://cluster-collector-collector-headless.tracing-system.svc:9411/api/v2/spans"
      debug: "false"
      sample-rate: "0.1"

Copy to Clipboard

Toggle word wrap

1: sample-rate はサンプリングの可能性を定義します。sample-rate: "0.1" を使用すると、10 トレースの 1 つがサンプリングされます。

Knative サービスを作成します。

サービスの例

apiVersion: serving.knative.dev/v1
kind: Service
metadata:
  name: helloworld-go
spec:
  template:
    metadata:
      labels:
        app: helloworld-go
      annotations:
        autoscaling.knative.dev/minScale: "1"
        autoscaling.knative.dev/target: "1"
    spec:
      containers:
      - image: quay.io/openshift-knative/helloworld:v1.2
        imagePullPolicy: Always
        resources:
          requests:
            cpu: "200m"
        env:
        - name: TARGET
          value: "Go Sample v1"

apiVersion: serving.knative.dev/v1
kind: Service
metadata:
  name: helloworld-go
spec:
  template:
    metadata:
      labels:
        app: helloworld-go
      annotations:
        autoscaling.knative.dev/minScale: "1"
        autoscaling.knative.dev/target: "1"
    spec:
      containers:
      - image: quay.io/openshift-knative/helloworld:v1.2
        imagePullPolicy: Always
        resources:
          requests:
            cpu: "200m"
        env:
        - name: TARGET
          value: "Go Sample v1"

Copy to Clipboard

Toggle word wrap

サービスにいくつかのリクエストを行います。
HTTPS 要求の例
```
curl https://helloworld-go.example.com
```
```
$ curl https://helloworld-go.example.com
```
Copy to Clipboard Toggle word wrap
Jaeger Web コンソールの URL を取得します。
コマンドの例
```
oc get route jaeger-all-in-one-inmemory  -o jsonpath='{.spec.host}' -n <namespace>
```
```
$ oc get route jaeger-all-in-one-inmemory  -o jsonpath='{.spec.host}' -n <namespace>
```
Copy to Clipboard Toggle word wrap
Jaeger コンソールを使用してトレースを検証できるようになりました。

4.3. Jaeger 分散トレースの使用
リンクのコピー

Red Hat OpenShift 分散トレースのすべてのコンポーネントをインストールしたくない場合でも、OpenShift Serverless を使用する OpenShift Container Platform で分散トレースを使用できます。

4.3.1. 分散トレースを有効にするための Jaeger の設定
リンクのコピー

Jaeger を使用して分散トレースを有効にするには、Jaeger をスタンドアロン統合としてインストールおよび設定する必要があります。

前提条件

OpenShift Container Platform に対するクラスター管理者権限があるか、Red Hat OpenShift Service on AWS または OpenShift Dedicated に対するクラスターまたは専用管理者権限がある。
OpenShift Serverless Operator、Knative Serving、および Knative Eventing がインストールされている。
Red Hat OpenShift 分散トレースプラットフォーム Operator がインストールされている。
OpenShift CLI (oc) がインストールされている。
アプリケーションおよび他のワークロードを作成するために、プロジェクトを作成しているか、適切なロールおよびパーミッションが割り当てられたプロジェクトにアクセスできる。

手順

以下を含む Jaeger カスタムリソース (CR) を作成して適用します。

Jaeger CR

apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: jaeger
  namespace: default

apiVersion: jaegertracing.io/v1
kind: Jaeger
metadata:
  name: jaeger
  namespace: default

Copy to Clipboard

Toggle word wrap

KnativeServing CR を編集し、トレース用に YAML 設定を追加して、Knative Serving のトレースを有効にします。
Serving の YAML のトレース例
```
apiVersion: operator.knative.dev/v1beta1
kind: KnativeServing
metadata:
  name: knative-serving
  namespace: knative-serving
spec:
  config:
    tracing:
      sample-rate: "0.1" 
      backend: zipkin 
      zipkin-endpoint: "http://jaeger-collector.default.svc.cluster.local:9411/api/v2/spans" 
      debug: "false" 
```
```
apiVersion: operator.knative.dev/v1beta1
kind: KnativeServing
metadata:
  name: knative-serving
  namespace: knative-serving
spec:
  config:
    tracing:
      sample-rate: "0.1" 
```
1
```
      backend: zipkin 
```
2
```
      zipkin-endpoint: "http://jaeger-collector.default.svc.cluster.local:9411/api/v2/spans" 
```
3
```
      debug: "false" 
```
4
Copy to Clipboard Toggle word wrap
1
sample-rate はサンプリングの可能性を定義します。sample-rate: "0.1" を使用すると、10 トレースの 1 つがサンプリングされます。
2
backend は zipkin に設定される必要があります。
3
zipkin-endpoint は jaeger-collector サービスエンドポイントを参照する必要があります。このエンドポイントを取得するには、Jaeger CR が適用される namespace を置き換えます。
4
デバッグは false に設定する必要があります。debug: "true" を設定してデバッグモードを有効にして、サンプリングをバイパスしてすべてのスパンがサーバーに送信されるようにします。
KnativeEventing CR を編集して、Knative Eventing のトレースを有効にします。
Eventing の YAML のトレース例
```
apiVersion: operator.knative.dev/v1beta1
kind: KnativeEventing
metadata:
  name: knative-eventing
  namespace: knative-eventing
spec:
  config:
    tracing:
      sample-rate: "0.1" 
      backend: zipkin 
      zipkin-endpoint: "http://jaeger-collector.default.svc.cluster.local:9411/api/v2/spans" 
      debug: "false" 
```
```
apiVersion: operator.knative.dev/v1beta1
kind: KnativeEventing
metadata:
  name: knative-eventing
  namespace: knative-eventing
spec:
  config:
    tracing:
      sample-rate: "0.1" 
```
1
```
      backend: zipkin 
```
2
```
      zipkin-endpoint: "http://jaeger-collector.default.svc.cluster.local:9411/api/v2/spans" 
```
3
```
      debug: "false" 
```
4
Copy to Clipboard Toggle word wrap
1
sample-rate はサンプリングの可能性を定義します。sample-rate: "0.1" を使用すると、10 トレースの 1 つがサンプリングされます。
2
backend を zipkin に設定します。
3
zipkin-endpoint を jaeger-collector サービスエンドポイントに指定する必要があります。このエンドポイントを取得するには、Jaeger CR が適用される namespace を置き換えます。
4
デバッグは false に設定する必要があります。debug: "true" を設定してデバッグモードを有効にして、サンプリングをバイパスしてすべてのスパンがサーバーに送信されるようにします。

検証

jaeger ルートを使用して Jaeger Web コンソールにアクセスし、追跡データを表示できます。

以下のコマンドを入力して jaeger ルートのホスト名を取得します。

oc get route jaeger -n default

$ oc get route jaeger -n default

Copy to Clipboard

Toggle word wrap

出力例

NAME     HOST/PORT                         PATH   SERVICES       PORT    TERMINATION   WILDCARD
jaeger   jaeger-default.apps.example.com          jaeger-query   <all>   reencrypt     None

NAME     HOST/PORT                         PATH   SERVICES       PORT    TERMINATION   WILDCARD
jaeger   jaeger-default.apps.example.com          jaeger-query   <all>   reencrypt     None

Copy to Clipboard

Toggle word wrap

ブラウザーでエンドポイントアドレスを開き、コンソールを表示します。

法律上の通知
リンクのコピー

The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.

Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

可観測性

管理者および開発者メトリクス、クラスターロギング、トレースなどの可観測性機能

第1章 管理者メトリクスリンクのコピーリンクがクリップボードにコピーされました!

1.1. サーバーレス管理者のメトリクスリンクのコピーリンクがクリップボードにコピーされました!

1.1.1. 前提条件リンクのコピーリンクがクリップボードにコピーされました!

1.2. Serverless コントローラーメトリクスリンクのコピーリンクがクリップボードにコピーされました!

1.3. Webhook メトリクスリンクのコピーリンクがクリップボードにコピーされました!

1.4. Knative Eventing メトリクスリンクのコピーリンクがクリップボードにコピーされました!

1.4.1. ブローカー Ingress メトリクスリンクのコピーリンクがクリップボードにコピーされました!

1.4.2. ブローカーフィルターメトリクスリンクのコピーリンクがクリップボードにコピーされました!

1.4.3. InMemoryChannel dispatcher メトリクスリンクのコピーリンクがクリップボードにコピーされました!

1.4.4. イベントソースメトリクスリンクのコピーリンクがクリップボードにコピーされました!

1.4.5. Knative Kafka ブローカーメトリクスリンクのコピーリンクがクリップボードにコピーされました!

1.4.6. Knative Kafka トリガーメトリクスリンクのコピーリンクがクリップボードにコピーされました!

1.4.7. Knative Kafka チャネルメトリクスリンクのコピーリンクがクリップボードにコピーされました!

1.4.8. Knative Kafka サブスクリプションメトリクスリンクのコピーリンクがクリップボードにコピーされました!

1.4.9. Knative Kafka ソースメトリクスリンクのコピーリンクがクリップボードにコピーされました!

1.4.10. Knative Kafka シンクメトリクスリンクのコピーリンクがクリップボードにコピーされました!

1.5. Knative Serving メトリクスリンクのコピーリンクがクリップボードにコピーされました!

1.5.1. activator メトリクスリンクのコピーリンクがクリップボードにコピーされました!

1.5.2. Autoscaler メトリクスリンクのコピーリンクがクリップボードにコピーされました!

1.5.3. Go ランタイムメトリクスリンクのコピーリンクがクリップボードにコピーされました!

第2章 開発者メトリクスリンクのコピーリンクがクリップボードにコピーされました!

2.1. Serverless 開発者メトリクスの概要リンクのコピーリンクがクリップボードにコピーされました!

2.2. デフォルトで公開される Knative サービスメトリクスリンクのコピーリンクがクリップボードにコピーされました!

2.3. カスタムアプリケーションメトリクスを含む Knative サービスリンクのコピーリンクがクリップボードにコピーされました!

2.4. カスタムメトリクスの収集の設定リンクのコピーリンクがクリップボードにコピーされました!

2.5. サービスのメトリクスの検証リンクのコピーリンクがクリップボードにコピーされました!

2.5.1. キュープロキシーメトリクスリンクのコピーリンクがクリップボードにコピーされました!

2.6. サービスメトリクスのダッシュボードリンクのコピーリンクがクリップボードにコピーされました!

2.6.1. ダッシュボードでのサービスのメトリクスの検証リンクのコピーリンクがクリップボードにコピーされました!

第3章 クラスターロギングリンクのコピーリンクがクリップボードにコピーされました!

3.1. Serving と Eventing のログ設定の構成リンクのコピーリンクがクリップボードにコピーされました!

3.1.1. サポート対象のログレベルリンクのコピーリンクがクリップボードにコピーされました!

3.1.2. ログ設定の構成リンクのコピーリンクがクリップボードにコピーされました!

3.1.3. リクエストログ設定の構成リンクのコピーリンクがクリップボードにコピーされました!

3.1.4. リクエストロギングのパラメーターリンクのコピーリンクがクリップボードにコピーされました!

第4章 トレーシングリンクのコピーリンクがクリップボードにコピーされました!

4.1. リクエストのトレースリンクのコピーリンクがクリップボードにコピーされました!

4.1.1. 分散トレースの概要リンクのコピーリンクがクリップボードにコピーされました!

4.2. Red Hat OpenShift 分散トレースの使用リンクのコピーリンクがクリップボードにコピーされました!

4.2.1. Red Hat OpenShift 分散トレースを使用して分散トレースを有効にするリンクのコピーリンクがクリップボードにコピーされました!

4.3. Jaeger 分散トレースの使用リンクのコピーリンクがクリップボードにコピーされました!

4.3.1. 分散トレースを有効にするための Jaeger の設定リンクのコピーリンクがクリップボードにコピーされました!

法律上の通知リンクのコピーリンクがクリップボードにコピーされました!

詳細情報

試用、購入および販売

コミュニティー

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

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

会社概要

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

第1章管理者メトリクス
リンクのコピー

1.1. サーバーレス管理者のメトリクス
リンクのコピー

1.1.1. 前提条件
リンクのコピー

1.2. Serverless コントローラーメトリクス
リンクのコピー

1.3. Webhook メトリクス
リンクのコピー

1.4. Knative Eventing メトリクス
リンクのコピー

1.4.1. ブローカー Ingress メトリクス
リンクのコピー

1.4.2. ブローカーフィルターメトリクス
リンクのコピー

1.4.3. InMemoryChannel dispatcher メトリクス
リンクのコピー

1.4.4. イベントソースメトリクス
リンクのコピー

1.4.5. Knative Kafka ブローカーメトリクス
リンクのコピー

1.4.6. Knative Kafka トリガーメトリクス
リンクのコピー

1.4.7. Knative Kafka チャネルメトリクス
リンクのコピー

1.4.8. Knative Kafka サブスクリプションメトリクス
リンクのコピー

1.4.9. Knative Kafka ソースメトリクス
リンクのコピー

1.4.10. Knative Kafka シンクメトリクス
リンクのコピー

1.5. Knative Serving メトリクス
リンクのコピー

1.5.1. activator メトリクス
リンクのコピー

1.5.2. Autoscaler メトリクス
リンクのコピー

1.5.3. Go ランタイムメトリクス
リンクのコピー

第2章開発者メトリクス
リンクのコピー

2.1. Serverless 開発者メトリクスの概要
リンクのコピー

2.2. デフォルトで公開される Knative サービスメトリクス
リンクのコピー

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

2.4. カスタムメトリクスの収集の設定
リンクのコピー

2.5. サービスのメトリクスの検証
リンクのコピー

2.5.1. キュープロキシーメトリクス
リンクのコピー

2.6. サービスメトリクスのダッシュボード
リンクのコピー

2.6.1. ダッシュボードでのサービスのメトリクスの検証
リンクのコピー

第3章クラスターロギング
リンクのコピー

3.1. Serving と Eventing のログ設定の構成
リンクのコピー

3.1.1. サポート対象のログレベル
リンクのコピー

3.1.2. ログ設定の構成
リンクのコピー

3.1.3. リクエストログ設定の構成
リンクのコピー

3.1.4. リクエストロギングのパラメーター
リンクのコピー

第4章トレーシング
リンクのコピー

4.1. リクエストのトレース
リンクのコピー

4.1.1. 分散トレースの概要
リンクのコピー

4.2. Red Hat OpenShift 分散トレースの使用
リンクのコピー

4.2.1. Red Hat OpenShift 分散トレースを使用して分散トレースを有効にする
リンクのコピー

4.3. Jaeger 分散トレースの使用
リンクのコピー

4.3.1. 分散トレースを有効にするための Jaeger の設定
リンクのコピー

法律上の通知
リンクのコピー