Configurar o componente Admin para Spring em Aplicativos de Contêiner do Azure
O componente gerenciado Admin for Spring oferece uma interface administrativa para aplicativos Web Spring Boot que expõem pontos de extremidade atuadores. Este artigo mostra como configurar e gerenciar seu componente Spring.
Mostrar
Você pode exibir os detalhes de um componente individual pelo nome usando o show comando.
Antes de executar o comando a seguir, substitua os espaços reservados cercados por <> seus valores.
az containerapp env java-component admin-for-spring show \
--environment <ENVIRONMENT_NAME> \
--resource-group <RESOURCE_GROUP> \
--name <JAVA_COMPONENT_NAME>
Atualizar
Você pode atualizar a contagem de réplicas e a configuração de um componente Admin for Spring usando o update comando.
Antes de executar o comando a seguir, substitua os espaços reservados cercados por <> seus valores. As configurações suportadas são listadas na tabela de lista de propriedades.
az containerapp env java-component admin-for-spring update \
--environment <ENVIRONMENT_NAME> \
--resource-group <RESOURCE_GROUP> \
--name <JAVA_COMPONENT_NAME> \
--min-replicas <REPLICA_COUNT> \
--max-replicas <REPLICA_COUNT> \
--configuration <CONFIGURATION_KEY>="<CONFIGURATION_VALUE>"
Listagem
Você pode listar todos os componentes Java registrados usando o list comando.
Antes de executar o comando a seguir, substitua os espaços reservados cercados por <> seus valores.
az containerapp env java-component list \
--environment <ENVIRONMENT_NAME> \
--resource-group <RESOURCE_GROUP>
Desvincular
Para remover uma associação de um aplicativo contêiner, use a --unbind opção.
Antes de executar o comando a seguir, substitua os espaços reservados cercados por <> seus valores.
az containerapp update \
--name <APP_NAME> \
--unbind <JAVA_COMPONENT_NAME> \
--resource-group <RESOURCE_GROUP>
Dependency
Ao usar o componente admin em seu aplicativo de contêiner, você precisa adicionar a seguinte dependência em seu pom.xml arquivo. Substitua o número da versão pela versão mais recente disponível no repositório Maven.
<dependency>
<groupId>de.codecentric</groupId>
<version>3.3.2</version>
<artifactId>spring-boot-admin-starter-client</artifactId>
</dependency>
Propriedades configuráveis
A partir do Spring Boot 2, os pontos de extremidade diferentes de integridade e informações não são expostos por padrão. Você pode expô-los adicionando a seguinte configuração em seu application.properties arquivo.
management.endpoints.web.exposure.include=*
management.endpoint.health.show-details=always
Lista de configuração permitida para o seu Admin for Spring
A lista a seguir detalha as propriedades do componente admin que você pode configurar para seu aplicativo. Você pode encontrar mais detalhes nos documentos do Spring Boot Admin .
| Property name | Description | Default value |
|---|---|---|
spring.boot.admin.server.enabled |
Habilita o Spring Boot Admin Server. | true |
spring.boot.admin.context-path |
O prefixo de caminho onde os ativos estáticos e a API do Admin Server são servidos. Em relação ao Dispatcher-Servlet. | |
spring.boot.admin.monitor.status-interval |
Intervalo de tempo em milissegundos para verificar o status das instâncias. | 10,000ms |
spring.boot.admin.monitor.status-lifetime |
Tempo de vida do status em milissegundos. O status não é atualizado enquanto o último status não tiver expirado. | 10.000 ms |
spring.boot.admin.monitor.info-interval |
Intervalo de tempo em milissegundos para verificar as informações das instâncias. | 1m |
spring.boot.admin.monitor.info-lifetime |
Tempo de vida das informações em minutos. As informações não são tão longas quanto as últimas informações não expiraram. | 1m |
spring.boot.admin.monitor.default-timeout |
Tempo limite padrão ao fazer solicitações. Os valores individuais para pontos de extremidade específicos podem ser substituídos usando spring.boot.admin.monitor.timeout.*. |
10,000 |
spring.boot.admin.monitor.timeout.* |
Emparelhamento chave-valor com o tempo limite por endpointId. |
O valor é default-timeout padronizado. |
spring.boot.admin.monitor.default-retries |
Número padrão de novas tentativas para solicitações com falha. As solicitações que modificam dados (PUT, POST, PATCH, DELETE) nunca são repetidas. Os valores individuais para pontos de extremidade específicos podem ser substituídos usando spring.boot.admin.monitor.retries.*. |
0 |
spring.boot.admin.monitor.retries.* |
Emparelhamento chave-valor com o número de novas tentativas por endpointId. As solicitações que modificam dados (PUT, POST, PATCH, DELETE) nunca são repetidas. |
O valor é default-retries padronizado. |
spring.boot.admin.metadata-keys-to-sanitize |
Valores de metadados para as chaves que correspondem a esses padrões de regex usados para limpar em todas as saídas JSON. A partir do Spring Boot 3, todos os valores do atuador são mascarados por padrão. Para obter mais informações sobre como configurar o processo de deshigienização, consulte (Limpar valores confidenciais). | ".**password$", ".\*secret$", ".\*key$", ".\*token$", ".\*credentials.**", ".*vcap_services$" |
spring.boot.admin.probed-endpoints |
Para aplicativos cliente do Spring Boot 1.x, o Spring Boot Admin investiga os pontos de extremidade especificados usando uma OPTIONS solicitação. Se o caminho for diferente do ID, você poderá especificar esse valor como id:path (por exemplo: health:ping) |
"health", "env", "metrics", "httptrace:trace", "threaddump:dump", "jolokia", "info", "logfile", "refresh", "flyway", "liquibase", "heapdump", "loggers", "auditevents" |
spring.boot.admin.instance-proxy.ignored-headers |
Cabeçalhos que não devem ser encaminhados ao fazer solicitações a clientes. | "Cookie", "Set-Cookie", "Authorization" |
spring.boot.admin.ui.title |
O título da página exibida. | "Spring Boot Admin" |
spring.boot.admin.ui.poll-timer.cache |
Duração da sondagem em milissegundos para buscar novos dados de cache. | 2500 |
spring.boot.admin.ui.poll-timer.datasource |
Duração da sondagem em milissegundos para buscar novos dados da fonte de dados. | 2500 |
spring.boot.admin.ui.poll-timer.gc |
Duração da sondagem em milissegundos para obter novos dados gc. | 2500 |
spring.boot.admin.ui.poll-timer.process |
Duração da sondagem em milissegundos para obter novos dados de processo. | 2500 |
spring.boot.admin.ui.poll-timer.memory |
Duração da sondagem em milissegundos para obter novos dados de memória. | 2500 |
spring.boot.admin.ui.poll-timer.threads |
Duração da sondagem em milissegundos para buscar novos dados de threads. | 2500 |
spring.boot.admin.ui.poll-timer.logfile |
Duração da sondagem em milissegundos para obter novos dados do arquivo de log. | 1000 |
spring.boot.admin.ui.enable-toasts |
Habilita ou desabilita notificações do sistema. | false |
spring.boot.admin.ui.title |
Valor do título da janela do navegador. | "" |
spring.boot.admin.ui.brand |
Código HTML renderizado no cabeçalho de navegação e padrão para o rótulo Spring Boot Admin. Por padrão, o logotipo do Spring Boot Admin é seguido por seu nome. | "" |
management.scheme |
Valor que é substituído na URL de serviço usada para acessar os pontos de extremidade do atuador. | |
management.address |
Valor que é substituído na URL de serviço usada para acessar os pontos de extremidade do atuador. | |
management.port |
Valor que é substituído na URL de serviço usada para acessar os pontos de extremidade do atuador. | |
management.context-path |
Valor que é anexado à URL de serviço usada para acessar os pontos de extremidade do atuador. | ${spring.boot.admin.discovery.converter.management-context-path} |
health.path |
Valor que é anexado à URL de serviço usada para verificação de integridade. Ignorado EurekaServiceInstanceConverterpelo . |
${spring.boot.admin.discovery.converter.health-endpoint} |
spring.boot.admin.discovery.enabled |
Habilita o DiscoveryClient suporte para o servidor de administração. |
true |
spring.boot.admin.discovery.converter.management-context-path |
Valor que é anexado service-url ao do serviço descoberto quando o management-url valor é convertido pelo DefaultServiceInstanceConverter. |
/actuator |
spring.boot.admin.discovery.converter.health-endpoint-path |
Valor que é anexado management-url ao do serviço descoberto quando o health-url valor é convertido pelo DefaultServiceInstanceConverter. |
"health" |
spring.boot.admin.discovery.ignored-services |
Serviços que são ignorados ao usar a descoberta e não registrados como aplicativo. Suporta padrões simples como "foo*", "*bar", "foo*bar*". |
|
spring.boot.admin.discovery.services |
Serviços incluídos ao usar a descoberta e registrados como aplicativo. Suporta padrões simples como "foo*", "*bar", "foo*bar*". |
"*" |
spring.boot.admin.discovery.ignored-instances-metadata |
Serviços ignorados se contiverem pelo menos um item de metadados que corresponda aos padrões nesta lista. Suporta padrões como "discoverable=false". |
|
spring.boot.admin.discovery.instances-metadata |
Serviços incluídos se contiverem pelo menos um item de metadados que corresponda aos padrões na lista. Suporta padrões como "discoverable=true". |
Configurações comuns
- Configurações relacionadas ao registro:
- logging.level.*
- logging.group.*
- Quaisquer outras configurações em
logging.*namespace devem ser proibidas. Por exemplo, escrever arquivos de log usandologging.filedeve ser proibido.