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 21:57:19 UTC

svn commit: r1067440 - in /websites/production/cxf/content: cache/docs.pageCache docs/dropwizard-metrics.html

Author: buildbot
Date: Sun Nov  1 21:57:19 2020
New Revision: 1067440

Log:
Production update by buildbot for cxf

Modified:
    websites/production/cxf/content/cache/docs.pageCache
    websites/production/cxf/content/docs/dropwizard-metrics.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 21:57:19 2020
@@ -28,6 +28,16 @@
 <meta name="description" content="Apache CXF, Services Framework - Dropwizard Metrics">
 
 
+<link type="text/css" rel="stylesheet" href="/resources/highlighter/styles/shCoreCXF.css">
+<link type="text/css" rel="stylesheet" href="/resources/highlighter/styles/shThemeCXF.css">
+
+<script src='/resources/highlighter/scripts/shCore.js'></script>
+<script src='/resources/highlighter/scripts/shBrushJava.js'></script>
+<script src='/resources/highlighter/scripts/shBrushBash.js'></script>
+<script>
+  SyntaxHighlighter.defaults['toolbar'] = false;
+  SyntaxHighlighter.all();
+</script>
 
 
     <title>
@@ -108,17 +118,45 @@ Apache CXF -- Dropwizard Metrics
            <!-- Content -->
            <div class="wiki-content">
 <div id="ConfluenceContent"><p><style type="text/css">/*<![CDATA[*/
-div.rbtoc1604242594885 {padding: 0px;}
-div.rbtoc1604242594885 ul {list-style: disc;margin-left: 0px;}
-div.rbtoc1604242594885 li {margin-left: 0px;padding-left: 0px;}
+div.rbtoc1604267798997 {padding: 0px;}
+div.rbtoc1604267798997 ul {list-style: disc;margin-left: 0px;}
+div.rbtoc1604267798997 li {margin-left: 0px;padding-left: 0px;}
 
-/*]]>*/</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>
+/*]]>*/</style></p><div class="toc-macro rbtoc1604267798997">
+<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>
 <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><h2 id="DropwizardMetrics-Introduction">Introduction</h2><p>The <a shape="rect" class="external-link" href="https://metrics.dropwizard.io/" rel="nofollow">Dropwizard Metrics</a> library is a widely used metrics instrumentation choice for JVM application. The <strong>3.x</strong> release line of&#160;<a shape="rect" class="external-link" href="https://metrics.dropwizard.io/" rel="nofollow">Dropwizard Metrics</a> has been supported by Apache CXF starting from <strong>3.1.0</strong><strong> </strong>and above, and the <strong>4.x</strong> has become the default one since&#160;Apache CXF <strong>3.4.0</strong>.</p><h2 id="DropwizardMetrics-MetricsProvider">Metrics Provider</h2><p>The <a shape="rect" class="external-link" href="https://metrics.dropwizard.io/" rel="nofollow">Dropwizard Metrics</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/codahale/CodahaleM
 etricsProvider.java" rel="nofollow">CodahaleMetricsProvider</a>.</p><h2 id="DropwizardMetrics-IntegrationwithJAX-WS">Integration with JAX-WS</h2><h3 id="DropwizardMetrics-Server">Server</h3><p>The typical way to plug <a shape="rect" class="external-link" href="https://metrics.dropwizard.io/" rel="nofollow">Dropwizard Metrics</a> integration on the server-side is by using <a shape="rect" class="external-link" rel="nofollow" href="https://docs.oracle.com/javase/7/docs/api/javax/xml/ws/WebServiceFeature.html">WebServiceFeature</a> mechanism, for which there is a dedicated <a shape="rect" class="external-link" rel="nofollow" href="https://github.com/apache/cxf/blob/master/rt/features/metrics/src/main/java/org/apache/cxf/metrics/MetricsFeature.java">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 Bus bus = ...; /* MetricRegistry instance is taken from Bus instance */
