| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- |
| |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, software |
| distributed under the License is distributed on an "AS IS" BASIS, |
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| See the License for the specific language governing permissions and |
| limitations under the License. |
| --> |
| <html> |
| <head> |
| |
| <link type="text/css" rel="stylesheet" href="/resources/site.css"> |
| <script src='/resources/space.js'></script> |
| |
| <meta http-equiv="Content-type" content="text/html;charset=UTF-8"> |
| <meta name="keywords" content="business integration, EAI, SOA, Service Oriented Architecture, web services, SOAP, JBI, JMS, WSDL, XML, EDI, Electronic Data Interchange, standards support, integration standards, application integration, middleware, software, solutions, services, CXF, open source"> |
| <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/shBrushBash.js'></script> |
| <script src='/resources/highlighter/scripts/shBrushJava.js'></script> |
| <script> |
| SyntaxHighlighter.defaults['toolbar'] = false; |
| SyntaxHighlighter.all(); |
| </script> |
| |
| |
| <title> |
| Apache CXF -- Dropwizard Metrics |
| </title> |
| </head> |
| <body onload="init()"> |
| |
| |
| <table width="100%" cellpadding="0" cellspacing="0"> |
| <tr> |
| <td id="cell-0-0" colspan="2"> </td> |
| <td id="cell-0-1"> </td> |
| <td id="cell-0-2" colspan="2"> </td> |
| </tr> |
| <tr> |
| <td id="cell-1-0"> </td> |
| <td id="cell-1-1"> </td> |
| <td id="cell-1-2"> |
| <!-- Banner --> |
| <div class="banner" id="banner"><div><table border="0" cellpadding="0" cellspacing="0" width="100%"><tr><td align="left" colspan="1" nowrap> |
| <a shape="rect" href="http://cxf.apache.org/" title="Apache CXF"><span style="font-weight: bold; font-size: 170%; color: white">Apache CXF</span></a> |
| </td><td align="right" colspan="1" nowrap> |
| <a shape="rect" href="http://www.apache.org/" title="The Apache Sofware Foundation"><img border="0" alt="ASF Logo" src="http://cxf.apache.org/images/asf-logo.png"></a> |
| </td></tr></table></div></div> |
| <!-- Banner --> |
| <div id="top-menu"> |
| <table border="0" cellpadding="1" cellspacing="0" width="100%"> |
| <tr> |
| <td> |
| <div align="left"> |
| <!-- Breadcrumbs --> |
| <a href="index.html">Index</a> > <a href="metrics.html">Metrics</a> > <a href="dropwizard-metrics.html">Dropwizard Metrics</a> |
| <!-- Breadcrumbs --> |
| </div> |
| </td> |
| <td> |
| <div align="right"> |
| <!-- Quicklinks --> |
| <div id="quicklinks"><p><a shape="rect" href="http://cxf.apache.org/download.html">Download</a> | <a shape="rect" href="http://cxf.apache.org/docs/index.html">Documentation</a></p></div> |
| <!-- Quicklinks --> |
| </div> |
| </td> |
| </tr> |
| </table> |
| </div> |
| </td> |
| <td id="cell-1-3"> </td> |
| <td id="cell-1-4"> </td> |
| </tr> |
| <tr> |
| <td id="cell-2-0" colspan="2"> </td> |
| <td id="cell-2-1"> |
| <table> |
| <tr valign="top"> |
| <td height="100%"> |
| <div id="wrapper-menu-page-right"> |
| <div id="wrapper-menu-page-top"> |
| <div id="wrapper-menu-page-bottom"> |
| <div id="menu-page"> |
| <!-- NavigationBar --> |
| <div id="navigation"><ul class="alternate"><li><a shape="rect" href="overview.html">Overview</a></li><li><a shape="rect" href="how-tos.html">How-Tos</a></li><li><a shape="rect" href="frontends.html">Frontends</a></li><li><a shape="rect" href="databindings.html">DataBindings</a></li><li><a shape="rect" href="transports.html">Transports</a></li><li><a shape="rect" href="configuration.html">Configuration</a></li><li><a shape="rect" href="debugging-and-logging.html">Debugging and Logging</a></li><li><a shape="rect" href="tools.html">Tools</a></li><li><a shape="rect" href="restful-services.html">RESTful Services</a></li><li><a shape="rect" href="wsdl-bindings.html">WSDL Bindings</a></li><li><a shape="rect" href="service-routing.html">Service Routing</a></li><li><a shape="rect" href="dynamic-languages.html">Dynamic Languages</a></li><li><a shape="rect" href="ws-support.html">WS-* Support</a></li><li><a shape="rect" href="advanced-integration.html">Advanced Integration</a></li><li><a shape="rect" href="deployment.html">Deployment</a></li><li><a shape="rect" href="schemas-and-namespaces.html">Use of Schemas and Namespaces</a></li></ul><hr><ul class="alternate"><li><p>Search</p></li></ul><form enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box" action="http://www.google.com/cse"> |
| <div> |
| <input type="hidden" name="cx" value="002890367768291051730:o99qiwa09y4"> |
| <input type="hidden" name="ie" value="UTF-8"> |
| <input type="text" name="q" size="21"> |
| <input type="submit" name="sa" value="Search"> |
| </div> |
| </form> |
| <script type="text/javascript" src="http://www.google.com/cse/brand?form=cse-search-box&lang=en"></script><hr><ul class="alternate"><li><a shape="rect" href="http://cxf.apache.org/javadoc/latest/">API 3.2.x (Javadoc)</a></li><li><a shape="rect" href="http://cxf.apache.org/javadoc/latest-3.1.x/">API 3.1.x (Javadoc)</a></li><li><a shape="rect" href="http://cxf.apache.org/">CXF Website</a></li></ul><p> </p><p><a shape="rect" class="external-link" href="http://www.apache.org/events/current-event.html"><span class="confluence-embedded-file-wrapper"><img class="confluence-embedded-image confluence-external-resource" src="http://www.apache.org/events/current-event-125x125.png" data-image-src="http://www.apache.org/events/current-event-125x125.png"></span></a></p></div> |
| <!-- NavigationBar --> |
| </div> |
| </div> |
| </div> |
| </div> |
| </td> |
| <td height="100%"> |
| <!-- Content --> |
| <div class="wiki-content"> |
| <div id="ConfluenceContent"><p><style type="text/css">/*<![CDATA[*/ |
| div.rbtoc1636141745496 {padding: 0px;} |
| div.rbtoc1636141745496 ul {list-style: disc;margin-left: 0px;} |
| div.rbtoc1636141745496 li {margin-left: 0px;padding-left: 0px;} |
| |
| /*]]>*/</style></p><div class="toc-macro rbtoc1636141745496"> |
| <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><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 <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 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/CodahaleMetricsProvider.java" rel="nofollow">CodahaleMetricsProvider</a>.</p><h2 id="DropwizardMetrics-Configuration">Configuration</h2><p>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/codahale/CodahaleMetricsProvider.java" rel="nofollow">CodahaleMetricsProvider</a> accept additional properties which could be configured on a <strong>Bus</strong> level or factory bean level (using its <strong>setProperties</strong> mutator).</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>org.apache.cxf.management.service.counter.name</strong></td><td colspan="1" rowspan="1" class="confluenceTd"><p>The name prefix to prepend to each metric being reported</p></td><td colspan="1" rowspan="1" class="confluenceTd"><strong>null</strong></td></tr></tbody></table></div><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" 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><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  on the server-side is by using <a shape="rect" class="external-link" rel="nofollow" href="https://github.com/apache/cxf/blob/master/core/src/main/java/org/apache/cxf/feature/AbstractFeature.java">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> |
| </tr> |
| </table> |
| </td> |
| <td id="cell-2-2" colspan="2"> </td> |
| </tr> |
| <tr> |
| <td id="cell-3-0"> </td> |
| <td id="cell-3-1"> </td> |
| <td id="cell-3-2"> |
| <div id="footer"> |
| <!-- Footer --> |
| <div id="site-footer"> |
| <a href="http://cxf.apache.org/privacy-policy.html">Privacy Policy</a> - |
| (<a href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=165221853">edit page</a>) |
| (<a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=165221853&showComments=true&showCommentArea=true#addcomment">add comment</a>)<br> |
| Apache CXF, CXF, Apache, the Apache feather logo are trademarks of The Apache Software Foundation.<br> |
| All other marks mentioned may be trademarks or registered trademarks of their respective owners. |
| </div> |
| <!-- Footer --> |
| </div> |
| </td> |
| <td id="cell-3-3"> </td> |
| <td id="cell-3-4"> </td> |
| </tr> |
| <tr> |
| <td id="cell-4-0" colspan="2"> </td> |
| <td id="cell-4-1"> </td> |
| <td id="cell-4-2" colspan="2"> </td> |
| </tr> |
| </table> |
| |
| <script type="text/javascript"> |
| var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); |
| document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); |
| </script> |
| <script type="text/javascript"> |
| try { |
| var pageTracker = _gat._getTracker("UA-4458903-1"); |
| pageTracker._trackPageview(); |
| } catch(err) {}</script> |
| |
| </body> |
| </html> |
| |
