| <!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"> |
| <!-- Matomo --> |
| var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| /* We explicitly disable cookie tracking to avoid privacy issues */ |
| _paq.push(['disableCookies']); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function () { |
| var u = "//matomo.privacy.apache.org/"; |
| _paq.push(['setTrackerUrl', u + 'matomo.php']); |
| _paq.push(['setSiteId', '5']); |
| var d = document, g = d.createElement('script'), s = d.getElementsByTagName('script')[0]; |
| g.async = true; |
| g.src = u + 'matomo.js'; |
| s.parentNode.insertBefore(g, s); |
| })(); |
| <!-- End Matomo Code --> |
| </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="/" title="Apache TomEE"> |
| <span> |
| |
| |
| <img |
| src="../../img/apache_tomee-logo.svg" |
| onerror="this.src='../../img/apache_tomee-logo.jpg'" |
| height="50" |
| > |
| |
| |
| </span> |
| </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 class="btn btn-accent accent-orange no-shadow" href="../../download.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 Timed</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 endpoint that will give you the |
| weather status for the day.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_for_the_day_status_call">For the day status call:</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-timed/weather/day/status</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-text" data-lang="text">Hi, today is a sunny day!</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_timed_feature">Timed Feature</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>MicroProfile Metrics has a feature that tracks the time of an event.</p> |
| </div> |
| <div class="paragraph"> |
| <p>To use this feature you need to annotate the JAX-RS resource method with |
| <code>@Timed</code>.</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-java" data-lang="java">@Path("/weather") |
| @ApplicationScoped |
| public class WeatherService { |
| |
| @Path("/day/status") |
| @Timed(name = "weather_day_status", absolute = true, |
| displayName = "Weather Day Status", |
| description = "This metric shows the weather status of the day.") |
| @GET |
| @Produces(MediaType.TEXT_PLAIN) |
| public String dayStatus() { |
| return "Hi, today is a sunny day!"; |
| } |
| ... |
| }</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>There are some configurations, as part of <code>@Timed</code>, that you need to know:</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>String name</strong> Optional. Sets the name of the metric. If not explicitly |
| given the name of the annotated object is used.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>boolean absolute</strong> If true, uses the given name as the absolute name of |
| the metric. If false, prepends the package name and class name before |
| the given name. Default value is false.</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. Array of Strings in the = format to supply |
| special tags to a metric.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>String unit</strong> Unit of the metric. Default for <code>@Timed</code> is nanoseconds.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_metric_data">Metric data</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Check the timed metric doing a <em>GET</em> request:</p> |
| </div> |
| <div class="sect2"> |
| <h3 id="_prometheus_format">Prometheus format:</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-timed/metrics/application/weather_day_status</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-text" data-lang="text"># TYPE application:weather_day_status_seconds summary timer |
| # TYPE application:weather_day_status_seconds_count timer |
| application:weather_day_status_seconds_count 1.0 |
| # TYPE application:weather_day_status_rate_per_second timer |
| application:weather_day_status_rate_per_second 0.0 |
| # TYPE application:weather_day_status_one_min_rate_per_second timer |
| application:weather_day_status_one_min_rate_per_second 0.0 |
| # TYPE application:weather_day_status_five_min_rate_per_second timer |
| application:weather_day_status_five_min_rate_per_second 0.0 |
| # TYPE application:weather_day_status_fifteen_min_rate_per_second timer |
| application:weather_day_status_fifteen_min_rate_per_second 0.0 |
| # TYPE application:weather_day_status_min_seconds timer |
| application:weather_day_status_min_seconds 48352.0 |
| # TYPE application:weather_day_status_max_seconds timer |
| application:weather_day_status_max_seconds 48352.0 |
| # TYPE application:weather_day_status_mean_seconds timer |
| application:weather_day_status_mean_seconds 48352.0 |
| # TYPE application:weather_day_status_stddev_seconds timer |
| application:weather_day_status_stddev_seconds 0.0 |
| # TYPE application:weather_day_status_seconds timer |
| application:weather_day_status_seconds{quantile="0.5"} 48352.0 |
| # TYPE application:weather_day_status_seconds timer |
| application:weather_day_status_seconds{quantile="0.75"} 48352.0 |
| # TYPE application:weather_day_status_seconds timer |
| application:weather_day_status_seconds{quantile="0.95"} 48352.0 |
| # TYPE application:weather_day_status_seconds timer |
| application:weather_day_status_seconds{quantile="0.98"} 48352.0 |
| # TYPE application:weather_day_status_seconds timer |
| application:weather_day_status_seconds{quantile="0.99"} 48352.0 |
| # TYPE application:weather_day_status_seconds timer |
| application:weather_day_status_seconds{quantile="0.999"} 48352.0</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_json_format">JSON Format:</h3> |
| <div class="paragraph"> |
| <p>For json format add the header <code>Accept: application/json</code> to the request.</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-javascript" data-lang="javascript">{ |
| "weather_day_status": { |
| "count": 1, |
| "fifteenMinRate": 0, |
| "fiveMinRate": 0, |
| "max": 48352, |
| "mean": 48352, |
| "meanRate": 0, |
| "min": 48352, |
| "oneMinRate": 0, |
| "p50": 48352, |
| "p75": 48352, |
| "p95": 48352, |
| "p98": 48352, |
| "p99": 48352, |
| "p999": 48352, |
| "stddev": 0 |
| } |
| }</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 metadata so you can know more about it, like |
| <code>displayName</code>, <code>description</code>, <code>tags</code>, etc.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Check the metric metadata doing a <em>OPTIONS</em> request:</p> |
| </div> |
| <div class="sect2"> |
| <h3 id="_request">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-timed/metrics/application/weather_day_status</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">{ |
| "weather_day_status": { |
| "description": "This metric shows the weather status of the day.", |
| "displayName": "Weather Day Status", |
| "name": "weather_day_status", |
| "reusable": false, |
| "tags": "", |
| "type": "timer", |
| "typeRaw": "TIMER", |
| "unit": "nanoseconds" |
| } |
| }</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>You can also try it out using the <code>WeatherServiceTest.java</code> available in |
| the project.</p> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_apis_used">APIs Used</h2> |
| <div class="sectionbody"> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><a href="../../jakartaee-10.0/javadoc/jakarta/enterprise/context/ApplicationScoped.html">jakarta.enterprise.context.ApplicationScoped</a></p> |
| </li> |
| <li> |
| <p><a href="../../jakartaee-10.0/javadoc/jakarta/json/Json.html">jakarta.json.Json</a></p> |
| </li> |
| <li> |
| <p><a href="../../jakartaee-10.0/javadoc/jakarta/json/JsonObject.html">jakarta.json.JsonObject</a></p> |
| </li> |
| <li> |
| <p><a href="../../jakartaee-10.0/javadoc/jakarta/ws/rs/Consumes.html">jakarta.ws.rs.Consumes</a></p> |
| </li> |
| <li> |
| <p><a href="../../jakartaee-10.0/javadoc/jakarta/ws/rs/GET.html">jakarta.ws.rs.GET</a></p> |
| </li> |
| <li> |
| <p><a href="../../jakartaee-10.0/javadoc/jakarta/ws/rs/Path.html">jakarta.ws.rs.Path</a></p> |
| </li> |
| <li> |
| <p><a href="../../jakartaee-10.0/javadoc/jakarta/ws/rs/Produces.html">jakarta.ws.rs.Produces</a></p> |
| </li> |
| <li> |
| <p><a href="../../jakartaee-10.0/javadoc/jakarta/ws/rs/client/Client.html">jakarta.ws.rs.client.Client</a></p> |
| </li> |
| <li> |
| <p><a href="../../jakartaee-10.0/javadoc/jakarta/ws/rs/client/ClientBuilder.html">jakarta.ws.rs.client.ClientBuilder</a></p> |
| </li> |
| <li> |
| <p><a href="../../jakartaee-10.0/javadoc/jakarta/ws/rs/client/WebTarget.html">jakarta.ws.rs.client.WebTarget</a></p> |
| </li> |
| <li> |
| <p><a href="../../jakartaee-10.0/javadoc/jakarta/ws/rs/core/MediaType.html">jakarta.ws.rs.core.MediaType</a></p> |
| </li> |
| <li> |
| <p><a href="../../jakartaee-10.0/javadoc/jakarta/ws/rs/core/Response.html">jakarta.ws.rs.core.Response</a></p> |
| </li> |
| <li> |
| <p><a href="../../microprofile-6.0/javadoc/org/eclipse/microprofile/metrics/annotation/Timed.html">org.eclipse.microprofile.metrics.annotation.Timed</a></p> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| </div> |
| </div> |
| <div style="margin-bottom: 30px;"></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> |
| </ul> |
| <h5 class="light regular light-white"> |
| <a href="../../privacy-policy.html" class="white">Privacy Policy</a> |
| </h5> |
| </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/" 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="https://apache.org/security" target="_blank" class="regular light-white">Apache Security</a></li> |
| <li><a href="https://apache.org/security/projects.html" target="_blank" class="regular light-white">Security Projects</a></li> |
| <li><a href="https://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 © 1999-2022 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> |
| |
