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: spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/enabling.adoc
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,15 @@
1
1
[[actuator.enabling]]
2
2
== Enabling Production-ready Features
3
3
The {spring-boot-code}/spring-boot-project/spring-boot-actuator[`spring-boot-actuator`] module provides all of Spring Boot's production-ready features.
4
-
The recommended way to enable the features is to add a dependency on the `spring-boot-starter-actuator` '`Starter`'.
4
+
The recommended way to enable the features is to add a dependency on the `spring-boot-starter-actuator` "`Starter`".
5
5
6
6
.Definition of Actuator
7
7
****
8
8
An actuator is a manufacturing term that refers to a mechanical device for moving or controlling something.
9
9
Actuators can generate a large amount of motion from a small change.
10
10
****
11
11
12
-
To add the actuator to a Mavenbased project, add the following '`Starter`' dependency:
12
+
To add the actuator to a Maven-based project, add the following '`Starter`' dependency:
Copy file name to clipboardExpand all lines: spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/endpoints.adoc
+13-12Lines changed: 13 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -63,7 +63,7 @@ The following technology-agnostic endpoints are available:
63
63
Requires one or more `Liquibase` beans.
64
64
65
65
| `metrics`
66
-
| Shows '`metrics`' information for the current application.
66
+
| Shows "`metrics`" information for the current application.
67
67
68
68
| `mappings`
69
69
| Displays a collated list of all `@RequestMapping` paths.
@@ -429,7 +429,7 @@ The following configuration permits `GET` and `POST` calls from the `example.com
429
429
allowed-methods: "GET,POST"
430
430
----
431
431
432
-
TIP: See {spring-boot-actuator-autoconfigure-module-code}/endpoint/web/CorsEndpointProperties.java[CorsEndpointProperties] for a complete list of options.
432
+
TIP: See {spring-boot-actuator-autoconfigure-module-code}/endpoint/web/CorsEndpointProperties.java[`CorsEndpointProperties`] for a complete list of options.
433
433
434
434
435
435
@@ -547,19 +547,19 @@ The HTTP method of the predicate is determined by the operation type, as shown i
For a `@WriteOperation` (HTTP `POST`) that uses the request body, the consumes clause of the predicate is `application/vnd.spring-boot.actuator.v2+json, application/json`.
550
-
For all other operations the consumes clause is empty.
550
+
For all other operations, the `consumes` clause is empty.
The produces clause of the predicate can be determined by the `produces` attribute of the `@DeleteOperation`, `@ReadOperation`, and `@WriteOperation` annotations.
556
+
The `produces` clause of the predicate can be determined by the `produces` attribute of the `@DeleteOperation`, `@ReadOperation`, and `@WriteOperation` annotations.
557
557
The attribute is optional.
558
-
If it is not used, the produces clause is determined automatically.
558
+
If it is not used, the `produces` clause is determined automatically.
559
559
560
-
If the operation method returns `void` or `Void` the produces clause is empty.
561
-
If the operation method returns a `org.springframework.core.io.Resource`, the produces clause is `application/octet-stream`.
562
-
For all other operations the produces clause is `application/vnd.spring-boot.actuator.v2+json, application/json`.
560
+
If the operation method returns `void` or `Void`, the `produces` clause is empty.
561
+
If the operation method returns a `org.springframework.core.io.Resource`, the `produces` clause is `application/octet-stream`.
562
+
For all other operations, the `produces` clause is `application/vnd.spring-boot.actuator.v2+json, application/json`.
563
563
564
564
565
565
@@ -741,11 +741,11 @@ Additional `HealthIndicators` are available but not enabled by default:
| Exposes the "Readiness" application availability state.
748
+
| Exposes the "`Readiness`" application availability state.
749
749
|===
750
750
751
751
@@ -886,7 +886,7 @@ Also, any `HealthIndicator` that is not handled explicitly is wrapped automatica
886
886
==== Health Groups
887
887
It's sometimes useful to organize health indicators into groups that can be used for different purposes.
888
888
889
-
To create a health indicator group you can use the `management.endpoint.health.group.<name>` property and specify a list of health indicator IDs to `include` or `exclude`.
889
+
To create a health indicator group, you can use the `management.endpoint.health.group.<name>` property and specify a list of health indicator IDs to `include` or `exclude`.
890
890
For example, to create a group that includes only database indicators you can define the following:
==== Checking External State with Kubernetes Probes
1031
-
Actuator configures the "liveness" and "readiness" probes as Health Groups; this means that all the <<actuator#actuator.endpoints.health.groups, Health Groups features>> are available for them.
1031
+
Actuator configures the "`liveness`" and "`readiness`" probes as Health Groups.
1032
+
This means that all the <<actuator#actuator.endpoints.health.groups, health groups features>> are available for them.
1032
1033
You can, for example, configure additional Health Indicators:
Copy file name to clipboardExpand all lines: spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/metrics.adoc
+14-5Lines changed: 14 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -294,13 +294,16 @@ The https://graphiteapp.org[Graphite server] host and port to use can be provide
294
294
295
295
Micrometer provides a default `HierarchicalNameMapper` that governs how a dimensional meter id is {micrometer-registry-docs}/graphite#_hierarchical_name_mapping[mapped to flat hierarchical names].
296
296
297
-
TIP: To take control over this behavior, define your `GraphiteMeterRegistry` and supply your own `HierarchicalNameMapper`.
297
+
[TIP]
298
+
====
299
+
To take control over this behavior, define your `GraphiteMeterRegistry` and supply your own `HierarchicalNameMapper`.
298
300
An auto-configured `GraphiteConfig` and `Clock` beans are provided unless you define your own:
@@ -367,13 +370,16 @@ The domain to use can be provided using:
367
370
368
371
Micrometer provides a default `HierarchicalNameMapper` that governs how a dimensional meter id is {micrometer-registry-docs}/jmx#_hierarchical_name_mapping[mapped to flat hierarchical names].
369
372
370
-
TIP: To take control over this behavior, define your `JmxMeterRegistry` and supply your own `HierarchicalNameMapper`.
373
+
[TIP]
374
+
====
375
+
To take control over this behavior, define your `JmxMeterRegistry` and supply your own `HierarchicalNameMapper`.
371
376
An auto-configured `JmxConfig` and `Clock` beans are provided unless you define your own:
@@ -854,7 +860,8 @@ Data source instrumentation results in gauges representing the currently active,
854
860
855
861
Metrics are also tagged by the name of the `DataSource` computed based on the bean name.
856
862
857
-
TIP: By default, Spring Boot provides metadata for all supported data sources; you can add additional `DataSourcePoolMetadataProvider` beans if your favorite data source isn't supported out of the box.
863
+
TIP: By default, Spring Boot provides metadata for all supported data sources.
864
+
You can add additional `DataSourcePoolMetadataProvider` beans if your favorite data source is not supported.
858
865
See `DataSourcePoolMetadataProvidersConfiguration` for examples.
859
866
860
867
Also, Hikari-specific metrics are exposed with a `hikaricp` prefix.
@@ -935,6 +942,7 @@ For more details refer to {spring-kafka-docs}#micrometer-native[Micrometer Nativ
935
942
936
943
[[actuator.metrics.supported.mongodb]]
937
944
==== MongoDB Metrics
945
+
This section briefly describes the available metrics for MongoDB.
938
946
939
947
940
948
@@ -1168,10 +1176,11 @@ For more details on concepts behind `percentiles-histogram`, `percentiles` and `
1168
1176
[[actuator.metrics.endpoint]]
1169
1177
=== Metrics Endpoint
1170
1178
Spring Boot provides a `metrics` endpoint that can be used diagnostically to examine the metrics collected by an application.
1171
-
The endpoint is not available by default and must be exposed, see <<actuator#actuator.endpoints.exposing,exposing endpoints>> for more details.
1179
+
The endpoint is not available by default and must be exposed.
1180
+
See <<actuator#actuator.endpoints.exposing,exposing endpoints>> for more details.
1172
1181
1173
1182
Navigating to `/actuator/metrics` displays a list of available meter names.
1174
-
You can drill down to view information about a particular meter by providing its name as a selector, e.g. `/actuator/metrics/jvm.memory.max`.
1183
+
You can drill down to view information about a particular meter by providing its name as a selector -- for example, `/actuator/metrics/jvm.memory.max`.
Copy file name to clipboardExpand all lines: spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/whats-next.adoc
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -2,4 +2,4 @@
2
2
== What to Read Next
3
3
You might want to read about graphing tools such as https://graphiteapp.org[Graphite].
4
4
5
-
Otherwise, you can continue on, to read about <<deployment#deployment, '`deployment options`'>> or jump ahead for some in-depth information about Spring Boot's _<<build-tool-plugins#build-tool-plugins, build tool plugins>>_.
5
+
Otherwise, you can continue on to read about <<deployment#deployment, "`deployment options`">> or jump ahead for some in-depth information about Spring Boot's <<build-tool-plugins#build-tool-plugins, build tool plugins>>.
0 commit comments