4.2. メトリクス機能


Micrometer を使用してメトリクスを収集します。

重要

CXF Metrics 機能 とは異なり、この Quarkus CXF エクステンションは Dropwizard Metrics をサポートしません。Micrometer のみサポートされます。

4.2.1. Maven コーディネート

code.quarkus.redhat.com で quarkus-cxf-rt-features-metrics を使用して新規プロジェクト を作成するか、既存プロジェクトに次の座標を追加します。

<dependency>
    <groupId>io.quarkiverse.cxf</groupId>
    <artifactId>quarkus-cxf-rt-features-metrics</artifactId>
</dependency>

4.2.2. 使用方法

CXF の Quarkus Micrometer エコシステムへのインテグレーションは、io.quarkiverse.cxf.metrics.QuarkusCxfMetricsFeature を使用して実装されます。アプリケーションが quarkus-cxf-rt-features-metrics に依存している限り、QuarkusCxfMetricsFeature のインスタンスが内部的に作成され、Quarkus CXF によって作成されたすべてのクライアントとサービスエンドポイントに対してデフォルトで有効になります。以下に記載されている quarkus.cxf.metrics.enabled-forquarkus.cxf.client."client-name".metrics.enabled および quarkus.cxf.endpoint."/endpoint-path".metrics.enabled プロパティーを使用して無効にできます。

4.2.2.1. 実行可能な例

Quarkus CXF ソースツリーには、Micrometer Metrics を対象とする integration test があります。

当然のことながら、これは quarkus-cxf-rt-features-metrics に依存します。

pom.xml

<dependency>
    <groupId>io.quarkiverse.cxf</groupId>
    <artifactId>quarkus-cxf-rt-features-metrics</artifactId>
</dependency>

quarkus-micrometer-registry-prometheus エクステンションを使用して、メトリクスを JSON 形式でエクスポートします。Prometheus の場合は次のとおりとなります。

pom.xml

<dependency>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-micrometer-registry-prometheus</artifactId>
</dependency>

REST エンドポイント経由で収集されたメトリクスを検査するには、次の設定が必要です。

application.properties

quarkus.micrometer.export.json.enabled = true
quarkus.micrometer.export.json.path = metrics/json
quarkus.micrometer.export.prometheus.path = metrics/prometheus

上記をすべて完了すると、アプリケーションを開発モードで起動できます。

$ mvn quarkus:dev

ここで、HelloService に要求を送信します。

$ curl \
  -d '<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><ns2:helloResponse xmlns:ns2="http://it.server.metrics.cxf.quarkiverse.io/"><return>Hello Joe!</return></ns2:helloResponse></soap:Body></soap:Envelope>' \
  -H 'Content-Type: text/xml' \
  -X POST \
  http://localhost:8080/metrics/client/hello

その後、上記で設定したエンドポイントの出力の cxf.server.requests の下にいくつかのメトリクスが表示されます。

$ curl http://localhost:8080/q/metrics/json
metrics: {
    ...
    "cxf.server.requests": {
        "count;exception=None;faultCode=None;method=POST;operation=hello;outcome=SUCCESS;status=200;uri=/soap/hello": 2,
        "elapsedTime;exception=None;faultCode=None;method=POST;operation=hello;outcome=SUCCESS;status=200;uri=/soap/hello": 64.0
    },
    ...
}

4.2.3. 設定

lock ビルド時に修正される設定プロパティー。その他の設定プロパティーはすべて、ランタイム時にオーバーライドが可能です。

Expand
設定プロパティーデフォルト

quarkus.cxf.metrics.enabled-for

clientsservicesbothnone

both

メトリクス収集を有効にする対象 (クライアント、サービス、両方、該当なし) を指定します。このグローバル設定は quarkus.cxf.client."client-name".metrics.enabled または quarkus.cxf.endpoint."/endpoint-path".metrics.enabled オプションを使用して、クライアントまたはサービスエンドポイントごとにオーバーライドできます。

環境変数: QUARKUS_CXF_METRICS_ENABLED_FOR
Quarkus CXF: 2.7.0 以降

quarkus.cxf.metrics.tags-customizers

string のリスト

 

グローバルメトリクス機能にアタッチされる org.apache.cxf.metrics.micrometer.provider.TagsCustomizer Bean への 参照 リスト。

環境変数: QUARKUS_CXF_METRICS_TAGS_CUSTOMIZERS
Quarkus CXF: 3.15.0 以降

quarkus.cxf.client."client-name".metrics.enabled

boolean

true

true の場合、quarkus.cxf.metrics.enabled-forboth または clients に設定されていれば、MetricsFeature がこのクライアントに追加されます。そうでない場合、このクライアントにこの機能は追加されません。

環境変数: QUARKUS_CXF_CLIENT__CLIENT_NAME__METRICS_ENABLED
Quarkus CXF: 2.7.0 以降

quarkus.cxf.endpoint."/endpoint-path".metrics.enabled

boolean

true

true の場合、quarkus.cxf.metrics.enabled-forboth または services に設定されていれば、MetricsFeature がこのサービスエンドポイントに追加されます。そうでない場合、このサービスエンドポイントにこの機能は追加されません。

環境変数: QUARKUS_CXF_ENDPOINT___ENDPOINT_PATH__METRICS_ENABLED
Quarkus CXF: 2.7.0 以降

Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

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

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2026 Red Hat
トップに戻る