Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation for theMP Config properties backport for MP Metrics 3.0 and 40 #7400

Merged
merged 1 commit into from
Jun 26, 2024
Merged

Documentation for theMP Config properties backport for MP Metrics 3.0 and 40 #7400

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions modules/ROOT/pages/microprofile-config-properties.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ a| Specifies a list of metric names that are paired with custom sets of histogra
* Defining a metric name with no bucket values or invalid values has no effect.
Value precedence is right to left so values that are specified later in the property definition take precedence over previously specified values.

This property is available starting in MicroProfile Metrics 5.1.
This property is available starting in MicroProfile Metrics 3.0.
|Server startup
|`mp.metrics.distribution.histogram.buckets=test.alpha.histogram=10.0,50.0,100.0;test.beta.histogram=30.0,50.0,123`

Expand All @@ -285,7 +285,7 @@ a| When the `mp.metrics.distribution.percentiles-histogram.enabled` property is
* Defining a metric name with no value or an invalid value has no effect.
* Value precedence is right to left so values that are defined later in the property definition take precedence over earlier values.

This property is available starting in MicroProfile Metrics 5.1.
This property is available starting in MicroProfile Metrics 3.0.
|Server startup
| `mp.metrics.distribution.histogram.max-value=test.histogram=120`

Expand All @@ -298,7 +298,7 @@ a| When the `mp.metrics.distribution.percentiles-histogram.enabled` property is
* Defining a metric name with no value or an invalid value has no effect.
* Value precedence is right to left so values that are specified later in the property definition take precedence over previously specified values.

This property is available starting in MicroProfile Metrics 5.1.
This property is available starting in MicroProfile Metrics 3.0.
|Server startup
| `mp.metrics.distribution.histogram.min-value=test.histogram=50`

Expand All @@ -312,7 +312,7 @@ a|Specifies a list of metric names that are paired with custom sets of percentil
* Setting the property without any value disables percentiles for all histogram and timer metrics.
* Value precedence is right to left so values that are specified later in the property definition take precedence over previously specified values.

This property is available starting in MicroProfile Metrics 5.1.
This property is available starting in MicroProfile Metrics 3.0.
|Server startup
|`mp.metrics.distribution.percentiles=test.histogram=0.8,0.86,0.95;test.timer=0.9,0.99;test.*=0.5,0.6;other.*=`

Expand All @@ -324,7 +324,7 @@ a| Specifies a list of metric names that are paired with a true or false value.
* Defining a metric name with no values or invalid values has no effect.
* Values defined later take precedence over values before. Precedence is right to left.

This property is available starting in MicroProfile Metrics 5.1.
This property is available starting in MicroProfile Metrics 3.0.
|Server startup
| `mp.metrics.distribution.percentiles-histogram.enabled=test.timer=true;test.histogram=false`

Expand All @@ -337,7 +337,7 @@ a| Specifies a list of metric names that are paired with custom sets of histogra
* Defining a metric name with no bucket values or invalid values has no effect.
* Value precedence is right to left so values that are specified later in the property definition take precedence over previously specified values.

This property is available starting in MicroProfile Metrics 5.1.
This property is available starting in MicroProfile Metrics 3.0.
|Server startup
|`mp.metrics.distribution.timer.buckets=test.*=50s,100s;test.alpha.timer=100,500ms,1s`

Expand All @@ -350,7 +350,7 @@ a| When the `mp.metrics.distribution.percentiles-histogram.enabled` property is
* Defining a metric name with no value or an invalid value has no effect.
* Value precedence is right to left so values that are specified later in the property definition take precedence over previously specified values.

This property is available starting in MicroProfile Metrics 5.1.
This property is available starting in MicroProfile Metrics 3.0.
|Server startup
| `mp.metrics.distribution.histogram.max-value=test.timer=5s`

Expand All @@ -363,7 +363,7 @@ a| When the `mp.metrics.distribution.percentiles-histogram.enabled` property is
* Defining a metric name with no value or an invalid value has no effect.
* Value precedence is right to left so values that are specified later in the property definition take precedence over previously specified values.

This property is available starting in MicroProfile Metrics 5.1.
This property is available starting in MicroProfile Metrics 3.0.
|Server startup
| `mp.metrics.distribution.histogram.min-value=test.timer=200`

Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/microservice-observability-metrics.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ public String donateAmountViaCreditCard(@FormParam("amount") Long amount, @FormP

Starting in MicroProfile Metrics 5.0, you can adjust the percentile precision of the `Timer` metrics by using the `mp.metrics.smallrye.timer.precision` MicroProfile Config property. The property accepts a value from 1 to 5 and is defaulted to 3 if no value is specified. A greater value results in more exact percentile calculations, but at a greater memory cost.

Starting in MicroProfile Metrics 5.1, you can customize the set of percentiles that are tracked and reported by using the `mp.metrics.distribution.percentiles` MicroProfile config property. You can also use the `mp.metrics.distribution.timer.buckets` property to enable a customized set of histogram buckets to be tracked and reported. Alternatively, you can use the `mp.metrics.distribution.percentiles-histogram.enabled` property to enable the timer metric to output and track a default set of histogram buckets. Performance might decrease if a large set of buckets are enabled for numerous histogram or timer metrics.
Starting in MicroProfile Metrics 3.0, you can customize the set of percentiles that are tracked and reported by using the `mp.metrics.distribution.percentiles` MicroProfile config property. You can also use the `mp.metrics.distribution.timer.buckets` property to enable a customized set of histogram buckets to be tracked and reported. Alternatively, you can use the `mp.metrics.distribution.percentiles-histogram.enabled` property to enable the timer metric to output and track a default set of histogram buckets. Performance might decrease if a large set of buckets are enabled for numerous histogram or timer metrics.

For more information, see xref:microprofile-config-properties.adoc#metrics[MicroProfile Config properties: MicroProfile Metrics].

Expand Down Expand Up @@ -222,7 +222,7 @@ In MicroProfile 4.0 and earlier, the following JSON response is also available f

Starting in MicroProfile Metrics 5.0, you can adjust the percentile precision of the `Histogram` metrics by using the `mp.metrics.smallrye.histogram.precision` MicroProfile Config property. The property accepts a value from 1 to 5 and is defaulted to 3 if no value is specified. A greater value results in more exact percentile calculations, but at a greater memory cost.

Starting in MicroProfile Metrics 5.1, you can customize the set of percentiles that are tracked and reported by using the `mp.metrics.distribution.percentiles` MicroProfile config property. You can also use the `mp.metrics.distribution.histogram.buckets` property to enable a customized set of histogram buckets to be tracked and reported. Alternatively, you can use the `mp.metrics.distribution.percentiles-histogram.enabled` property to enable the histogram metric to output and track a default set of histogram buckets. Performance might decrease if a large set of buckets are enabled for numerous histogram or timer metrics.
Starting in MicroProfile Metrics 3.0, you can customize the set of percentiles that are tracked and reported by using the `mp.metrics.distribution.percentiles` MicroProfile config property. You can also use the `mp.metrics.distribution.histogram.buckets` property to enable a customized set of histogram buckets to be tracked and reported. Alternatively, you can use the `mp.metrics.distribution.percentiles-histogram.enabled` property to enable the histogram metric to output and track a default set of histogram buckets. Performance might decrease if a large set of buckets are enabled for numerous histogram or timer metrics.

For more information, see xref:microprofile-config-properties.adoc#metrics[MicroProfile Config properties: MicroProfile Metrics].

Expand Down