blob: 5df055d2c5fc2e2e6cebdb7194c115221f47e0a0 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Apache TomEE</title>
<meta name="description"
content="Apache TomEE is a lightweight, yet powerful, JavaEE Application server with feature rich tooling." />
<meta name="keywords" content="tomee,asf,apache,javaee,jee,shade,embedded,test,junit,applicationcomposer,maven,arquillian" />
<meta name="author" content="Luka Cvetinovic for Codrops" />
<link rel="icon" href="../../favicon.ico">
<link rel="icon" type="image/png" href="../../favicon.png">
<meta name="msapplication-TileColor" content="#80287a">
<meta name="theme-color" content="#80287a">
<link rel="stylesheet" type="text/css" href="../../css/normalize.css">
<link rel="stylesheet" type="text/css" href="../../css/bootstrap.css">
<link rel="stylesheet" type="text/css" href="../../css/owl.css">
<link rel="stylesheet" type="text/css" href="../../css/animate.css">
<link rel="stylesheet" type="text/css" href="../../fonts/font-awesome-4.1.0/css/font-awesome.min.css">
<link rel="stylesheet" type="text/css" href="../../fonts/eleganticons/et-icons.css">
<link rel="stylesheet" type="text/css" href="../../css/jqtree.css">
<link rel="stylesheet" type="text/css" href="../../css/idea.css">
<link rel="stylesheet" type="text/css" href="../../css/cardio.css">
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-2717626-1']);
_gaq.push(['_setDomainName', 'apache.org']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<div class="preloader">
<img src="../../img/loader.gif" alt="Preloader image">
</div>
<nav class="navbar">
<div class="container">
<div class="row"> <div class="col-md-12">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">
<span>
<img src="../../img/logo-active.png">
</span>
Apache TomEE
</a>
</div>
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav navbar-right main-nav">
<li><a href="../../docs.html">Documentation</a></li>
<li><a href="../../community/index.html">Community</a></li>
<li><a href="../../security/security.html">Security</a></li>
<li><a href="../../download-ng.html">Downloads</a></li>
</ul>
</div>
<!-- /.navbar-collapse -->
</div></div>
</div>
<!-- /.container-fluid -->
</nav>
<div id="main-block" class="container main-block">
<div class="row title">
<div class="col-md-12">
<div class='page-header'>
<h1>MicroProfile Metrics <code>@Histogram</code></h1>
</div>
</div>
</div>
<div class="row">
<div class="col-md-12">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>This is an example on how to use microprofile metrics in TomEE.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_run_the_application">Run the application:</h2>
<div class="sectionbody">
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ mvn clean install tomee:run</code></pre>
</div>
</div>
<div class="paragraph">
<p>Within the application, there is an enpoint that will give you a weather
histogram of the most recent New York City temperatures.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_request">Request:</h2>
<div class="sectionbody">
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl -X GET http://localhost:8080/mp-metrics-histogram/weather/histogram</code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_response">Response:</h2>
<div class="sectionbody">
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-javascript" data-lang="javascript">{
"count":15,
"max":55,
"mean":44.4,
"min":27,
"p50":45.0,
"p75":46.0,
"p95":54.0,
"p98":54.0,
"p99":54.0,
"p999":54.0,
"stddev":7.0710678118654755,
"unit":"degrees F"
}</code></pre>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_histogram_feature">Histogram Feature</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Microprofile metrics has a feature create a histogram of data.</p>
</div>
<div class="paragraph">
<p>To use this feature, inject a <code>MetricRegistry</code>, register the Histogram, and add
data to the histogram as shown below.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-java" data-lang="java">@Inject
private MetricRegistry registry;
@Inject
@Metric(name = "temperatures", description = "A histogram metrics example.",
displayName = "Histogram of Recent New York Temperatures")
private Histogram histogram;
@Path("/histogram")
@GET
@Produces(MediaType.APPLICATION_JSON)
public Histogram getTemperatures() {
Metadata metadata = new Metadata("temperatures", MetricType.HISTOGRAM, "degrees F");
metadata.setDescription("A histogram of recent New York temperatures.");
final int[] RECENT_NEW_YORK_TEMPS = { 46, 45, 50, 46, 45, 27, 30, 48, 55, 54, 45, 41, 45, 43, 46 };
histogram = registry.histogram(metadata);
for(int temp : RECENT_NEW_YORK_TEMPS) {
histogram.update(temp);
}
return histogram;
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>There are some Histogram configurations defined in the <code>@Metric</code> annotation:</p>
</div>
<div class="paragraph">
<p><strong>String name</strong> Optional. The name of the metric. If not explicitly given the
name of the annotated object is used.</p>
</div>
<div class="paragraph">
<p><strong>String displayName</strong> Optional. A human readable display name for metadata.</p>
</div>
<div class="paragraph">
<p><strong>String description</strong> Optional. A description of the metric.</p>
</div>
<div class="paragraph">
<p><strong>String[] tags</strong> Optional. An array of Strings in the = format to supply special
tags to a metric.</p>
</div>
<div class="paragraph">
<p><strong>boolean reusable</strong> Denotes if a metric with a certain name can be registered in
more than one place. Does not apply to gauges or histograms.</p>
</div>
<div class="sect2">
<h3 id="_for_the_histogram_status">For the histogram status:</h3>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl -X GET http://localhost:8080/mp-metrics-histogram/weather/histogram/status</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_reponse">Reponse:</h3>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash"> Here are the most recent New York City temperatures.</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_expected_prometheus_format">Expected Prometheus format:</h3>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-text" data-lang="text"> # TYPE application:temperatures_degrees F summary histogram
# TYPE application:temperatures_degrees F_count histogram
application:temperatures_degrees F_count 15.0
# TYPE application:temperatures_min_degrees F histogram
application:temperatures_min_degrees F 27.0
# TYPE application:temperatures_max_degrees F histogram
application:temperatures_max_degrees F 55.0
# TYPE application:temperatures_mean_degrees F histogram
application:temperatures_mean_degrees F 44.4
# TYPE application:temperatures_stddev_degrees F histogram
application:temperatures_stddev_degrees F 7.0710678118654755
# TYPE application:temperatures_degrees F histogram
application:temperatures_degrees F{quantile="0.5"} 45.0
# TYPE application:temperatures_degrees F histogram
application:temperatures_degrees F{quantile="0.75"} 46.0
# TYPE application:temperatures_degrees F histogram
application:temperatures_degrees F{quantile="0.95"} 54.0
# TYPE application:temperatures_degrees F histogram
application:temperatures_degrees F{quantile="0.98"} 54.0
# TYPE application:temperatures_degrees F histogram
application:temperatures_degrees F{quantile="0.99"} 54.0
# TYPE application:temperatures_degrees F histogram
application:temperatures_degrees F{quantile="0.999"} 54.0
# TYPE application:org_superbiz_histogram_weather_service_temperatures summary histogram
# TYPE application:org_superbiz_histogram_weather_service_temperatures_count histogram
application:org_superbiz_histogram_weather_service_temperatures_count 0.0
# TYPE application:org_superbiz_histogram_weather_service_temperatures_min histogram
application:org_superbiz_histogram_weather_service_temperatures_min 0.0
# TYPE application:org_superbiz_histogram_weather_service_temperatures_max histogram
application:org_superbiz_histogram_weather_service_temperatures_max 0.0
# TYPE application:org_superbiz_histogram_weather_service_temperatures_mean histogram
application:org_superbiz_histogram_weather_service_temperatures_mean NaN
# TYPE application:org_superbiz_histogram_weather_service_temperatures_stddev histogram
application:org_superbiz_histogram_weather_service_temperatures_stddev 0.0
# TYPE application:org_superbiz_histogram_weather_service_temperatures histogram
application:org_superbiz_histogram_weather_service_temperatures{quantile="0.5"} 0.0
# TYPE application:org_superbiz_histogram_weather_service_temperatures histogram
application:org_superbiz_histogram_weather_service_temperatures{quantile="0.75"} 0.0
# TYPE application:org_superbiz_histogram_weather_service_temperatures histogram
application:org_superbiz_histogram_weather_service_temperatures{quantile="0.95"} 0.0
# TYPE application:org_superbiz_histogram_weather_service_temperatures histogram
application:org_superbiz_histogram_weather_service_temperatures{quantile="0.98"} 0.0
# TYPE application:org_superbiz_histogram_weather_service_temperatures histogram
application:org_superbiz_histogram_weather_service_temperatures{quantile="0.99"} 0.0
# TYPE application:org_superbiz_histogram_weather_service_temperatures histogram
application:org_superbiz_histogram_weather_service_temperatures{quantile="0.999"} 0.0</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_request_2">Request:</h3>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl -X GET http://localhost:8080/mp-metrics-histogram/metrics/application</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_response_2">Response:</h3>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-javascript" data-lang="javascript">{
"org.superbiz.histogram.WeatherService.temperatures": {
"count":0,
"max":0,
"min":0,
"p50":0.0,
"p75":0.0,
"p95":0.0,
"p98":0.0,
"p99":0.0,
"p999":0.0,
"stddev":0.0,
"unit":"none"
}
}</code></pre>
</div>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_metric_metadata">Metric Metadata:</h2>
<div class="sectionbody">
<div class="paragraph">
<p>A metric will have a metadata to provide information about it such as
<code>displayName</code>, <code>description</code>, <code>tags</code>, etc.</p>
</div>
<div class="sect2">
<h3 id="_request_3">Request:</h3>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl -X OPTIONS http://localhost:8080/mp-metrics-histogram/metrics/application</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_response_3">Response:</h3>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-javascript" data-lang="javascript">{
"org.superbiz.histogram.WeatherService.temperatures": {
"description": "A histogram metrics example.",
"displayName":"Histogram of Recent New York Temperatures",
"name":"org.superbiz.histogram.WeatherService.temperatures",
"reusable":false,
"tags":"",
"type":"histogram",
"typeRaw":"HISTOGRAM",
"unit":"none"
}
}</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_test_the_application">Test the application:</h3>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ mvn test</code></pre>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="container">
<div class="row">
<div class="col-sm-6 text-center-mobile">
<h3 class="white">Be simple. Be certified. Be Tomcat.</h3>
<h5 class="light regular light-white">"A good application in a good server"</h5>
<ul class="social-footer">
<li><a href="https://www.facebook.com/ApacheTomEE/"><i class="fa fa-facebook"></i></a></li>
<li><a href="https://twitter.com/apachetomee"><i class="fa fa-twitter"></i></a></li>
<li><a href="https://plus.google.com/communities/105208241852045684449"><i class="fa fa-google-plus"></i></a></li>
</ul>
</div>
<div class="col-sm-6 text-center-mobile">
<div class="row opening-hours">
<div class="col-sm-3 text-center-mobile">
<h5><a href="../../latest/docs/documentation.html" class="white">Documentation</a></h5>
<ul class="list-unstyled">
<li><a href="../../latest/docs/admin/configuration/index.html" class="regular light-white">How to configure</a></li>
<li><a href="../../latest/docs/admin/file-layout.html" class="regular light-white">Dir. Structure</a></li>
<li><a href="../../latest/docs/developer/testing/index.html" class="regular light-white">Testing</a></li>
<li><a href="../../latest/docs/admin/cluster/index.html" class="regular light-white">Clustering</a></li>
</ul>
</div>
<div class="col-sm-3 text-center-mobile">
<h5><a href="../../latest/examples/" class="white">Examples</a></h5>
<ul class="list-unstyled">
<li><a href="../../latest/examples/simple-cdi-interceptor.html" class="regular light-white">CDI Interceptor</a></li>
<li><a href="../../latest/examples/rest-cdi.html" class="regular light-white">REST with CDI</a></li>
<li><a href="../../latest/examples/ejb-examples.html" class="regular light-white">EJB</a></li>
<li><a href="../../latest/examples/jsf-managedBean-and-ejb.html" class="regular light-white">JSF</a></li>
</ul>
</div>
<div class="col-sm-3 text-center-mobile">
<h5><a href="../../community/index.html" class="white">Community</a></h5>
<ul class="list-unstyled">
<li><a href="../../community/contributors.html" class="regular light-white">Contributors</a></li>
<li><a href="../../community/social.html" class="regular light-white">Social</a></li>
<li><a href="../../community/sources.html" class="regular light-white">Sources</a></li>
</ul>
</div>
<div class="col-sm-3 text-center-mobile">
<h5><a href="../../security/index.html" class="white">Security</a></h5>
<ul class="list-unstyled">
<li><a href="http://apache.org/security" target="_blank" class="regular light-white">Apache Security</a></li>
<li><a href="http://apache.org/security/projects.html" target="_blank" class="regular light-white">Security Projects</a></li>
<li><a href="http://cve.mitre.org" target="_blank" class="regular light-white">CVE</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="row bottom-footer text-center-mobile">
<div class="col-sm-12 light-white">
<p>Copyright &copy; 1999-2016 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache TomEE, TomEE, Apache, the Apache feather logo, and the Apache TomEE project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p>
</div>
</div>
</div>
</footer>
<!-- Holder for mobile navigation -->
<div class="mobile-nav">
<ul>
<li><a hef="../../latest/docs/admin/index.html">Administrators</a>
<li><a hef="../../latest/docs/developer/index.html">Developers</a>
<li><a hef="../../latest/docs/advanced/index.html">Advanced</a>
<li><a hef="../../community/index.html">Community</a>
</ul>
<a href="#" class="close-link"><i class="arrow_up"></i></a>
</div>
<!-- Scripts -->
<script src="../../js/jquery-1.11.1.min.js"></script>
<script src="../../js/owl.carousel.min.js"></script>
<script src="../../js/bootstrap.min.js"></script>
<script src="../../js/wow.min.js"></script>
<script src="../../js/typewriter.js"></script>
<script src="../../js/jquery.onepagenav.js"></script>
<script src="../../js/tree.jquery.js"></script>
<script src="../../js/highlight.pack.js"></script>
<script src="../../js/main.js"></script>
</body>
</html>