Allows Proxy-Settings for Notifiers

closes codecentric#423

Author: Daniel Reuter

spring-boot-admin-docs/src/main/asciidoc/server-notifications.adoc

@@ -1,55 +1,5 @@
 === Notifications ===
 
-
-[[reminder-notifications]]
-==== Reminder Notifications ====
-The `RemindingNotifier` sends reminders for down/offline applications, it delegates the sending of notifications to another notifier.
-
-By default a reminder is triggered when a registered application changes to `DOWN` or `OFFLINE`. You can alter this behaviour via `setReminderStatuses()`. The reminder ends when either the status changes to a non-triggering status or the regarding application gets deregistered.
-
-By default the reminders are sent every 10 minutes, to change this use `setReminderPeriod()`. The `RemindingNotifier` itself doesn't start the background thread to send the reminders, you need to take care of this as shown in the given example below;
-
-.How to configure reminders
-[source,java]
-----
-@Configuration
-public class NotifierConfiguration {
- @Autowired
- private Notifier notifier;
-
- @Primary
- @Bean(initMethod = "start", destroyMethod = "stop")
- public RemindingNotifier remindingNotifier() {
- RemindingNotifier notifier = new RemindingNotifier(notifier, repository);
- notifier.setReminderPeriod(Duration.ofMinutes(10)); // <1>
- notifier.setCheckReminderInverval(Duration.ofSeconds(10)); //<2>
- return notifier;
- }
-}
-----
-<1> The reminders will be sent every 10 minutes.
-<2> Schedules sending of due reminders every 10 seconds.
-
-
-[[filtering-notifications]]
-==== Filtering Notifications ====
-The `FilteringNotifier` allows you to filter certain notification based on rules you can add/remove at runtime. It delegates the sending of notifications to another notifier.
-
-If you add a `FilteringNotifier` to your `ApplicationContext` a RESTful interface on `notifications/filter` gets available.
-
-This notifier is useful if you don't want receive notifications when deploying your applications. Before stopping the application you can add an (expiring) filter either via a `POST` request.
-
-.How to configure filtering
-[source,java,indent=0]
-----
-include::{samples-dir}/spring-boot-admin-sample-servlet/src/main/java/de/codecentric/boot/admin/NotifierConfig.java[tags=configuration-filtering-notifier]
-----
-<1> Add the `FilteringNotifier` bean using a delegate (e.g. `MailNotifier` when configured)
-<2> Add the `RemindingNotifier` as primary bean using the `FilteringNotifier` as delegate.
-
-TIP: This example combines the reminding and filtering notifiers. This allows you to get notifications after the deployed application hasn't restarted in a certain amount of time (until the filter expires).
-
-
 [[mail-notifications]]
 ==== Mail Notifications ====
 
@@ -411,3 +361,70 @@ To enable Discord notifications you need to create a webhook and set the appropr
 | Text to send. SpEL-expressions are supported.
 | `+++"*#{instance.registration.name}* (#{instance.id}) is *#{event.statusInfo.status}*"+++`
 |===
