| <!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>Métricas com MicroProfile <code>@Gauge</code> (Medida)</h1> |
| </div> |
| </div> |
| </div> |
| <div class="row"> |
| |
| <div class="col-md-12"> |
| <div id="preamble"> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Este é um exemplo sobre como utilizar as métricas de MicroProfile em TomEE.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_executando_a_aplicação">Executando a aplicação:</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>Dentro da aplicação, tem um endpoint que vai fornecer a temperatura em celsius para o dia.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_obter_a_temperatura_para_o_dia">Obter a temperatura para o dia:</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-gauge/weather/day/temperature</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_resposta">Resposta:</h2> |
| <div class="sectionbody"> |
| <div class="literalblock"> |
| <div class="content"> |
| <pre>30</pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_usando_code_gauge_code">Usando <code>@Gauge</code></h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>As métricas do MicroProfile têm uma função para medir. |
| O valor e o tipo da medida são iguais ao valor e ao tipo do método anotado.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Para usar esta função, você deve anotar os métodos dos recursos JAX-RS com <code>@Gauge</code>.</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-java" data-lang="java">@Path("/weather") |
| @Produces(MediaType.APPLICATION_JSON) |
| @Consumes(MediaType.APPLICATION_JSON) |
| @ApplicationScoped |
| public class WeatherService { |
| |
| @Path("/day/temperature") |
| @Gauge(name = "weather_day_temperature", absolute = true, unit = "celsius", |
| displayName = "Weather Day Temperature", |
| description = "This metric shows the day temperature.", |
| tags = {"weather=temperature"}) |
| @GET |
| @Produces(MediaType.TEXT_PLAIN) |
| public Integer dayTemperature() { |
| return 30; |
| } |
| }</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Existem algumas configurações, como parte do <code>@Gauge</code>, que você precisa saber:</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>String name</strong> |
| Opcional. Define o nome da métrica. Se não for fornecido |
| explicitamente, o nome do objeto anotado é usado.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>boolean absolute</strong> |
| Se verdadeiro, use o nome fornecido como o nome absoluto da métrica. Se falso, coloque o nome do pacote e o nome da classe antes do nome fornecido. O valor padrão é falso.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>String displayName</strong> |
| Opcional. Um nome de exibição legível para metadados.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>String description</strong> |
| Opcional. Uma descrição da métrica.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>String[] tags</strong> |
| Opcional. Matriz de cadeia no formato = para fornecer etiquetas especiais a uma métrica.</p> |
| </div> |
| <div class="paragraph"> |
| <p><strong>String unit</strong> |
| Unidade da métrica. Veja a classe MetricUnits para obter uma lista de unidades padrão.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_dados_métricos">Dados Métricos</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Verifique a medida fazendo uma requisição <em>GET</em>:</p> |
| </div> |
| <div class="sect2"> |
| <h3 id="_formato_prometheus">Formato Prometheus:</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-gauge/metrics/application/weather_day_temperature</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_resposta_prometheus">Resposta Prometheus:</h3> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code> # TYPE application:weather_day_temperature_celsius gauge |
| application:weather_day_temperature_celsius{weather="temperature"} 30.0</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_formato_json">Formato JSON:</h3> |
| <div class="paragraph"> |
| <p>Para o formato json, adicione o cabeçalho Accept=application/json à requisição.</p> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_resposta_json">Resposta JSON</h3> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-javascript" data-lang="javascript"> { |
| "weather_day_temperature": 30 |
| }</code></pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_metadatos_métrica">Metadatos Métrica</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Uma métrica terá metadados para que você possa aprender mais sobre ela, como <code>displayName</code>,<code>descrição</code>, <code>tags</code> etc.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Verifique os metadados da métrica fazendo uma solicitação HTTP <em>OPTIONS</em>:</p> |
| </div> |
| <div class="sect2"> |
| <h3 id="_solicitação_http_em_options_em">Solicitação HTTP <em>OPTIONS</em></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-gauge/metrics/application/weather_day_temperature</code></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_resposta_2">Resposta:</h3> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre class="highlight"><code class="language-javascript" data-lang="javascript"> { |
| "weather_day_temperature": { |
| "unit": "celsius", |
| "displayName": "Weather Day Temperature", |
| "name": "weather_day_temperature", |
| "typeRaw": "GAUGE", |
| "description": "This metric shows the day temperature.", |
| "type": "gauge", |
| "value": { |
| "unit": "celsius", |
| "displayName": "Weather Day Temperature", |
| "name": "weather_day_temperature", |
| "tagsAsString": "weather=\"temperature\"", |
| "typeRaw": "GAUGE", |
| "description": "This metric shows the day temperature.", |
| "type": "gauge", |
| "reusable": false, |
| "tags": { |
| "weather": "temperature" |
| } |
| }, |
| "reusable": false, |
| "tags": "weather=temperature" |
| } |
| }</code></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Você também pode testá-lo usando WeatherServiceTest.java disponível no projeto.</p> |
| </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/" 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 © 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> |
| |
