You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/includes/metrics/metrics-capable-components.adoc
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -77,9 +77,10 @@ endif::[]
77
77
As you plan and write Helidon components and applications,
78
78
you make some choices about exactly how your code will use metrics.
79
79
This document gives some background information,
80
-
describes the choices you face, explains their ramifications, and provides some code examples.
80
+
describes each option and its effect, and provides some code examples.
81
81
82
82
== Usage
83
+
This section helps you decide how incorporate metrics into your software by describing the categories of metrics usage, explaining generally how Helidon implements metrics, and illustrating how to write the metrics-related code accordingly.
83
84
84
85
=== Categorizing Metrics Usage
85
86
We can place each Helidon component and Helidon application into one of three categories based on how it relies on metrics.
@@ -103,10 +104,10 @@ The type of module dictates the compile-time dependency you declare in the proje
103
104
|metrics-dependent
104
105
|===
105
106
106
-
Whenever possible, if your component or app uses metrics write it as metrics-capable code.
107
+
Whenever possible, if your component or application uses metrics, then write it as metrics-capable code.
107
108
108
109
=== Understanding the Two Metrics Implementations
109
-
Helidon provides two metrics implementations.
110
+
Helidon provides two metrics implementations:
110
111
111
112
* _Full-featured_ metrics allows registering, removing, and updating metrics and observing metrics' changing values.
112
113
The `helidon-metrics` component contains full-featured metrics.
@@ -292,8 +293,8 @@ Helidon returns either a full-featured `RegistryFactory` or a minimal one, depen
292
293
// tag::writing-code-ending[]
293
294
294
295
== Examples
295
-
=== An Example: Docker Images
296
-
Here is an example showing how useful metrics-capable code can be.
296
+
297
+
The following example shows how useful metrics-capable code can be in the context of building Docker images.
297
298
298
299
You (or others) could assemble a Docker image with your metrics-capable app as its top layer or your metrics-capable component in a middle layer, built on a lower layer containing several Helidon modules including the full metrics implementation.
299
300
When that Docker image runs, your app will run with full-featured metrics support.
Copy file name to clipboardExpand all lines: docs/includes/metrics/metrics-shared.adoc
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -57,7 +57,7 @@ ifdef::mp-flavor[each of these.]
57
57
ifdef::se-flavor[this.]
58
58
59
59
=== Categorizing Types of Metrics
60
-
Helidon distinguishes among three general _types_, or scopes, of metrics, as described in the MP metrics specification.
60
+
Helidon distinguishes among three general _types_, or scopes, of metrics, as described in the link:{microprofile-metrics-spec-url}[MP metrics specification].
Copy file name to clipboardExpand all lines: docs/includes/metrics/micrometer-shared.adoc
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -124,7 +124,7 @@ Note that the first config example is equivalent to the default Helidon Micromet
124
124
125
125
The configuration keys that are valid for the `builtin-registries` child entries depend on the type of Micrometer meter
126
126
registry.
127
-
For example, the Prometheus meter registry supports the `prefix` configuration setting but other meter registries might not and might support other settings.
127
+
For example, support in Helidon for the link:{micrometer-javadoc-registry-prometheus-base-url}/PrometheusConfig.html[Prometheus meter registry] respects the `prefix` configuration setting but other meter registries might not and might support other settings.
128
128
Refer to the documentation for the meter registry you want to configure to find out what items apply to that registry
Your application registers and updates Micrometer meters using annotations or direct use of the Micrometer API.
40
+
41
+
Your users retrieve Micrometer meters using an endpoint which Helidon creates automatically.
39
42
40
43
=== Registering and Updating Meters
41
44
To use Micrometer support, you can simply add the Micrometer `@Timed` and `@Counted` annotations to methods in your application. Helidon automatically registers those meters with the Micrometer composite `MeterRegistry`.
0 commit comments