+
+
+[[notification-proxy]]
+==== Notification Proxy Settings ====
+All Notifiers which are using a `RestTemplate` can be configured to use a proxy.
+
+.Notification Proxy configuration options
+|===
+| Property name |Description |Default value
+
+| spring.boot.admin.notify.proxy.host
+| The proxy host
+|
+
+| spring.boot.admin.notify.proxy.port
+| The proxy port
+|
+|===
+
+
+[[reminder-notifications]]
+==== Notification Reminder ====
+The `RemindingNotifier` sends reminders for down/offline applications, it delegates the sending of notifications to another notifier.
+
+By default a reminder is triggered when a registered application changes to `DOWN` or `OFFLINE`. You can alter this behaviour via `setReminderStatuses()`. The reminder ends when either the status changes to a non-triggering status or the regarding application gets deregistered.
+
+By default the reminders are sent every 10 minutes, to change this use `setReminderPeriod()`. The `RemindingNotifier` itself doesn't start the background thread to send the reminders, you need to take care of this as shown in the given example below;
+
+.How to configure reminders
+[source,java]
+----
+@Configuration
+public class NotifierConfiguration {
+ @Autowired
+ private Notifier notifier;
+
+ @Primary
+ @Bean(initMethod = "start", destroyMethod = "stop")
+ public RemindingNotifier remindingNotifier() {
+ RemindingNotifier notifier = new RemindingNotifier(notifier, repository);
+ notifier.setReminderPeriod(Duration.ofMinutes(10)); // <1>
+ notifier.setCheckReminderInverval(Duration.ofSeconds(10)); //<2>
+ return notifier;
+ }
+}
+----
+<1> The reminders will be sent every 10 minutes.
+<2> Schedules sending of due reminders every 10 seconds.
+
+
+[[filtering-notifications]]
+==== Filtering Notifications ====
+The `FilteringNotifier` allows you to filter certain notification based on rules you can add/remove at runtime. It delegates the sending of notifications to another notifier.
+
+If you add a `FilteringNotifier` to your `ApplicationContext` a RESTful interface on `notifications/filter` gets available.
+
+This notifier is useful if you don't want receive notifications when deploying your applications. Before stopping the application you can add an (expiring) filter either via a `POST` request.
+
+.How to configure filtering
+[source,java,indent=0]
+----
+include::{samples-dir}/spring-boot-admin-sample-servlet/src/main/java/de/codecentric/boot/admin/NotifierConfig.java[tags=configuration-filtering-notifier]
+----
+<1> Add the `FilteringNotifier` bean using a delegate (e.g. `MailNotifier` when configured)
+<2> Add the `RemindingNotifier` as primary bean using the `FilteringNotifier` as delegate.
+
+TIP: This example combines the reminding and filtering notifiers. This allows you to get notifications after the deployed application hasn't restarted in a certain amount of time (until the filter expires).

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/config/AdminServerNotifierAutoConfiguration.java

@@ -26,13 +26,16 @@
 import de.codecentric.boot.admin.server.notify.MicrosoftTeamsNotifier;
 import de.codecentric.boot.admin.server.notify.NotificationTrigger;
 import de.codecentric.boot.admin.server.notify.Notifier;
+import de.codecentric.boot.admin.server.notify.NotifierProxyProperties;
 import de.codecentric.boot.admin.server.notify.OpsGenieNotifier;
 import de.codecentric.boot.admin.server.notify.PagerdutyNotifier;
 import de.codecentric.boot.admin.server.notify.SlackNotifier;
 import de.codecentric.boot.admin.server.notify.TelegramNotifier;
 import de.codecentric.boot.admin.server.notify.filter.FilteringNotifier;
 import de.codecentric.boot.admin.server.notify.filter.web.NotificationFilterController;
 
+import java.net.InetSocketAddress;
+import java.net.Proxy;
 import java.nio.charset.StandardCharsets;
 import java.util.List;
 import org.reactivestreams.Publisher;
@@ -45,19 +48,23 @@
 import org.springframework.boot.autoconfigure.condition.NoneNestedConditions;
 import org.springframework.boot.autoconfigure.mail.MailSenderAutoConfiguration;
 import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.ApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Conditional;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Primary;
+import org.springframework.http.client.SimpleClientHttpRequestFactory;
 import org.springframework.mail.MailSender;
 import org.springframework.mail.javamail.JavaMailSender;
+import org.springframework.web.client.RestTemplate;
 import org.thymeleaf.TemplateEngine;
 import org.thymeleaf.spring5.SpringTemplateEngine;
 import org.thymeleaf.spring5.templateresolver.SpringResourceTemplateResolver;
 import org.thymeleaf.templatemode.TemplateMode;
 
 @Configuration(proxyBeanMethods = false)