+final MetricsProvider metricsProvider = new CodahaleMetricsProvider(bus);
+ 
+final JAXWSServerFactoryBean factory = new JAXWSServerFactoryBean();
+factory.setWsFeatures(Arrays.asList(new MetricsFeature(metricsProvider)));
+...</pre>
+</div></div><p>Alternatively, the <a shape="rect" class="external-link" rel="nofollow" href="https://github.com/apache/cxf/blob/master/rt/features/metrics/src/main/java/org/apache/cxf/metrics/MetricsFeature.java">MetricsFeature</a> could be supplied directly to JAX-WS endpoint, for example:</p><div class="table-wrap"><table class="wrapped confluenceTable"><colgroup span="1"><col span="1"></colgroup><tbody><tr><td colspan="1" rowspan="1" class="confluenceTd"><p><code class="java plain">EndpointImpl endpoint = </code><code class="java keyword">new</code> <code class="java plain">EndpointImpl(bus, </code><code class="java keyword">new</code> <code class="java plain">HelloPortImpl(), </code><code class="java keyword">null</code><code class="java plain">, </code><code class="java keyword">null</code><code class="java plain">, </code><code class="java keyword">new</code> <code class="java plain">WebServiceFeature[]{</code><br clear="none"><code class="java spaces">&#160;&#160;&#160;&#160;
 </code><code class="java keyword">new</code> <code class="java plain">MetricsFeature(metricsProvider)</code><br clear="none"><code class="java plain">});</code></p></td></tr></tbody></table></div><h3 id="DropwizardMetrics-Client">Client</h3><p>The client integration is no different from the server and uses the same <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> feature.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: false; theme: Default">final Bus bus = ...; /* MetricRegistry instance is taken from Bus instance */
+final MetricsProvider metricsProvider = new CodahaleMetricsProvider(bus);
+
+final JaxWsClientFactoryBean factory = new JaxWsClientFactoryBean();
+factory.setFeatures(Arrays.asList(new MetricsFeature(new CodahaleMetricsProvider(bus))));
+...</pre>
+</div></div><h2 id="DropwizardMetrics-IntegrationwithJAX-RS">Integration with JAX-RS</h2><h3 id="DropwizardMetrics-Server.1">Server</h3><p>The typical way to plug <a shape="rect" class="external-link" href="https://metrics.dropwizard.io/" rel="nofollow">Dropwizard Metrics</a> integration&#160; on the server-side is by using&#160;<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" rel="nofollow" href="https://github.com/apache/cxf/blob/master/rt/features/metrics/src/main/java/org/apache/cxf/metrics/MetricsFeature.java">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 Bus bus = ...; /* MetricRegistry instance is taken from Bus instance */
+final MetricsProvider metricsProvider = new CodahaleMetricsProvider(bus);
+
+final JAXRSServerFactoryBean factory = new JAXRSServerFactoryBean();
+factory.setFeatures(Arrays.asList(new MetricsFeature(metricsProvider)));
+...</pre>
+</div></div><h3 id="DropwizardMetrics-Client.1">Client</h3><p>The client integration is no different from the server and uses the same <a shape="rect" class="external-link" rel="nofollow" href="https://github.com/apache/cxf/blob/master/rt/features/metrics/src/main/java/org/apache/cxf/metrics/MetricsFeature.java">MetricsFeature</a> feature.</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<pre class="brush: java; gutter: false; theme: Default">final Bus bus = ...; /* MetricRegistry instance is taken from Bus instance */
+final MetricsProvider metricsProvider = new CodahaleMetricsProvider(bus);
+
+final JAXRSClientFactoryBean factory = new JAXRSClientFactoryBean();
+factory.setFeatures(Arrays.asList(new MetricsFeature(new CodahaleMetricsProvider(bus))));
+...</pre>
+</div></div></div>
            </div>
            <!-- Content -->
          </td>