Properties
| Property | Description |
|---|---|
spring.boot.admin.context-path | The context-path prefixes the path where the Admin Servers static assets and api should be served, relative to the Dispatcher-Servlet.
|
spring.boot.admin.monitor.period |
|
spring.boot.admin.notify.mail.cc | cc-recipients of the mail
|
spring.boot.admin.notify.mail.to | recipients of the mail
|
spring.boot.admin.server.enabled | Enable Spring Boot Admin Server Default: true
|
spring.boot.admin.monitor.retries | Number of retries per endpointId. Defaults to default-retry.
|
spring.boot.admin.monitor.timeout | timeout per endpointId. Defaults to default-timeout.
|
spring.boot.admin.notify.mail.from | sender of the change
|
spring.boot.admin.notify.webex.url | base url for Webex API (i.e. https://webexapis.com/v1/messages)
|
spring.boot.admin.probed-endpoints | For Spring Boot 2.x applications the endpoints should be discovered automatically using the actuator links. For Spring Boot 1.x 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).
|
spring.boot.admin.hazelcast.enabled | Enable Hazelcast support.
|
spring.boot.admin.notify.proxy.host | Proxy-Host for sending notifications
|
spring.boot.admin.notify.proxy.port | Proxy-Port for sending notifications
|
spring.boot.admin.notify.slack.icon | Optional emoji icon without colons (i.e. my-emoji)
|
spring.boot.admin.notify.discord.tts | If the message is a text to speech message. False by default.
|
spring.boot.admin.notify.hipchat.url | Base URL for HipChat API (i.e. https://ACCOUNT_NAME.hipchat.com/v2
|
spring.boot.admin.notify.letschat.url | Host URL for Let´s Chat
|
spring.boot.admin.notify.mail.enabled | Enables the notification.
|
spring.boot.admin.notify.opsgenie.url | BASE URL for OpsGenie API
|
spring.boot.admin.monitor.read-timeout |
|
spring.boot.admin.notify.feishu.at-all | @ all.
|
spring.boot.admin.notify.feishu.secret | The secret of the chat group robot from the FeiShu setup.
|
spring.boot.admin.notify.letschat.room | Name of the room
|
spring.boot.admin.notify.mail.base-url | Base-URL used for hyperlinks in mail
|
spring.boot.admin.notify.mail.template | Thymeleaf template for mail
|
spring.boot.admin.notify.opsgenie.tags | Comma separated list of labels attached to the alert
|
spring.boot.admin.notify.opsgenie.user | Default owner of the execution. If user is not specified, the system becomes owner of the execution.
|
spring.boot.admin.notify.pagerduty.url | URI for pagerduty-REST-API
|
spring.boot.admin.notify.slack.channel | Optional channel name without # sign (i.e. somechannel)
|
spring.boot.admin.notify.slack.enabled | Enables the notification.
|
spring.boot.admin.notify.slack.message | Message formatted using Slack markups. SpEL template using event as root
|
spring.boot.admin.notify.webex.enabled | Enables the notification.
|
spring.boot.admin.notify.webex.room-id | Room identifier in Webex where the message will be sent
|
spring.boot.admin.hazelcast.event-store | Name of backing Hazelcast-Map for storing the instance events.
|
spring.boot.admin.instance-auth.enabled | Whether or not to use configuration properties as a source for instance credentials
|
spring.boot.admin.monitor.info-interval | Time interval to check the info of instances,
|
spring.boot.admin.monitor.info-lifetime | Lifetime of info. The info won't be updated as long the last info isn't expired.
|
spring.boot.admin.notify.feishu.enabled | Enables the notification.
|
spring.boot.admin.notify.feishu.message |
|
spring.boot.admin.notify.hipchat.notify | TRUE will cause OS notification, FALSE will only notify to room
|
spring.boot.admin.notify.letschat.token | Token for the Let´s chat API
|
spring.boot.admin.notify.proxy.password | Proxy-Password for sending notifications (if proxy requires authentication).
|
spring.boot.admin.notify.proxy.username | Proxy-User for sending notifications (if proxy requires authentication).
|
spring.boot.admin.notify.rocketchat.url | Host URL for RocketChat server
|
spring.boot.admin.notify.slack.username | Optional username which sends notification
|
spring.boot.admin.notify.dingtalk.secret | Secret for DingTalk.
|
spring.boot.admin.notify.discord.enabled | Enables the notification.
|
spring.boot.admin.notify.discord.message |
|
spring.boot.admin.notify.hipchat.enabled | Enables the notification.
|
spring.boot.admin.notify.hipchat.room-id | Id of the room to notify
|
spring.boot.admin.notify.opsgenie.entity | The entity the alert is related to.
|
spring.boot.admin.notify.opsgenie.source | Field to specify source of alert. By default, it will be assigned to IP address of incoming request
|
spring.boot.admin.monitor.connect-timeout |
|
spring.boot.admin.monitor.default-retries | Default number of retries for failed requests. Individual values for specific endpoints can be overriden using `spring.boot.admin.monitor.retries.*`.
|
spring.boot.admin.monitor.default-timeout | Default timeout when making requests. Individual values for specific endpoints can be overriden using `spring.boot.admin.monitor.timeout.*`.
|
spring.boot.admin.monitor.status-interval | Time interval to check the status of instances, must be greater than 1 second.
|
spring.boot.admin.monitor.status-lifetime | Lifetime of status. The status won't be updated as long the last status isn't expired.
|
spring.boot.admin.notify.dingtalk.enabled | Enables the notification.
|
spring.boot.admin.notify.dingtalk.message |
|
spring.boot.admin.notify.discord.username | Optional username. Default is set in Discord.
|
spring.boot.admin.notify.letschat.enabled | Enables the notification.
|
spring.boot.admin.notify.letschat.message | Message template. SpEL template using event as root
|
spring.boot.admin.notify.ms-teams.enabled | Enables the notification.
|
spring.boot.admin.notify.opsgenie.actions | Comma separated list of actions that can be executed.
|
spring.boot.admin.notify.opsgenie.api-key | Integration ApiKey
|
spring.boot.admin.notify.opsgenie.enabled | Enables the notification.
|
spring.boot.admin.notify.pagerduty.client | Client for pagerduty-REST-API
|
spring.boot.admin.notify.rocketchat.token | Token for RocketChat API
|
spring.boot.admin.notify.telegram.api-url | base url for telegram (i.e. https://api.telegram.org)
|
spring.boot.admin.notify.telegram.chat-id | Unique identifier for the target chat or username of the target channel
|
spring.boot.admin.notify.telegram.enabled | Enables the notification.
|
spring.boot.admin.notify.webex.auth-token | Bearer authentication token for Webex API
|
spring.boot.admin.monitor.info-max-backoff | The maximal backoff for info check retries (retry after error has exponential backoff, minimum backoff is 1 second).
|
spring.boot.admin.notify.feishu.card.title | This is header title.
|
spring.boot.admin.notify.letschat.username | username which sends notification
|
spring.boot.admin.notify.pagerduty.enabled | Enables the notification.
|
spring.boot.admin.notify.slack.webhook-url | Webhook url for Slack API (i.e. https://hooks.slack.com/services/xxx)
|
spring.boot.admin.instance-auth.service-map | Map of instance credentials per registered service name
|
spring.boot.admin.metadata-keys-to-sanitize | The metadata keys which should be sanitized when serializing to json
|
spring.boot.admin.notify.discord.avatar-url | Optional URL to avatar.
|
spring.boot.admin.notify.feishu.webhook-url | Webhook URL for the FeiShu(飞书) chat group API (i.e. https://open.feishu.cn/open-apis/bot/v2/hook/xxx).
|
spring.boot.admin.notify.hipchat.auth-token | API token that has access to notify in the room
|
spring.boot.admin.notify.rocketchat.enabled | Enables the notification.
|
spring.boot.admin.notify.rocketchat.room-id | Room Id to send message
|
spring.boot.admin.notify.rocketchat.user-id | User Id for RocketChat API
|
spring.boot.admin.monitor.status-max-backoff | The maximal backoff for status check retries (retry after error has exponential backoff, minimum backoff is 1 second).
|
spring.boot.admin.notify.discord.webhook-url | Webhook URI for the Discord API (i.e. https://discordapp.com/api/webhooks/{webhook.id}/{webhook.token})
|
spring.boot.admin.notify.feishu.message-type | FeiShu message type: text(文本) interactive(消息卡片)
|
spring.boot.admin.notify.hipchat.description | Trigger description. SpEL template using event as root;
|
spring.boot.admin.notify.mail.ignore-changes | List of changes to ignore. Must be in Format OLD:NEW, for any status use * as wildcard, e.g. *:UP or OFFLINE:*
|
spring.boot.admin.notify.telegram.auth-token | The token identifying und authorizing your Telegram bot (e.g. `123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11`)
|
spring.boot.admin.notify.telegram.parse-mode | Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.
|
spring.boot.admin.notify.dingtalk.webhook-url | Webhook URI for the DingTalk API.
|
spring.boot.admin.notify.ms-teams.theme-color | Theme Color is the color of the accent on the message that appears in Microsoft Teams. Default is Spring Green
|
spring.boot.admin.notify.ms-teams.webhook-url | Webhook url for Microsoft Teams Channel Webhook connector (i.e. ...{webhook-id})
|
spring.boot.admin.notify.pagerduty.client-url | Client-url for pagerduty-REST-API
|
spring.boot.admin.notify.slack.ignore-changes | List of changes to ignore. Must be in Format OLD:NEW, for any status use * as wildcard, e.g. *:UP or OFFLINE:*
|
spring.boot.admin.notify.webex.ignore-changes | List of changes to ignore. Must be in Format OLD:NEW, for any status use * as wildcard, e.g. *:UP or OFFLINE:*
|
spring.boot.admin.hazelcast.sent-notifications | Name of backing Hazelcast-Map for storing the sent notifications.
|
spring.boot.admin.notify.feishu.ignore-changes | List of changes to ignore. Must be in Format OLD:NEW, for any status use * as wildcard, e.g. *:UP or OFFLINE:*
|
spring.boot.admin.notify.pagerduty.description | Trigger description. SpEL template using event as root;
|
spring.boot.admin.notify.pagerduty.service-key | Service-Key for pagerduty-REST-API
|
spring.boot.admin.notify.discord.ignore-changes | List of changes to ignore. Must be in Format OLD:NEW, for any status use * as wildcard, e.g. *:UP or OFFLINE:*
|
spring.boot.admin.notify.hipchat.ignore-changes | List of changes to ignore. Must be in Format OLD:NEW, for any status use * as wildcard, e.g. *:UP or OFFLINE:*
|
spring.boot.admin.instance-auth.default-password | Default userpassword used for authentication to each instance. Individual values for specific instances can be overriden using `spring.boot.admin.instance-auth.service-map.*.user-password`.
|
spring.boot.admin.instance-proxy.ignored-headers | Headers not to be forwarded when making requests to clients.
|
spring.boot.admin.notify.dingtalk.ignore-changes | List of changes to ignore. Must be in Format OLD:NEW, for any status use * as wildcard, e.g. *:UP or OFFLINE:*
|
spring.boot.admin.notify.feishu.card.theme-color |
|
spring.boot.admin.notify.letschat.ignore-changes | List of changes to ignore. Must be in Format OLD:NEW, for any status use * as wildcard, e.g. *:UP or OFFLINE:*
|
spring.boot.admin.notify.ms-teams.ignore-changes | List of changes to ignore. Must be in Format OLD:NEW, for any status use * as wildcard, e.g. *:UP or OFFLINE:*
|
spring.boot.admin.notify.opsgenie.ignore-changes | List of changes to ignore. Must be in Format OLD:NEW, for any status use * as wildcard, e.g. *:UP or OFFLINE:*
|
spring.boot.admin.notify.telegram.disable-notify | If true users will receive a notification with no sound.
|
spring.boot.admin.notify.telegram.ignore-changes | List of changes to ignore. Must be in Format OLD:NEW, for any status use * as wildcard, e.g. *:UP or OFFLINE:*
|
spring.boot.admin.instance-auth.default-user-name | Default username used for authentication to each instance. Individual values for specific instances can be overriden using `spring.boot.admin.instance-auth.service-map.*.user-name`.
|
spring.boot.admin.notify.ms-teams.message-summary | Summary section of every Teams message originating from Spring Boot Admin
|
spring.boot.admin.notify.pagerduty.ignore-changes | List of changes to ignore. Must be in Format OLD:NEW, for any status use * as wildcard, e.g. *:UP or OFFLINE:*
|
spring.boot.admin.notify.ms-teams.registered-title | Title of the Teams message when an app registers
|
spring.boot.admin.notify.rocketchat.ignore-changes | List of changes to ignore. Must be in Format OLD:NEW, for any status use * as wildcard, e.g. *:UP or OFFLINE:*
|
spring.boot.admin.notify.mail.additional-properties | Additional properties to be set for the template
|
spring.boot.admin.notify.ms-teams.de-registered-title | Title of the Teams message when an app de-registers
|
spring.boot.admin.notify.ms-teams.status-changed-title | Title of the Teams message when an app changes status
|
spring.boot.admin.notify.ms-teams.status-activity-subtitle | Message will be used as title of the Activity section of the Teams message when an app changes status
|
spring.boot.admin.notify.ms-teams.register-activity-subtitle | Message will be used as title of the Activity section of the Teams message when an app registers
|
spring.boot.admin.notify.ms-teams.deregister-activity-subtitle | Message will be used as title of the Activity section of the Teams message when an app de-registers.
|