blob: 04a772236f75ff19372246c6ebcdb72441605585 [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>Métricas con MicroProfile <code>@Counted</code> (Contado)</h1>
</div>
</div>
</div>
<div class="row">
<div class="col-md-12">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>Este es un ejemplo sobre cómo utilizar las métricas de MicroProfile en TomEE. El
proyecto incluye un perfil de Docker que se puede usar para crear una imagen de
Docker.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_ejecute_la_aplicación">Ejecute la aplicación:</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="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
Alternativamente, compile y ejecute la aplicación a través de Docker
(tenga en cuenta el uso del perfil de docker):
</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ mvn -Pdocker docker:build</code></pre>
</div>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ docker run -it --rm -p 8080:8080 --name=tomee-mp-metrics-counted tomee/mp-metrics-counted</code></pre>
</div>
</div>
<div class="paragraph">
<p>Dentro de la aplicación, hay un endpoint que te dará el estado del clima para
el día y la semana.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_obtenga_el_clima_para_la_semana">Obtenga el clima para la semana:</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-counted/weather/week/status</code></pre>
</div>
</div>
<div class="admonitionblock important">
<table>
<tr>
<td class="icon">
<i class="fa icon-important" title="Important"></i>
</td>
<td class="content">
Si ejecuta usando Docker, debido a que la aplicación está instalada
como la aplicación ROOT, elimine el nombre de la aplicación de la URL:
</td>
</tr>
</table>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl -X GET http://localhost:8080/weather/week/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="_usando_code_counted_code">Usando <code>@Counted</code></h2>
<div class="sectionbody">
<div class="paragraph">
<p>Las métricas de MicroProfile tienen una función que se puede usar para contar
solicitudes a un servicio.</p>
</div>
<div class="paragraph">
<p>Para utilizar esta función, debe anotar los métodos de los recursos JAX-RS con
<code>@Counted</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/status")
@Counted(monotonic = true, name = "weather_day_status", absolute = true)
@GET
@Produces(MediaType.TEXT_PLAIN)
public String dayStatus() {
return "Hi, today is a sunny day!";
}
...
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>Hay algunas configuraciones, como parte de <code>@Counted</code>, que necesita saber:</p>
</div>
<div class="paragraph">
<p><strong>String name</strong> Opcional. Establece el nombre de la métrica. Si no se proporciona
explícitamente, se utiliza el nombre del objeto anotado.</p>
</div>
<div class="paragraph">
<p><strong>boolean absolute</strong> Si es verdadero, usa el nombre dado como el nombre absoluto
de la métrica. Si es falso, antepone el nombre del paquete y el nombre de la
clase antes del nombre dado. El valor predeterminado es falso.</p>
</div>
<div class="paragraph">
<p><strong>String displayName</strong> Opcional. Un nombre para mostrar legible para los
metadatos.</p>
</div>
<div class="paragraph">
<p><strong>String description</strong> Opcional. Una descripción de la métrica.</p>
</div>
<div class="paragraph">
<p><strong>String[] tags</strong> Opcional. Matriz de cadenas en el formato = para suministrar
etiquetas especiales a una métrica.</p>
</div>
<div class="paragraph">
<p><strong>boolean reusable</strong> Indica si una métrica con un nombre determinado se puede
registrar en más de un lugar. No se aplica a <code>@Gauges</code> (medidores).</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_datos_de_la_métrica">Datos de la Métrica</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Verifique la métrica del contador haciendo una solicitud <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-counted/metrics/application/weather_day_status</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_respuesta_prometheus">Respuesta Prometheus:</h3>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-text" data-lang="text"># TYPE application:weather_day_status counter
application:weather_day_status 1.0</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_formato_json">Formato JSON:</h3>
<div class="paragraph">
<p>Para el formato json, agregue el encabezado <code>Accept: application/json</code> a la
solicitud HTTP.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl -X GET -H "Accept: application/json" http://localhost:8080/mp-metrics-counted/metrics/application/weather_day_status</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_respuesta_json">Respuesta JSON:</h3>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-javascript" data-lang="javascript">{
"weather_day_status": {
"delegate": {},
"unit": "none",
"count": 1
}
}</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>Una métrica tendrá metadatos para que pueda conocer más información al
respecto, como <code>displayName</code>,<code>description</code>, <code>tags</code>, etc.</p>
</div>
<div class="paragraph">
<p>Verifique los metadatos de la métrica haciendo una solicitud HTTP <em>OPTIONS</em>:</p>
</div>
<div class="sect2">
<h3 id="_solicitud_http_em_options_em">Solicitud 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-counted/metrics/application/weather_day_status</code></pre>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_respuesta">Respuesta:</h3>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-javascript" data-lang="javascript">{
"weather_day_status": {
"unit": "none",
"displayName": "Weather Day Status",
"name": "weather_day_status",
"typeRaw": "COUNTER",
"description": "This metric shows the weather status of the day.",
"type": "counter",
"value": {
"unit": "none",
"displayName": "Weather Day Status",
"name": "weather_day_status",
"tagsAsString": "",
"typeRaw": "COUNTER",
"description": "This metric shows the weather status of the day.",
"type": "counter",
"reusable": false,
"tags": {}
},
"reusable": false,
"tags": ""
}
}</code></pre>
</div>
</div>
<div class="paragraph">
<p>También puede probarlo utilizando WeatherServiceTest.java disponible en el
proyecto.</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 &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>