-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
290 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -129,10 +129,10 @@ [email protected] | |
| |=== | ||
|
|
||
| [[pagerduty-notifications]] | ||
| ==== Pagerduty notifications ==== | ||
| To enable pagerduty notifications you just have to add a generic service to your pagerduty-account and set `spring.boot.admin.notify.pagerduty.service-key` to the service-key you received. | ||
| ==== PagerDuty notifications ==== | ||
| To enable https://www.pagerduty.com/[PagerDuty] notifications you just have to add a generic service to your PagerDuty-account and set `spring.boot.admin.notify.pagerduty.service-key` to the service-key you received. | ||
|
|
||
| .Pagerduty notifications configuration options | ||
| .PagerDuty notifications configuration options | ||
| |=== | ||
| | Property name |Description |Default value | ||
|
|
||
|
|
@@ -145,7 +145,7 @@ To enable pagerduty notifications you just have to add a generic service to your | |
| | `"UNKNOWN:UP"` | ||
|
|
||
| | spring.boot.admin.notify.pagerduty.service-key | ||
| | Service-key to use for Pagerduty | ||
| | Service-key to use for PagerDuty | ||
| | | ||
|
|
||
| | spring.boot.admin.notify.pagerduty.url | ||
|
|
@@ -168,7 +168,7 @@ To enable pagerduty notifications you just have to add a generic service to your | |
|
|
||
| [[opsgenie-notifications]] | ||
| ==== OpsGenie notifications ==== | ||
| To enable OpsGenie notifications you just have to add a new JSON Rest API integration to your OpsGenie account and set `spring.boot.admin.notify.opsgenie.api-key` to the apiKey you received. | ||
| To enable https://www.opsgenie.com/[OpsGenie] notifications you just have to add a new JSON Rest API integration to your OpsGenie account and set `spring.boot.admin.notify.opsgenie.api-key` to the apiKey you received. | ||
|
|
||
| .OpsGenie notifications configuration options | ||
| |=== | ||
|
|
@@ -221,7 +221,7 @@ To enable OpsGenie notifications you just have to add a new JSON Rest API integr | |
|
|
||
| [hipchat-notifications] | ||
| ==== Hipchat notifications ==== | ||
| To enable Hipchat notifications you need to create an API token from you Hipchat account and set the appropriate configuration properties. | ||
| To enable https://www.hipchat.com/[Hipchat] notifications you need to create an API token from you Hipchat account and set the appropriate configuration properties. | ||
|
|
||
| .Hipchat notifications configuration options | ||
| |=== | ||
|
|
@@ -259,7 +259,7 @@ To enable Hipchat notifications you need to create an API token from you Hipchat | |
|
|
||
| [slack-notifications] | ||
| ==== Slack notifications ==== | ||
| To enable Slack notifications you need to add a incoming Webhook under custom integrations on your Slack | ||
| To enable https://slack.com/[Slack] notifications you need to add a incoming Webhook under custom integrations on your Slack | ||
| account and configure it appropriately. | ||
|
|
||
| .Slack notifications configuration options | ||
|
|
@@ -298,7 +298,7 @@ account and configure it appropriately. | |
|
|
||
| [letschat-notifications] | ||
| ==== Let's Chat notifications ==== | ||
| To enable Let's Chat notifications you need to add the host url and add the API token and username from Let's Chat | ||
| To enable https://sdelements.github.io/lets-chat/[Let's Chat] notifications you need to add the host url and add the API token and username from Let's Chat | ||
|
|
||
| .Let's Chat notifications configuration options | ||
| |=== | ||
|
|
@@ -353,4 +353,37 @@ To enable Microsoft Teams notifications you need to setup a connector webhook ur | |
| | spring.boot.admin.notify.ms-teams.* | ||
| | There are several options to customize the message title and color | ||
| | | ||
| |=== | ||
|
|
||
| [telegram-notifications] | ||
| ==== Telegram notifications ==== | ||
| To enable https://telegram.org/[Telegram] notifications you need to create and authorize a telegram bot and set the appropriate configuration properties for auth-token and chat-id. | ||
|
|
||
| .Microsoft Teams notifications configuration options | ||
| |=== | ||
| | Property name |Description |Default value | ||
|
|
||
| | spring.boot.admin.notify.telegram.enabled | ||
| | Enable Microsoft Teams notifications | ||
| | `true` | ||
|
|
||
| | spring.boot.admin.notify.telegram.auth-token | ||
| | The token identifiying und authorizing your Telegram bot (e.g. `123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11`). | ||
| | | ||
|
|
||
| | spring.boot.admin.notify.telegram.chat-id | ||
| | Unique identifier for the target chat or username of the target channel | ||
| | | ||
|
|
||
| | spring.boot.admin.notify.telegram.disable-notify | ||
| | If true users will receive a notification with no sound. | ||
| | `false` | ||
|
|
||
| | spring.boot.admin.notify.telegram.parse_mode | ||
| | The parsing mode for the sent message. Currently ``HTML'` and `'Markdown'` are supported. | ||
| | `'HTML'` | ||
|
|
||
| | spring.boot.admin.notify.telegram.message | ||
| | Text to send. SpEL-expressions are supported. | ||
| | `+++"<strong>#{application.name}</strong>/#{application.id} is <strong>#{to.status}</strong>"+++` | ||
| |=== | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
145 changes: 145 additions & 0 deletions
145
...ng-boot-admin-server/src/main/java/de/codecentric/boot/admin/notify/TelegramNotifier.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| /* | ||
| * Copyright 2014-2017 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package de.codecentric.boot.admin.notify; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
|
|
||
| import org.springframework.boot.web.client.RestTemplateBuilder; | ||
| import org.springframework.expression.Expression; | ||
| import org.springframework.expression.ParserContext; | ||
| import org.springframework.expression.spel.standard.SpelExpressionParser; | ||
| import org.springframework.web.client.RestTemplate; | ||
|
|
||
| import de.codecentric.boot.admin.event.ClientApplicationEvent; | ||
|
|
||
| /** | ||
| * Notifier submitting events to Telegram. | ||
| */ | ||
| public class TelegramNotifier extends AbstractStatusChangeNotifier { | ||
| private static final String DEFAULT_MESSAGE = "<strong>#{application.name}</strong>/#{application.id} is <strong>#{to.status}</strong>"; | ||
| private final SpelExpressionParser parser = new SpelExpressionParser(); | ||
| private RestTemplate restTemplate = new RestTemplate(); | ||
|
|
||
| /** | ||
| * base url for telegram (i.e. https://api.telegram.org) | ||
| */ | ||
| private String apiUrl = "https://api.telegram.org"; | ||
|
|
||
| /** | ||
| * Unique identifier for the target chat or username of the target channel | ||
| */ | ||
| private String chatId; | ||
|
|
||
| /** | ||
| * The token identifiying und authorizing your Telegram bot (e.g. `123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11`) | ||
| */ | ||
| private String authToken; | ||
|
|
||
| /** | ||
| * Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or | ||
| * inline URLs in your bot's message. | ||
| */ | ||
| private String parse_mode = "HTML"; | ||
|
|
||
| /** | ||
| * If true users will receive a notification with no sound. | ||
| */ | ||
| private boolean disableNotify = false; | ||
|
|
||
| private Expression message; | ||
|
|
||
| public TelegramNotifier() { | ||
| this.message = parser.parseExpression(DEFAULT_MESSAGE, ParserContext.TEMPLATE_EXPRESSION); | ||
| } | ||
|
|
||
| @Override | ||
| protected void doNotify(ClientApplicationEvent event) { | ||
| restTemplate.getForObject(buildUrl(), Void.class, createMessage(event)); | ||
| } | ||
|
|
||
| protected String buildUrl() { | ||
| return String.format( | ||
| "%s/bot%s/sendmessage?chat_id={chat_id}&text={text}&parse_mode={parse_mode}" | ||
| + "&disable_notification={disable_notification}", | ||
| this.apiUrl, this.authToken); | ||
| } | ||
|
|
||
| private Map<String, Object> createMessage(ClientApplicationEvent event) { | ||
| Map<String, Object> parameters = new HashMap<>(); | ||
| parameters.put("chat_id", this.chatId); | ||
| parameters.put("parse_mode", this.parse_mode); | ||
| parameters.put("disable_notification", this.disableNotify); | ||
| parameters.put("text", getText(event)); | ||
| return parameters; | ||
| } | ||
|
|
||
| protected String getText(ClientApplicationEvent event) { | ||
| return message.getValue(event, String.class); | ||
| } | ||
|
|
||
| public void setRestTemplate(RestTemplate restTemplate) { | ||
| this.restTemplate = restTemplate; | ||
| } | ||
|
|
||
| public void setRestTemplate(RestTemplateBuilder builder) { | ||
| this.restTemplate = builder.build(); | ||
| } | ||
|
|
||
| public String getApiUrl() { | ||
| return apiUrl; | ||
| } | ||
|
|
||
| public void setApiUrl(String apiUrl) { | ||
| this.apiUrl = apiUrl; | ||
| } | ||
|
|
||
| public String getChatId() { | ||
| return chatId; | ||
| } | ||
|
|
||
| public void setChatId(String chatId) { | ||
| this.chatId = chatId; | ||
| } | ||
|
|
||
| public String getAuthToken() { | ||
| return authToken; | ||
| } | ||
|
|
||
| public void setAuthToken(String authToken) { | ||
| this.authToken = authToken; | ||
| } | ||
|
|
||
| public boolean isDisableNotify() { | ||
| return disableNotify; | ||
| } | ||
|
|
||
| public void setDisableNotify(boolean disableNotify) { | ||
| this.disableNotify = disableNotify; | ||
| } | ||
|
|
||
| public String getParse_mode() { | ||
| return parse_mode; | ||
| } | ||
|
|
||
| public void setParse_mode(String parse_mode) { | ||
| this.parse_mode = parse_mode; | ||
| } | ||
|
|
||
| public void setMessage(String message) { | ||
| this.message = parser.parseExpression(message, ParserContext.TEMPLATE_EXPRESSION); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.