Skip to content

Commit c4317dd

Browse files
author
Wenhao Zhang
committed
Merge component docs
1 parent 84d1fbb commit c4317dd

9 files changed

+544
-837
lines changed

articles/container-apps/TOC.yml

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -373,21 +373,9 @@
373373
displayName: java
374374
- name: Tutorials
375375
items:
376-
- name: Use Eureka Server for Spring
377-
href: java-eureka-server-usage.md
378-
displayName: java
379-
- name: Use Admin for Spring
380-
href: java-admin-for-spring-usage.md
381-
displayName: java
382376
- name: Integrate Eureka Server with Admin for Spring
383377
href: java-admin-eureka-integration.md
384378
displayName: java
385-
- name: Use Config Server for Spring
386-
href: java-config-server-usage.md
387-
displayName: java
388-
- name: Use Gateway for Spring
389-
href: java-gateway-for-spring-usage.md
390-
displayName: java
391379
- name: Query managed component logs
392380
href: java-component-logs.md
393381
displayName: java

articles/container-apps/java-admin-for-spring-usage.md

Lines changed: 0 additions & 148 deletions
This file was deleted.

articles/container-apps/java-admin.md

Lines changed: 69 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -348,10 +348,76 @@ az group delete \
348348
--resource-group $RESOURCE_GROUP
349349
```
350350

351-
## Next steps
351+
## Dependency
352352

353-
> [!div class="nextstepaction"]
354-
> [Configure Admin for Spring settings](java-admin-for-spring-usage.md)
353+
When you use the admin component in your own container app, you need to add the following dependency in your `pom.xml` file. Replace the version number with the latest version available on the [Maven Repository](https://search.maven.org/artifact/de.codecentric/spring-boot-admin-starter-client).
354+
355+
```xml
356+
<dependency>
357+
<groupId>de.codecentric</groupId>
358+
<version>3.3.2</version>
359+
<artifactId>spring-boot-admin-starter-client</artifactId>
360+
</dependency>
361+
```
362+
363+
## Configurable properties
364+
365+
Starting with Spring Boot 2, endpoints other than health and info are not exposed by default. You can expose them by adding the following configuration in your `application.properties` file.
366+
367+
```properties
368+
management.endpoints.web.exposure.include=*
369+
management.endpoint.health.show-details=always
370+
```
371+
372+
## Allowed configuration list for your Admin for Spring
373+
374+
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.
375+
376+
| Property name | Description | Default value |
377+
|--|--|--|
378+
| `spring.boot.admin.server.enabled` | Enables the Spring Boot Admin Server. | `true` |
379+
| `spring.boot.admin.context-path` | The path prefix where the Admin Server’s statics assets and API are served. Relative to the Dispatcher-Servlet. | |
380+
| `spring.boot.admin.monitor.status-interval` | Time interval in milliseconds to check the status of instances. | `10,000ms` |
381+
| `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 |
382+
| `spring.boot.admin.monitor.info-interval` | Time interval in milliseconds to check the info of instances. | `1m` |
383+
| `spring.boot.admin.monitor.info-lifetime` | Lifetime of info in minutes. The info isn't as long the last info isn’t expired. | `1m` |
384+
| `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` |
385+
| `spring.boot.admin.monitor.timeout.*` | Key-value pairs with the timeout per `endpointId`. | Defaults to `default-timeout` value. |
386+
| `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` |
387+
| `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. |
388+
| `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$"` |
389+
| `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"` |
390+
| `spring.boot.admin.instance-proxy.ignored-headers` | Headers not to forwarded when making requests to clients. | `"Cookie", "Set-Cookie", "Authorization"` |
391+
| `spring.boot.admin.ui.title` | The displayed page title. | `"Spring Boot Admin"` |
392+
| `spring.boot.admin.ui.poll-timer.cache` | Polling duration in milliseconds to fetch new cache data. | `2500` |
393+
| `spring.boot.admin.ui.poll-timer.datasource` | Polling duration in milliseconds to fetch new data source data. | `2500` |
394+
| `spring.boot.admin.ui.poll-timer.gc` | Polling duration in milliseconds to fetch new gc data. | `2500` |
395+
| `spring.boot.admin.ui.poll-timer.process` | Polling duration in milliseconds to fetch new process data. | `2500` |
396+
| `spring.boot.admin.ui.poll-timer.memory` | Polling duration in milliseconds to fetch new memory data. | `2500` |
397+
| `spring.boot.admin.ui.poll-timer.threads` | Polling duration in milliseconds to fetch new threads data. | `2500` |
398+
| `spring.boot.admin.ui.poll-timer.logfile` | Polling duration in milliseconds to fetch new logfile data. | `1000` |
399+
| `spring.boot.admin.ui.enable-toasts` | Enables or disables toast notifications. | `false` |
400+
| `spring.boot.admin.ui.title` | Browser's window title value. | "" |
401+
| `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. | "" |
402+
| `management.scheme` | Value that is substituted in the service URL used for accessing the actuator endpoints. | |
403+
| `management.address` | Value that is substituted in the service URL used for accessing the actuator endpoints. | |
404+
| `management.port` | Value that is substituted in the service URL used for accessing the actuator endpoints. | |
405+
| `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}` |
406+
| `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}` |
407+
| `spring.boot.admin.discovery.enabled` | Enables the `DiscoveryClient` support for the admin server. | `true` |
408+
| `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` |
409+
| `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"` |
410+
| `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*"`. | |
411+
| `spring.boot.admin.discovery.services` | Services included when using discovery and registered as application. Supports simple patterns such as `"foo*"`, `"*bar"`, `"foo*bar*"`. | `"*"` |
412+
| `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"`. | |
413+
| `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"`. | |
414+
415+
### Common configurations
416+
417+
- Logging related configurations:
418+
- [**logging.level.***](https://docs.spring.io/spring-boot/docs/2.1.13.RELEASE/reference/html/boot-features-logging.html#boot-features-custom-log-levels)
419+
- [**logging.group.***](https://docs.spring.io/spring-boot/docs/2.1.13.RELEASE/reference/html/boot-features-logging.html#boot-features-custom-log-groups)
420+
- Any other configurations under `logging.*` namespace should be forbidden. For example, writing log files by using `logging.file` should be forbidden.
355421
356422
## Related content
357423

0 commit comments

Comments
 (0)