This is an automated email from the ASF dual-hosted git repository.
dblevins pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tomee.git
The following commit(s) were added to refs/heads/master by this push:
new c14064a [TOMEE-2680] Translate MicroProfile Metrics Histogram Example
to Spanish
new 8462df7 Merge pull request #570 from cchacin/TOMEE-2680
c14064a is described below
commit c14064a17f3a772f3c497a456f97982f54ac5315
Author: Carlos Chacin <[email protected]>
AuthorDate: Wed Sep 11 20:08:06 2019 -0700
[TOMEE-2680] Translate MicroProfile Metrics Histogram Example to Spanish
---
examples/mp-metrics-histogram/README.adoc | 103 +++++++++-------
.../{README.adoc => README_es.adoc} | 135 +++++++++++----------
2 files changed, 127 insertions(+), 111 deletions(-)
diff --git a/examples/mp-metrics-histogram/README.adoc
b/examples/mp-metrics-histogram/README.adoc
index 8cd9553..b76b541 100644
--- a/examples/mp-metrics-histogram/README.adoc
+++ b/examples/mp-metrics-histogram/README.adoc
@@ -1,4 +1,4 @@
-= MicroProfile Metrics Histogram
+= MicroProfile Metrics `@Histogram`
:index-group: MicroProfile
:jbake-type: page
:jbake-status: published
@@ -7,22 +7,25 @@ This is an example on how to use microprofile metrics in
TomEE.
== Run the application:
-....
-mvn clean install tomee:run
-....
+[source,bash]
+----
+$ mvn clean install tomee:run
+----
Within the application, there is an enpoint that will give you a weather
histogram of the most recent New York City temperatures.
== Request:
-....
-curl -X GET http://localhost:8080/mp-metrics-histogram/weather/histogram
-....
+[source,bash]
+----
+$ curl -X GET http://localhost:8080/mp-metrics-histogram/weather/histogram
+----
== Response:
-....
+[source,javascript]
+----
{
"count":15,
"max":55,
@@ -36,17 +39,18 @@ curl -X GET
http://localhost:8080/mp-metrics-histogram/weather/histogram
"p999":54.0,
"stddev":7.0710678118654755,
"unit":"degrees F"
-}
-....
+}
+----
== Histogram Feature
Microprofile metrics has a feature create a histogram of data.
-To use this feature, inject a MetricRegistry, register the Histogram,
-and add data to the histogram as shown below.
+To use this feature, inject a `MetricRegistry`, register the Histogram, and add
+data to the histogram as shown below.
-....
+[source,java]
+----
@Inject
private MetricRegistry registry;
@@ -68,41 +72,41 @@ public Histogram getTemperatures() {
}
return histogram;
}
-....
+----
-There are some Histogram configurations defined in the @Metric
-annotation:
+There are some Histogram configurations defined in the `@Metric` annotation:
-*String name* Optional. The name of the metric. If not explicitly given
-the name of the annotated object is used.
+*String name* Optional. The name of the metric. If not explicitly given the
+name of the annotated object is used.
-*String displayName* Optional. A human readable display name for
-metadata.
+*String displayName* Optional. A human readable display name for metadata.
*String description* Optional. A description of the metric.
-*String[] tags* Optional. An array of Strings in the = format to supply
-special tags to a metric.
+*String[] tags* Optional. An array of Strings in the = format to supply special
+tags to a metric.
-*boolean reusable* Denotes if a metric with a certain name can be
-registered in more than one place. Does not apply to gauges or
-histograms.
+*boolean reusable* Denotes if a metric with a certain name can be registered in
+more than one place. Does not apply to gauges or histograms.
=== For the histogram status:
-....
-GET http://localhost:8080/mp-metrics-histogram/weather/histogram/status
-....
+[source,bash]
+----
+$ curl -X GET
http://localhost:8080/mp-metrics-histogram/weather/histogram/status
+----
=== Reponse:
-....
+[source,bash]
+----
Here are the most recent New York City temperatures.
-....
+----
=== Expected Prometheus format:
-....
+[source,text]
+----
# TYPE application:temperatures_degrees F summary histogram
# TYPE application:temperatures_degrees F_count histogram
application:temperatures_degrees F_count 15.0
@@ -149,17 +153,19 @@ GET
http://localhost:8080/mp-metrics-histogram/weather/histogram/status
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
-....
+----
=== Request:
-....
-curl -X GET http://localhost:8080/mp-metrics-histogram/metrics/application
-....
+[source,bash]
+----
+$ curl -X GET http://localhost:8080/mp-metrics-histogram/metrics/application
+----
=== Response:
-....
+[source,javascript]
+----
{
"org.superbiz.histogram.WeatherService.temperatures": {
"count":0,
@@ -174,23 +180,25 @@ curl -X GET
http://localhost:8080/mp-metrics-histogram/metrics/application
"stddev":0.0,
"unit":"none"
}
-}
-....
+}
+----
== Metric Metadata:
A metric will have a metadata to provide information about it such as
-displayName, description, tags, etc.
+`displayName`, `description`, `tags`, etc.
=== Request:
-....
-curl -X OPTIONS http://localhost:8080/mp-metrics-histogram/metrics/application
-....
+[source,bash]
+----
+$ curl -X OPTIONS
http://localhost:8080/mp-metrics-histogram/metrics/application
+----
=== Response:
-....
+[source,javascript]
+----
{
"org.superbiz.histogram.WeatherService.temperatures": {
"description": "A histogram metrics example.",
@@ -203,10 +211,11 @@ curl -X OPTIONS
http://localhost:8080/mp-metrics-histogram/metrics/application
"unit":"none"
}
}
-....
+----
=== Test the application:
-....
-mvn test
-....
+[source,bash]
+----
+$ mvn test
+----
diff --git a/examples/mp-metrics-histogram/README.adoc
b/examples/mp-metrics-histogram/README_es.adoc
similarity index 70%
copy from examples/mp-metrics-histogram/README.adoc
copy to examples/mp-metrics-histogram/README_es.adoc
index 8cd9553..4bafb2d 100644
--- a/examples/mp-metrics-histogram/README.adoc
+++ b/examples/mp-metrics-histogram/README_es.adoc
@@ -1,28 +1,30 @@
-= MicroProfile Metrics Histogram
+= Métricas con MicroProfile `@Histogram`
:index-group: MicroProfile
:jbake-type: page
:jbake-status: published
-This is an example on how to use microprofile metrics in TomEE.
+Este es un ejemplo sobre cómo utilizar las métricas de microperfil en TomEE.
-== Run the application:
+== Ejecute la aplicación:
-....
-mvn clean install tomee:run
-....
+[source,bash]
+----
+$ mvn clean install tomee:run
+----
-Within the application, there is an enpoint that will give you a weather
-histogram of the most recent New York City temperatures.
+Dentro de la aplicación, hay un endpoint que te dará un histograma del clima
de las más recientes temperaturas en la Ciudad de Nueva York.
== Request:
-....
-curl -X GET http://localhost:8080/mp-metrics-histogram/weather/histogram
-....
+[source,bash]
+----
+$ curl -X GET http://localhost:8080/mp-metrics-histogram/weather/histogram
+----
== Response:
-....
+[source,javascript]
+----
{
"count":15,
"max":55,
@@ -36,17 +38,17 @@ curl -X GET
http://localhost:8080/mp-metrics-histogram/weather/histogram
"p999":54.0,
"stddev":7.0710678118654755,
"unit":"degrees F"
-}
-....
+}
+----
-== Histogram Feature
+== Usando `@Histogram`
-Microprofile metrics has a feature create a histogram of data.
+Las métricas de MicroProfile tienen una función que te permite crear un
histograma datos.
-To use this feature, inject a MetricRegistry, register the Histogram,
-and add data to the histogram as shown below.
+Para utilizar esta función, injecta un objeto `MetricRegistry`, registra el
Histograma, and agrega datos al histograma como se muestra a continuación.
-....
+[source,java]
+----
@Inject
private MetricRegistry registry;
@@ -68,41 +70,41 @@ public Histogram getTemperatures() {
}
return histogram;
}
-....
+----
-There are some Histogram configurations defined in the @Metric
-annotation:
+Hay algunas configuraciones definidas en la anotación `@Histogram`:
-*String name* Optional. The name of the metric. If not explicitly given
-the name of the annotated object is used.
+*String name* Opcional. Establece el nombre de la métrica. Si no se proporciona
+explícitamente, se utiliza el nombre del objeto anotado.
-*String displayName* Optional. A human readable display name for
-metadata.
+*String displayName* Opcional. Un nombre para mostrar legible para los
metadatos.
-*String description* Optional. A description of the metric.
+*String description* Opcional. Una descripción de la métrica.
-*String[] tags* Optional. An array of Strings in the = format to supply
-special tags to a metric.
+*String[] tags* Opcional. Matriz de cadenas en el formato = para suministrar
+etiquetas especiales a una métrica.
-*boolean reusable* Denotes if a metric with a certain name can be
-registered in more than one place. Does not apply to gauges or
-histograms.
+*boolean reusable* Indica si una métrica con un nombre determinado se puede
+registrar en más de un lugar. No se aplica a `@Histogram`.
-=== For the histogram status:
+=== GET /histogram/status:
-....
-GET http://localhost:8080/mp-metrics-histogram/weather/histogram/status
-....
+[source,bash]
+----
+$ curl -X GET
http://localhost:8080/mp-metrics-histogram/weather/histogram/status
+----
-=== Reponse:
+=== Respuesta:
-....
+[source,bash]
+----
Here are the most recent New York City temperatures.
-....
+----
-=== Expected Prometheus format:
+=== Formato Prometheus:
-....
+[source,text]
+----
# TYPE application:temperatures_degrees F summary histogram
# TYPE application:temperatures_degrees F_count histogram
application:temperatures_degrees F_count 15.0
@@ -149,17 +151,19 @@ GET
http://localhost:8080/mp-metrics-histogram/weather/histogram/status
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
-....
+----
-=== Request:
+=== Formato JSON:
-....
-curl -X GET http://localhost:8080/mp-metrics-histogram/metrics/application
-....
+[source,bash]
+----
+$ curl -X GET http://localhost:8080/mp-metrics-histogram/metrics/application
+----
-=== Response:
+=== Respuesta JSON:
-....
+[source,javascript]
+----
{
"org.superbiz.histogram.WeatherService.temperatures": {
"count":0,
@@ -174,23 +178,25 @@ curl -X GET
http://localhost:8080/mp-metrics-histogram/metrics/application
"stddev":0.0,
"unit":"none"
}
-}
-....
+}
+----
-== Metric Metadata:
+== Metadatos de la Métrica:
-A metric will have a metadata to provide information about it such as
-displayName, description, tags, etc.
+Una métrica tendrá metadatos para que pueda conocer más información al
+respecto, como `displayName`,`description`, `tags`, etc.
-=== Request:
+=== Solicitud HTTP _OPTIONS_:
-....
-curl -X OPTIONS http://localhost:8080/mp-metrics-histogram/metrics/application
-....
+[source,bash]
+----
+$ curl -X OPTIONS
http://localhost:8080/mp-metrics-histogram/metrics/application
+----
-=== Response:
+=== Respuesta:
-....
+[source,javascript]
+----
{
"org.superbiz.histogram.WeatherService.temperatures": {
"description": "A histogram metrics example.",
@@ -203,10 +209,11 @@ curl -X OPTIONS
http://localhost:8080/mp-metrics-histogram/metrics/application
"unit":"none"
}
}
-....
+----
-=== Test the application:
+=== Prueba la aplicación
-....
-mvn test
-....
+[source,bash]
+----
+$ mvn test
+----
