You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cxf.apache.org by bu...@apache.org on 2020/11/01 14:57:17 UTC
svn commit: r1067431 - in /websites/production/cxf/content:
cache/docs.pageCache docs/dropwizard-metrics.html docs/micrometer.html
Author: buildbot
Date: Sun Nov 1 14:57:16 2020
New Revision: 1067431
Log:
Production update by buildbot for cxf
Modified:
websites/production/cxf/content/cache/docs.pageCache
websites/production/cxf/content/docs/dropwizard-metrics.html
websites/production/cxf/content/docs/micrometer.html
Modified: websites/production/cxf/content/cache/docs.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/cxf/content/docs/dropwizard-metrics.html
==============================================================================
--- websites/production/cxf/content/docs/dropwizard-metrics.html (original)
+++ websites/production/cxf/content/docs/dropwizard-metrics.html Sun Nov 1 14:57:16 2020
@@ -108,13 +108,17 @@ Apache CXF -- Dropwizard Metrics
<!-- Content -->
<div class="wiki-content">
<div id="ConfluenceContent"><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1603587551324 {padding: 0px;}
-div.rbtoc1603587551324 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1603587551324 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1604242594885 {padding: 0px;}
+div.rbtoc1604242594885 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1604242594885 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1603587551324">
-<ul class="toc-indentation"><li><a shape="rect" href="#DropwizardMetrics-Introduction">Introduction</a></li><li><a shape="rect" href="#DropwizardMetrics-MetricsProvider">Metrics Provider</a></li><li><a shape="rect" href="#DropwizardMetrics-IntegrationwithJAX-WS">Integration with JAX-WS</a></li><li><a shape="rect" href="#DropwizardMetrics-IntegrationwithJAX-RS">Integration with JAX-RS</a></li></ul>
-</div><h2 id="DropwizardMetrics-Introduction">Introduction</h2><h2 id="DropwizardMetrics-MetricsProvider">Metrics Provider</h2><h2 id="DropwizardMetrics-IntegrationwithJAX-WS">Integration with JAX-WS</h2><h2 id="DropwizardMetrics-IntegrationwithJAX-RS">Integration with JAX-RS</h2></div>
+/*]]>*/</style></p><div class="toc-macro rbtoc1604242594885">
+<ul class="toc-indentation"><li><a shape="rect" href="#DropwizardMetrics-Introduction">Introduction</a></li><li><a shape="rect" href="#DropwizardMetrics-MetricsProvider">Metrics Provider</a></li><li><a shape="rect" href="#DropwizardMetrics-Configuration">Configuration</a></li><li><a shape="rect" href="#DropwizardMetrics-IntegrationwithJAX-WS">Integration with JAX-WS</a>
+<ul class="toc-indentation"><li><a shape="rect" href="#DropwizardMetrics-Server">Server</a></li><li><a shape="rect" href="#DropwizardMetrics-Client">Client</a></li></ul>
+</li><li><a shape="rect" href="#DropwizardMetrics-IntegrationwithJAX-RS">Integration with JAX-RS</a>
+<ul class="toc-indentation"><li><a shape="rect" href="#DropwizardMetrics-Server.1">Server</a></li><li><a shape="rect" href="#DropwizardMetrics-Client.1">Client</a></li></ul>
+</li></ul>
+</div><h2 id="DropwizardMetrics-Introduction">Introduction</h2><h2 id="DropwizardMetrics-MetricsProvider">Metrics Provider</h2><h2 id="DropwizardMetrics-Configuration">Configuration</h2><h2 id="DropwizardMetrics-IntegrationwithJAX-WS">Integration with JAX-WS</h2><h3 id="DropwizardMetrics-Server">Server</h3><h3 id="DropwizardMetrics-Client">Client</h3><h2 id="DropwizardMetrics-IntegrationwithJAX-RS">Integration with JAX-RS</h2><h3 id="DropwizardMetrics-Server.1">Server</h3><h3 id="DropwizardMetrics-Client.1">Client</h3></div>
</div>
<!-- Content -->
</td>
Modified: websites/production/cxf/content/docs/micrometer.html
==============================================================================
--- websites/production/cxf/content/docs/micrometer.html (original)
+++ websites/production/cxf/content/docs/micrometer.html Sun Nov 1 14:57:16 2020
@@ -118,13 +118,17 @@ Apache CXF -- Micrometer
<!-- Content -->
<div class="wiki-content">
<div id="ConfluenceContent"><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1603587550233 {padding: 0px;}
-div.rbtoc1603587550233 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1603587550233 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1604242598961 {padding: 0px;}
+div.rbtoc1604242598961 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1604242598961 li {margin-left: 0px;padding-left: 0px;}
-/*]]>*/</style></p><div class="toc-macro rbtoc1603587550233">
-<ul class="toc-indentation"><li><a shape="rect" href="#Micrometer-Introduction">Introduction</a></li><li><a shape="rect" href="#Micrometer-MetricsProvider">Metrics Provider</a></li><li><a shape="rect" href="#Micrometer-Configuration">Configuration</a></li><li><a shape="rect" href="#Micrometer-IntegrationwithJAX-WS">Integration with JAX-WS</a></li><li><a shape="rect" href="#Micrometer-IntegrationwithJAX-RS">Integration with JAX-RS</a></li></ul>
-</div><h2 id="Micrometer-Introduction">Introduction</h2><p>The <a shape="rect" class="external-link" href="https://micrometer.io/" rel="nofollow">Micrometer</a> metrics library become a de factor instrumentation choice for JVM application. It has been supported by Apache CXF starting from <strong>3.4.1</strong> / <strong>3.3.8 </strong>and above.</p><h2 id="Micrometer-MetricsProvider">Metrics Provider</h2><p>The <a shape="rect" class="external-link" href="https://micrometer.io/" rel="nofollow">Micrometer</a> integration is provided by <a shape="rect" class="external-link" href="https://github.com/apache/cxf/blob/master/rt/features/metrics/src/main/java/org/apache/cxf/metrics/micrometer/MicrometerMetricsProvider.java" rel="nofollow">MicrometerMetricsProvider</a>.</p><h2 id="Micrometer-Configuration">Configuration</h2><p>There <a shape="rect" class="external-link" href="https://github.com/apache/cxf/blob/master/rt/features/metrics/src/main/java/org/apache/cxf/metrics/micrometer/Microm
eterMetricsProvider.java" rel="nofollow">MicrometerMetricsProvider</a> supports the following properties (encapsulated inside <a shape="rect" class="external-link" href="https://github.com/apache/cxf/blob/master/rt/features/metrics/src/main/java/org/apache/cxf/metrics/micrometer/MicrometerMetricsProperties.java" rel="nofollow">MicrometerMetricsProperties</a>).</p><div class="table-wrap"><table class="wrapped confluenceTable"><colgroup span="1"><col span="1"><col span="1"><col span="1"></colgroup><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Property</th><th colspan="1" rowspan="1" class="confluenceTh">Description</th><th colspan="1" rowspan="1" class="confluenceTh">Default</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><strong>autoTimeRequests</strong></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Whether requests handled by CXF should be automatically timed.  If the number of time series emitted grows <br clear="none">too large on account
of request mapping timings, set it to "false" and use <a shape="rect" class="external-link" href="https://github.com/micrometer-metrics/micrometer/blob/master/micrometer-core/src/main/java/io/micrometer/core/annotation/Timed.java" rel="nofollow">@Timed</a> or <a shape="rect" class="external-link" href="https://github.com/micrometer-metrics/micrometer/blob/master/micrometer-core/src/main/java/io/micrometer/core/annotation/TimedSet.java" rel="nofollow">@TimeSet</a> on a per <br clear="none">invocation basis as needed.</p></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>true</strong></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><strong>requestsMetricName</strong></td><td colspan="1" rowspan="1" class="confluenceTd">Name of the metric for received requests</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>cxf.server.requests</strong></td></tr></tbody></table></div><h2 id="Micrometer-IntegrationwithJAX-WS">Integration with JAX-WS</h2><p>The
typical way to plug <a shape="rect" class="external-link" href="https://micrometer.io/" rel="nofollow">Micrometer</a> integration is by using <a shape="rect" class="external-link" href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceFeature.html" rel="nofollow">WebServiceFeature</a> mechanism, for which there is a dedicated <a shape="rect" class="external-link" href="https://github.com/apache/cxf/blob/master/rt/features/metrics/src/main/java/org/apache/cxf/metrics/MetricsFeature.java" rel="nofollow">MetricsFeature</a> implementation. The snipped below illustrated the basic initialization sequence and set of the dependencies involved.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+/*]]>*/</style></p><div class="toc-macro rbtoc1604242598961">
+<ul class="toc-indentation"><li><a shape="rect" href="#Micrometer-Introduction">Introduction</a></li><li><a shape="rect" href="#Micrometer-MetricsProvider">Metrics Provider</a></li><li><a shape="rect" href="#Micrometer-Configuration">Configuration</a></li><li><a shape="rect" href="#Micrometer-IntegrationwithJAX-WS">Integration with JAX-WS</a>
+<ul class="toc-indentation"><li><a shape="rect" href="#Micrometer-Server">Server</a></li><li><a shape="rect" href="#Micrometer-Client">Client</a></li></ul>
+</li><li><a shape="rect" href="#Micrometer-IntegrationwithJAX-RS">Integration with JAX-RS</a>
+<ul class="toc-indentation"><li><a shape="rect" href="#Micrometer-Server.1">Server</a></li><li><a shape="rect" href="#Micrometer-Client.1">Client</a></li></ul>
+</li></ul>
+</div><h2 id="Micrometer-Introduction">Introduction</h2><p>The <a shape="rect" class="external-link" href="https://micrometer.io/" rel="nofollow">Micrometer</a> metrics library become a de factor instrumentation choice for JVM application. It has been supported by Apache CXF starting from <strong>3.4.1</strong> / <strong>3.3.8 </strong>and above.</p><h2 id="Micrometer-MetricsProvider">Metrics Provider</h2><p>The <a shape="rect" class="external-link" href="https://micrometer.io/" rel="nofollow">Micrometer</a> integration is provided by <a shape="rect" class="external-link" href="https://github.com/apache/cxf/blob/master/rt/features/metrics/src/main/java/org/apache/cxf/metrics/micrometer/MicrometerMetricsProvider.java" rel="nofollow">MicrometerMetricsProvider</a>.</p><h2 id="Micrometer-Configuration">Configuration</h2><p>There <a shape="rect" class="external-link" href="https://github.com/apache/cxf/blob/master/rt/features/metrics/src/main/java/org/apache/cxf/metrics/micrometer/Microm
eterMetricsProvider.java" rel="nofollow">MicrometerMetricsProvider</a> supports the following properties (encapsulated inside <a shape="rect" class="external-link" href="https://github.com/apache/cxf/blob/master/rt/features/metrics/src/main/java/org/apache/cxf/metrics/micrometer/MicrometerMetricsProperties.java" rel="nofollow">MicrometerMetricsProperties</a>).</p><div class="table-wrap"><table class="wrapped confluenceTable"><colgroup span="1"><col span="1"><col span="1"><col span="1"></colgroup><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Property</th><th colspan="1" rowspan="1" class="confluenceTh">Description</th><th colspan="1" rowspan="1" class="confluenceTh">Default</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><strong>autoTimeRequests</strong></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Whether requests handled by CXF should be automatically timed.  If the number of time series emitted grows <br clear="none">too large on account
of request mapping timings, set it to "false" and use <a shape="rect" class="external-link" href="https://github.com/micrometer-metrics/micrometer/blob/master/micrometer-core/src/main/java/io/micrometer/core/annotation/Timed.java" rel="nofollow">@Timed</a> or <a shape="rect" class="external-link" href="https://github.com/micrometer-metrics/micrometer/blob/master/micrometer-core/src/main/java/io/micrometer/core/annotation/TimedSet.java" rel="nofollow">@TimeSet</a> on a per <br clear="none">invocation basis as needed.</p></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>true</strong></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd"><strong>serverRequestsMetricName</strong></td><td colspan="1" rowspan="1" class="confluenceTd">Name of the metric for received requests (server-side)</td><td colspan="1" rowspan="1" class="confluenceTd"><strong>cxf.server.requests</strong></td></tr></tbody></table></div><h2 id="Micrometer-IntegrationwithJAX-WS">Integration wit
h JAX-WS</h2><h3 id="Micrometer-Server">Server</h3><p>The typical way to plug <a shape="rect" class="external-link" href="https://micrometer.io/" rel="nofollow">Micrometer</a> integration on the server-side is by using <a shape="rect" class="external-link" href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceFeature.html" rel="nofollow">WebServiceFeature</a> mechanism, for which there is a dedicated <a shape="rect" class="external-link" href="https://github.com/apache/cxf/blob/master/rt/features/metrics/src/main/java/org/apache/cxf/metrics/MetricsFeature.java" rel="nofollow">MetricsFeature</a> implementation. The snipped below illustrated the basic initialization sequence and set of the dependencies involved.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<pre class="brush: java; gutter: false; theme: Default">final MeterRegistry registry = ...; /* Micrometer MeterRegistry instance */
final JaxwsTags jaxwsTags = new JaxwsTags();
@@ -137,10 +141,31 @@ final MicrometerMetricsProperties proper
final MetricsProvider metricsProvider = new MicrometerMetricsProvider(registry, tagsProvider,
Arrays.asList(operationsCustomizer, faultsCustomizer), new DefaultTimedAnnotationProvider(), properties);
-EndpointImpl endpoint = new EndpointImpl(bus, new HelloPortImpl(), null, null, new WebServiceFeature[]{
+final JAXWSServerFactoryBean factory = new JAXWSServerFactoryBean();
+factory.setWsFeatures(Arrays.asList(new MetricsFeature(metricsProvider)));
+...
+
+</pre>
+</div></div><p>Alternatively, the <a shape="rect" class="external-link" href="https://github.com/apache/cxf/blob/master/rt/features/metrics/src/main/java/org/apache/cxf/metrics/MetricsFeature.java" rel="nofollow">MetricsFeature</a> could be supplied directly to JAX-WS endpoint, for example:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: false; theme: Default">EndpointImpl endpoint = new EndpointImpl(bus, new HelloPortImpl(), null, null, new WebServiceFeature[]{
new MetricsFeature(metricsProvider)
});</pre>
-</div></div><p><br clear="none"></p><h2 id="Micrometer-IntegrationwithJAX-RS">Integration with JAX-RS</h2><p>No fully supported at the moment</p></div>
+</div></div><h3 id="Micrometer-Client">Client</h3><p>No supported at the moment</p><h2 id="Micrometer-IntegrationwithJAX-RS">Integration with JAX-RS</h2><h3 id="Micrometer-Server.1">Server</h3><p>The typical way to plug <a shape="rect" class="external-link" href="https://micrometer.io/" rel="nofollow">Micrometer</a> integration  on the server-side is by using <a shape="rect" class="external-link" href="https://github.com/apache/cxf/blob/master/core/src/main/java/org/apache/cxf/feature/AbstractFeature.java" rel="nofollow">AbstractFeature</a> which is implemented by <a shape="rect" class="external-link" href="https://github.com/apache/cxf/blob/master/rt/features/metrics/src/main/java/org/apache/cxf/metrics/MetricsFeature.java" rel="nofollow">MetricsFeature</a>. The snipped below illustrated the basic initialization sequence and set of the dependencies involved.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: false; theme: Default">final MeterRegistry registry = ...; /* Micrometer MeterRegistry instance */
+
+final JaxrsTags jaxrsTags = new JaxrsTags();
+final TagsCustomizer operationsCustomizer = new JaxrsOperationTagsCustomizer(jaxrsTags);
+
+final TagsProvider tagsProvider = new StandardTagsProvider(new DefaultExceptionClassProvider(), new StandardTags());
+final MicrometerMetricsProperties properties = new MicrometerMetricsProperties();
+
+final MetricsProvider metricsProvider = new MicrometerMetricsProvider(registry, tagsProvider,
+ Arrays.asList(operationsCustomizer), new DefaultTimedAnnotationProvider(), properties);
+
+final JAXRSServerFactoryBean factory = new JAXRSServerFactoryBean();
+factory.setFeatures(Arrays.asList(new MetricsFeature(metricsProvider)));
+...</pre>
+</div></div><h3 id="Micrometer-Client.1">Client</h3><p>No supported at the moment</p></div>
</div>
<!-- Content -->
</td>