+@EnableConfigurationProperties(NotifierProxyProperties.class)
 @AutoConfigureAfter({MailSenderAutoConfiguration.class})
 public class AdminServerNotifierAutoConfiguration {
 
@@ -152,8 +159,8 @@ public static class HipchatNotifierConfiguration {
  @Bean
  @ConditionalOnMissingBean
  @ConfigurationProperties("spring.boot.admin.notify.hipchat")
- public HipchatNotifier hipchatNotifier(InstanceRepository repository) {
- return new HipchatNotifier(repository);
+ public HipchatNotifier hipchatNotifier(InstanceRepository repository, NotifierProxyProperties proxyProperties) {
+ return new HipchatNotifier(repository, createNotifierRestTemplate(proxyProperties));
  }
  }
 
@@ -167,8 +174,8 @@ public static class SlackNotifierConfiguration {
  @Bean
  @ConditionalOnMissingBean
  @ConfigurationProperties("spring.boot.admin.notify.slack")
- public SlackNotifier slackNotifier(InstanceRepository repository) {
- return new SlackNotifier(repository);
+ public SlackNotifier slackNotifier(InstanceRepository repository, NotifierProxyProperties proxyProperties) {
+ return new SlackNotifier(repository, createNotifierRestTemplate(proxyProperties));
  }
  }
 
@@ -182,8 +189,8 @@ public static class LetsChatNotifierConfiguration {
  @Bean
  @ConditionalOnMissingBean
  @ConfigurationProperties("spring.boot.admin.notify.letschat")
- public LetsChatNotifier letsChatNotifier(InstanceRepository repository) {
- return new LetsChatNotifier(repository);
+ public LetsChatNotifier letsChatNotifier(InstanceRepository repository, NotifierProxyProperties proxyProperties) {
+ return new LetsChatNotifier(repository, createNotifierRestTemplate(proxyProperties));
  }
  }
 
@@ -197,8 +204,8 @@ public static class PagerdutyNotifierConfiguration {
  @Bean
  @ConditionalOnMissingBean
  @ConfigurationProperties("spring.boot.admin.notify.pagerduty")
- public PagerdutyNotifier pagerdutyNotifier(InstanceRepository repository) {
- return new PagerdutyNotifier(repository);
+ public PagerdutyNotifier pagerdutyNotifier(InstanceRepository repository, NotifierProxyProperties proxyProperties) {
+ return new PagerdutyNotifier(repository, createNotifierRestTemplate(proxyProperties));
  }
  }
 
@@ -212,8 +219,8 @@ public static class OpsGenieNotifierConfiguration {
  @Bean
  @ConditionalOnMissingBean
  @ConfigurationProperties("spring.boot.admin.notify.opsgenie")
- public OpsGenieNotifier opsgenieNotifier(InstanceRepository repository) {
- return new OpsGenieNotifier(repository);
+ public OpsGenieNotifier opsgenieNotifier(InstanceRepository repository, NotifierProxyProperties proxyProperties) {
+ return new OpsGenieNotifier(repository, createNotifierRestTemplate(proxyProperties));
  }
  }
 
@@ -227,8 +234,8 @@ public static class MicrosoftTeamsNotifierConfiguration {
  @Bean
  @ConditionalOnMissingBean
  @ConfigurationProperties("spring.boot.admin.notify.ms-teams")
- public MicrosoftTeamsNotifier microsoftTeamsNotifier(InstanceRepository repository) {
- return new MicrosoftTeamsNotifier(repository);
+ public MicrosoftTeamsNotifier microsoftTeamsNotifier(InstanceRepository repository, NotifierProxyProperties proxyProperties) {
+ return new MicrosoftTeamsNotifier(repository, createNotifierRestTemplate(proxyProperties));
  }
  }
 
@@ -242,8 +249,8 @@ public static class TelegramNotifierConfiguration {
  @Bean
  @ConditionalOnMissingBean
  @ConfigurationProperties("spring.boot.admin.notify.telegram")
- public TelegramNotifier telegramNotifier(InstanceRepository repository) {
- return new TelegramNotifier(repository);
+ public TelegramNotifier telegramNotifier(InstanceRepository repository, NotifierProxyProperties proxyProperties) {
+ return new TelegramNotifier(repository, createNotifierRestTemplate(proxyProperties));
  }
  }
 
@@ -257,8 +264,19 @@ public static class DiscordNotifierConfiguration {
  @Bean
  @ConditionalOnMissingBean
  @ConfigurationProperties("spring.boot.admin.notify.discord")
- public DiscordNotifier discordNotifier(InstanceRepository repository) {
- return new DiscordNotifier(repository);
+ public DiscordNotifier discordNotifier(InstanceRepository repository, NotifierProxyProperties proxyProperties) {
+ return new DiscordNotifier(repository, createNotifierRestTemplate(proxyProperties));
  }
  }
+
+ private static RestTemplate createNotifierRestTemplate(NotifierProxyProperties proxyProperties) {
+ RestTemplate restTemplate = new RestTemplate();
+ if (proxyProperties.getHost() != null) {
+ SimpleClientHttpRequestFactory requestFactory = new SimpleClientHttpRequestFactory();
+ Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress(proxyProperties.getHost(), proxyProperties.getPort()));
+ requestFactory.setProxy(proxy);
+ restTemplate.setRequestFactory(requestFactory);
+ }
+ return restTemplate;
+ }
 }

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/notify/DiscordNotifier.java

@@ -44,7 +44,7 @@
 public class DiscordNotifier extends AbstractStatusChangeNotifier {
  private static final String DEFAULT_MESSAGE = "*#{instance.registration.name}* (#{instance.id}) is *#{event.statusInfo.status}*";
  private final SpelExpressionParser parser = new SpelExpressionParser();
- private RestTemplate restTemplate = new RestTemplate();
+ private RestTemplate restTemplate;
  private Expression message;
 
  /**
@@ -70,8 +70,9 @@ public class DiscordNotifier extends AbstractStatusChangeNotifier {
  @Nullable
  private String avatarUrl;
 
- public DiscordNotifier(InstanceRepository repository) {
+ public DiscordNotifier(InstanceRepository repository, RestTemplate restTemplate) {
  super(repository);
+ this.restTemplate = restTemplate;
  this.message = parser.parseExpression(DEFAULT_MESSAGE, ParserContext.TEMPLATE_EXPRESSION);
  }
 

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/notify/HipchatNotifier.java

@@ -47,7 +47,7 @@ public class HipchatNotifier extends AbstractStatusChangeNotifier {
  private static final String DEFAULT_DESCRIPTION = "<strong>#{instance.registration.name}</strong>/#{instance.id} is <strong>#{event.statusInfo.status}</strong>";
 
  private final SpelExpressionParser parser = new SpelExpressionParser();
- private RestTemplate restTemplate = new RestTemplate();
+ private RestTemplate restTemplate;
 
  /**
  * Base URL for HipChat API (i.e. https://ACCOUNT_NAME.hipchat.com/v2
@@ -77,8 +77,9 @@ public class HipchatNotifier extends AbstractStatusChangeNotifier {
  */
  private Expression description;
 
- public HipchatNotifier(InstanceRepository repository) {
+ public HipchatNotifier(InstanceRepository repository, RestTemplate restTemplate) {
  super(repository);
+ this.restTemplate = restTemplate;
  this.description = parser.parseExpression(DEFAULT_DESCRIPTION, ParserContext.TEMPLATE_EXPRESSION);
  }
 

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/notify/LetsChatNotifier.java

@@ -48,7 +48,7 @@ public class LetsChatNotifier extends AbstractStatusChangeNotifier {
  private static final String DEFAULT_MESSAGE = "*#{instance.registration.name}* (#{instance.id}) is *#{event.statusInfo.status}*";
 
  private final SpelExpressionParser parser = new SpelExpressionParser();
- private RestTemplate restTemplate = new RestTemplate();
+ private RestTemplate restTemplate;
 
  /**
  * Host URL for Let´s Chat
@@ -78,8 +78,9 @@ public class LetsChatNotifier extends AbstractStatusChangeNotifier {
  */
  private Expression message;
 
- public LetsChatNotifier(InstanceRepository repository) {
+ public LetsChatNotifier(InstanceRepository repository, RestTemplate restTemplate) {
  super(repository);
+ this.restTemplate = restTemplate;
  this.message = parser.parseExpression(DEFAULT_MESSAGE, ParserContext.TEMPLATE_EXPRESSION);
  }
 

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/notify/MicrosoftTeamsNotifier.java

@@ -47,7 +47,7 @@ public class MicrosoftTeamsNotifier extends AbstractStatusChangeNotifier {
  private static final String HEALTH_URL_KEY = "Health URL";
  private static final String MANAGEMENT_URL_KEY = "Management URL";
  private static final String SOURCE_KEY = "Source";
- private RestTemplate restTemplate = new RestTemplate();
+ private RestTemplate restTemplate;
 
  /**
  * Webhook url for Microsoft Teams Channel Webhook connector (i.e.
@@ -100,8 +100,9 @@ public class MicrosoftTeamsNotifier extends AbstractStatusChangeNotifier {
  */
  private String messageSummary = "Spring Boot Admin Notification";
 
- public MicrosoftTeamsNotifier(InstanceRepository repository) {
+ public MicrosoftTeamsNotifier(InstanceRepository repository, RestTemplate restTemplate) {
  super(repository);
+ this.restTemplate = restTemplate;
  }
 
  @Override

spring-boot-admin-server/src/main/java/de/codecentric/boot/admin/server/notify/NotifierProxyProperties.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2014-2019 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.server.notify;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+@lombok.Data
+@ConfigurationProperties("spring.boot.admin.notify.proxy")
+public class NotifierProxyProperties {
+ /**
+ * Proxy-Host for sending notifications
+ */
+ private String host;
+
+ /**
+ * Proxy-Port for sending notifications
+ */
+ private int port;
+}