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: articles/container-apps/java-admin-for-spring-usage.md
+49-54Lines changed: 49 additions & 54 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,14 +9,9 @@ ms.date: 05/24/2024
9
9
ms.author:
10
10
---
11
11
12
-
# Configure settings for the Admin for Spring component in Azure Container Apps (preview)
13
-
14
-
The Admin for Spring managed component offers an administrative interface for Spring Boot web applications that expose actuator endpoints. Use the following guidance to learn how to configure and manage your Admin for Spring component.
15
-
16
-
## Prerequisites
17
-
18
-
Before starting this tutorial, you need to have an Admin for Spring component created. If you haven't done this yet, follow the steps in the tutorial [Tutorial: Connect to a managed Admin for Spring in Azure Container Apps](java-admin.md).
12
+
# Configure the Spring Boot Admin component in Azure Container Apps (preview)
19
13
14
+
The Admin for Spring managed component offers an administrative interface for Spring Boot web applications that expose actuator endpoints. This article shows you how to configure and manage your Spring component.
20
15
21
16
## Show
22
17
@@ -30,11 +25,12 @@ az containerapp env java-component admin-for-spring show \
30
25
--resource-group <RESOURCE_GROUP> \
31
26
--name <JAVA_COMPONENT_NAME>
32
27
```
28
+
33
29
## Update
34
30
35
31
You can update the configuration of an Admin for Spring component using the `update` command.
36
32
37
-
Before you run the following command, replace placeholders surrounded by `<>` with your values. And the supported configurations are listed in the [table](#allowed-configuration-list-for-your-admin-for-spring).
33
+
Before you run the following command, replace placeholders surrounded by `<>` with your values. Supported configurations are listed in the [properties list table](#configurable-properties).
38
34
39
35
```azurecli
40
36
az containerapp env java-component admin-for-spring update \
@@ -71,7 +67,7 @@ az containerapp update \
71
67
72
68
## Dependency
73
69
74
-
For Container App that wants to connect to the Admin for Spring, you need to add the following dependency in your `pom.xml` file.
70
+
When you use the admin component in your container app, you need to add the following dependency in your `pom.xml` file.
75
71
76
72
```xml
77
73
<dependency>
@@ -80,56 +76,55 @@ For Container App that wants to connect to the Admin for Spring, you need to add
80
76
</dependency>
81
77
```
82
78
83
-
## Allowed configuration list for your Admin for Spring
84
-
85
-
The following list details supported configurations. You can find more details in [Spring Boot Admin](https://docs.spring-boot-admin.com/current/server.html).
| spring.boot.admin.server.enabled | Enables the Spring Boot Admin Server. |`true`|
91
-
| spring.boot.admin.context-path | The context-path prefixes the path where the Admin Server’s statics assets and API should be served. Relative to the Dispatcher-Servlet. ||
92
-
| spring.boot.admin.monitor.status-interval | Time interval to check the status of instances. | 10,000ms |
93
-
| spring.boot.admin.monitor.status-lifetime | Lifetime of status. The status won’t be updated as long the last status isn’t expired. | 10,000ms |
94
-
| spring.boot.admin.monitor.info-interval | Time interval to check the info of instances. | 1m |
95
-
| spring.boot.admin.monitor.info-lifetime | Lifetime of info. The info won’t be updated as long the last info isn’t expired. | 1m |
96
-
| spring.boot.admin.monitor.default-timeout | Default timeout when making requests. Individual values for specific endpoints can be overridden using `spring.boot.admin.monitor.timeout.*`. | 10,000 |
97
-
| spring.boot.admin.monitor.timeout.*| Key-Value-Pairs with the timeout per endpointId. Defaults to default-timeout. ||
98
-
| spring.boot.admin.monitor.default-retries | Default number of retries for failed requests. Modifying requests (`PUT`, `POST`, `PATCH`, `DELETE`) are never retried. Individual values for specific endpoints can be overridden using `spring.boot.admin.monitor.retries.*`. | 0 |
99
-
| spring.boot.admin.monitor.retries.*| Key-Value-Pairs with the number of retries per endpointId. Defaults to default-retries. Modifying requests (`PUT`, `POST`, `PATCH`, `DELETE`) are never retried. ||
100
-
| spring.boot.admin.metadata-keys-to-sanitize | Metadata values for the keys matching these regex patterns will be sanitized in all json output.Starting from Spring Boot 3, all actuator values are masked by default.Take a look at the Spring Boot documentation in order to configure unsanitizing of values ([Sanitize Sensitive Values](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#howto.actuator.sanitize-sensitive-values)). |`".**password$", ".\*secret$", ".\*key$", ".\*token$", ".\*credentials.**", ".*vcap_services$"`|
101
-
| spring.boot.admin.probed-endpoints | For Spring Boot 1.x client applications SBA probes for the specified endpoints using an OPTIONS request. If the path differs from the id you can specify this as id:path (e.g. health:ping).. |`"health", "env", "metrics", "httptrace:trace", "threaddump:dump", "jolokia", "info", "logfile", "refresh", "flyway", "liquibase", "heapdump", "loggers", "auditevents"`|
102
-
| spring.boot.admin.instance-proxy.ignored-headers | Headers not to be forwarded when making requests to clients. |`"Cookie", "Set-Cookie", "Authorization"`|
103
-
| spring.boot.admin.ui.title | Page-Title to be shown. |`"Spring Boot Admin"`|
104
-
| spring.boot.admin.ui.poll-timer.cache | Polling duration in ms to fetch new cache data. |`2500`|
105
-
| spring.boot.admin.ui.poll-timer.datasource | Polling duration in ms to fetch new datasource data. |`2500`|
106
-
| spring.boot.admin.ui.poll-timer.gc | Polling duration in ms to fetch new gc data. |`2500`|
107
-
| spring.boot.admin.ui.poll-timer.process | Polling duration in ms to fetch new process data. |`2500`|
108
-
| spring.boot.admin.ui.poll-timer.memory | Polling duration in ms to fetch new memory data. |`2500`|
109
-
| spring.boot.admin.ui.poll-timer.threads | Polling duration in ms to fetch new threads data. |`2500`|
110
-
| spring.boot.admin.ui.poll-timer.logfile | Polling duration in ms to fetch new logfile data. |`1000`|
111
-
| spring.boot.admin.ui.enable-toasts | Allows to enable toast notifications. |`false`|
112
-
|spring.boot.admin.ui.title| Use this option to customize the browsers window title| ""|
113
-
|spring.boot.admin.ui.brand| This HTML snippet is rendered in navigation header and defaults to Spring Boot Admin label. By default it shows the SBA logo followed by it’s name.| ""|
114
-
| management.scheme | The scheme is substituted in the service URL and will be used for accessing the actuator endpoints. ||
115
-
| management.address | The address is substituted in the service URL and will be used for accessing the actuator endpoints. ||
116
-
| management.port | The port is substituted in the service URL and will be used for accessing the actuator endpoints. ||
117
-
| management.context-path | The path is appended to the service URL and will be used for accessing the actuator endpoints. |`${spring.boot.admin.discovery.converter.management-context-path}`|
118
-
| health.path | The path is appended to the service URL and will be used for the health-checking. Ignored by the `EurekaServiceInstanceConverter`. |`${spring.boot.admin.discovery.converter.health-endpoint}`|
119
-
| spring.boot.admin.discovery.enabled | Enables the DiscoveryClient-support for the admin server. |`true`|
120
-
| spring.boot.admin.discovery.converter.management-context-path | Will be appended to the service-url of the discovered service when the management-url is converted by the `DefaultServiceInstanceConverter`. |`/actuator`|
121
-
| spring.boot.admin.discovery.converter.health-endpoint-path | Will be appended to the management-url of the discovered service when the health-url is converted by the `DefaultServiceInstanceConverter`. |`"health"`|
122
-
| spring.boot.admin.discovery.ignored-services | This services will be ignored when using discovery and not registered as application. Supports simple patterns (e.g. "foo*", "*bar", "foo*bar*"). ||
123
-
| spring.boot.admin.discovery.services | This services will be included when using discovery and registered as application. Supports simple patterns (e.g. "foo*", "*bar", "foo*bar*"). |`"*"`|
124
-
| spring.boot.admin.discovery.ignored-instances-metadata | Instances of services will be ignored if they contain at least one metadata item that matches this list. (e.g. "discoverable=false") ||
125
-
| spring.boot.admin.discovery.instances-metadata | Instances of services will be included if they contain at least one metadata item that matches this list. (e.g. "discoverable=true") |
79
+
## Configurable properties
80
+
81
+
The following list details the admin component properties you can configure for your app. You can find more details in [Spring Boot Admin](https://docs.spring-boot-admin.com/current/server.html) docs.
82
+
83
+
| Property name | Description | Default value |
84
+
|--|--|--|
85
+
|`spring.boot.admin.server.enabled`| Enables the Spring Boot Admin Server. |`true`|
86
+
|`spring.boot.admin.context-path`| The path prefix where the Admin Server’s statics assets and API are served. Relative to the Dispatcher-Servlet. ||
87
+
|`spring.boot.admin.monitor.status-interval`| Time interval in milliseconds to check the status of instances. |`10,000ms`|
88
+
|`spring.boot.admin.monitor.status-lifetime`| Lifetime of status in milliseconds. The status isn't updated as long the last status isn’t expired. | 10,000 ms |
89
+
|`spring.boot.admin.monitor.info-interval`| Time interval in milliseconds to check the info of instances. |`1m`|
90
+
|`spring.boot.admin.monitor.info-lifetime`| Lifetime of info in minutes. The info isn't as long the last info isn’t expired. |`1m`|
91
+
|`spring.boot.admin.monitor.default-timeout`| Default timeout when making requests. Individual values for specific endpoints can be overridden using `spring.boot.admin.monitor.timeout.*`. |`10,000`|
92
+
|`spring.boot.admin.monitor.timeout.*`| Key-value pairs with the timeout per `endpointId`. | Defaults to `default-timeout` value. |
93
+
|`spring.boot.admin.monitor.default-retries`| Default number of retries for failed requests. Requests that modify data (`PUT`, `POST`, `PATCH`, `DELETE`) are never retried. Individual values for specific endpoints can be overridden using `spring.boot.admin.monitor.retries.*`. |`0`|
94
+
|`spring.boot.admin.monitor.retries.*`| Key-value pairs with the number of retries per `endpointId`. Requests that modify data (`PUT`, `POST`, `PATCH`, `DELETE`) are never retried. | Defaults to `default-retries` value. |
95
+
|`spring.boot.admin.metadata-keys-to-sanitize`| Metadata values for the keys matching these regex patterns used to sanitize in all JSON output. Starting from Spring Boot 3, all actuator values are masked by default. For more information about how to configure the unsanitization process, see ([Sanitize Sensitive Values](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#howto.actuator.sanitize-sensitive-values)). |`".**password$", ".\*secret$", ".\*key$", ".\*token$", ".\*credentials.**", ".*vcap_services$"`|
96
+
|`spring.boot.admin.probed-endpoints`| For Spring Boot 1.x client applications Spring Boot Admin probes for the specified endpoints using an `OPTIONS` request. If the path differs from the ID, you can specify this value as `id:path` (for example: `health:ping`) |`"health", "env", "metrics", "httptrace:trace", "threaddump:dump", "jolokia", "info", "logfile", "refresh", "flyway", "liquibase", "heapdump", "loggers", "auditevents"`|
97
+
|`spring.boot.admin.instance-proxy.ignored-headers`| Headers not to forwarded when making requests to clients. |`"Cookie", "Set-Cookie", "Authorization"`|
98
+
|`spring.boot.admin.ui.title`| The displayed page title. |`"Spring Boot Admin"`|
99
+
|`spring.boot.admin.ui.poll-timer.cache`| Polling duration in milliseconds to fetch new cache data. |`2500`|
100
+
|`spring.boot.admin.ui.poll-timer.datasource`| Polling duration in milliseconds to fetch new data source data. |`2500`|
101
+
|`spring.boot.admin.ui.poll-timer.gc`| Polling duration in milliseconds to fetch new gc data. |`2500`|
102
+
|`spring.boot.admin.ui.poll-timer.process`| Polling duration in milliseconds to fetch new process data. |`2500`|
103
+
|`spring.boot.admin.ui.poll-timer.memory`| Polling duration in milliseconds to fetch new memory data. |`2500`|
104
+
|`spring.boot.admin.ui.poll-timer.threads`| Polling duration in milliseconds to fetch new threads data. |`2500`|
105
+
|`spring.boot.admin.ui.poll-timer.logfile`| Polling duration in milliseconds to fetch new logfile data. |`1000`|
106
+
|`spring.boot.admin.ui.enable-toasts`| Enables or disables toast notifications. |`false`|
107
+
|`spring.boot.admin.ui.title`| Browser's window title value. | "" |
108
+
|`spring.boot.admin.ui.brand`| HTML code rendered in the navigation header and defaults to the Spring Boot Admin label. By default the Spring Boot Admin logo is followed by its name. | "" |
109
+
|`management.scheme`| Value that is substituted in the service URL used for accessing the actuator endpoints. ||
110
+
|`management.address`| Value that is substituted in the service URL used for accessing the actuator endpoints. ||
111
+
|`management.port`| Value that is substituted in the service URL used for accessing the actuator endpoints. ||
112
+
|`management.context-path`| Value that is appended to the service URL used for accessing the actuator endpoints. |`${spring.boot.admin.discovery.converter.management-context-path}`|
113
+
|`health.path`| Value that is appended to the service URL used for health checking. Ignored by the `EurekaServiceInstanceConverter`. |`${spring.boot.admin.discovery.converter.health-endpoint}`|
114
+
|`spring.boot.admin.discovery.enabled`| Enables the `DiscoveryClient` support for the admin server. |`true`|
115
+
|`spring.boot.admin.discovery.converter.management-context-path`| Value that is appended to the `service-url` of the discovered service when the `management-url` value is converted by the `DefaultServiceInstanceConverter`. |`/actuator`|
116
+
|`spring.boot.admin.discovery.converter.health-endpoint-path`| Value that is appended to the `management-url` of the discovered service when the `health-url` value is converted by the `DefaultServiceInstanceConverter`. |`"health"`|
117
+
|`spring.boot.admin.discovery.ignored-services`| Services that are ignored when using discovery and not registered as application. Supports simple patterns such as `"foo*"`, `"*bar"`, `"foo*bar*"`. ||
118
+
|`spring.boot.admin.discovery.services`| Services included when using discovery and registered as application. Supports simple patterns such as `"foo*"`, `"*bar"`, `"foo*bar*"`. |`"*"`|
119
+
|`spring.boot.admin.discovery.ignored-instances-metadata`| Services ignored if they contain at least one metadata item that matches patterns in this list. Supports patterns such as `"discoverable=false"`. ||
120
+
|`spring.boot.admin.discovery.instances-metadata`| Services included if they contain at least one metadata item that matches patterns in list. Supports patterns such as `"discoverable=true"`. ||
- Any other configurations under logging.* namespace should be forbidden, for example, writing log files by using `logging.file` should be forbidden.
127
+
- Any other configurations under `logging.*` namespace should be forbidden. For example, writing log files by using `logging.file` should be forbidden.
0 commit comments