Skip to content

Commit b216af7

Browse files
kingzacko1kingzacko1
authored
PagerDuty Notification Improvements (#24504)
* Add customizable incident title and fully configurable incident key * MessageFactory tests * changelog * Remove unused StreamService
1 parent 1927f12 commit b216af7

File tree

12 files changed

+416
-103
lines changed

12 files changed

+416
-103
lines changed

‎changelog/unreleased/issue-24328.toml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
type = "a"
2+
message = "Added multiple PagerDuty Notification improvements: custom incident title, fully customizable incident key, and use Replay Search URL for link instead of generic stream search."
3+
4+
issues = ["24328"]
5+
pulls = ["24504"]

‎graylog2-server/src/main/java/org/graylog/integrations/pagerduty/PagerDutyNotification.java‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
package org.graylog.integrations.pagerduty;
1818

1919
import com.fasterxml.jackson.databind.ObjectMapper;
20+
import jakarta.inject.Inject;
2021
import org.graylog.events.notifications.EventNotification;
2122
import org.graylog.events.notifications.EventNotificationContext;
2223
import org.graylog.events.notifications.EventNotificationException;
@@ -29,8 +30,6 @@
2930
import org.graylog2.notifications.NotificationService;
3031
import org.graylog2.plugin.system.NodeId;
3132

32-
import jakarta.inject.Inject;
33-
3433
import java.io.IOException;
3534
import java.util.List;
3635
import java.util.Locale;
@@ -71,7 +70,7 @@ public void execute(EventNotificationContext ctx) throws EventNotificationExcept
7170
try {
7271
PagerDutyResponse response = pagerDutyClient.enqueue(payloadString);
7372
List<String> errors = response.getErrors();
74-
if (errors != null && errors.size() > 0) {
73+
if (errors != null && !errors.isEmpty()) {
7574
throw new IllegalStateException(
7675
"There was an error triggering the PagerDuty event, details: " + errors);
7776
}

‎graylog2-server/src/main/java/org/graylog/integrations/pagerduty/PagerDutyNotificationConfig.java‎

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
import com.fasterxml.jackson.annotation.JsonTypeName;
2323
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
2424
import com.google.auto.value.AutoValue;
25+
import jakarta.annotation.Nullable;
2526
import org.graylog.events.contentpack.entities.EventNotificationConfigEntity;
2627
import org.graylog.events.event.EventDto;
2728
import org.graylog.events.notifications.EventNotificationConfig;
@@ -33,6 +34,7 @@
3334

3435
import java.net.URI;
3536
import java.net.URISyntaxException;
37+
import java.util.Optional;
3638

3739
/**
3840
* Configuration class for Pager Duty notifications.
@@ -51,6 +53,8 @@ public abstract class PagerDutyNotificationConfig implements EventNotificationCo
5153
static final String FIELD_KEY_PREFIX = "key_prefix";
5254
static final String FIELD_CLIENT_NAME = "client_name";
5355
static final String FIELD_CLIENT_URL = "client_url";
56+
static final String FIELD_PAGER_DUTY_TITLE = "pager_duty_title";
57+
static final String FIELD_INCIDENT_KEY = "incident_key";
5458

5559
@JsonProperty(FIELD_ROUTING_KEY)
5660
public abstract String routingKey();
@@ -67,6 +71,12 @@ public abstract class PagerDutyNotificationConfig implements EventNotificationCo
6771
@JsonProperty(FIELD_CLIENT_URL)
6872
public abstract String clientUrl();
6973

74+
@JsonProperty(FIELD_PAGER_DUTY_TITLE)
75+
public abstract Optional<String> pagerDutyTitle();
76+
77+
@JsonProperty(FIELD_INCIDENT_KEY)
78+
public abstract Optional<String> incidentKey();
79+
7080
@JsonIgnore
7181
public JobTriggerData toJobTriggerData(EventDto dto) {
7282
return EventNotificationExecutionJob.Data.builder().eventDto(dto).build();
@@ -87,8 +97,8 @@ public ValidationResult validate() {
8797
else if (routingKey().length() != 32) {
8898
validation.addError(FIELD_ROUTING_KEY, "Routing Key must be 32 characters long.");
8999
}
90-
if (customIncident() && keyPrefix().isEmpty()) {
91-
validation.addError(FIELD_KEY_PREFIX, "Incident Key Prefix cannot be empty when Custom Incident Key is selected.");
100+
if (customIncident() && keyPrefix().isEmpty() && incidentKey().isEmpty()) {
101+
validation.addError(FIELD_KEY_PREFIX, "Incident Key or Incident Key Prefix must be provided when Custom Incident Key is selected.");
92102
}
93103
if (clientName().isEmpty()) {
94104
validation.addError(FIELD_CLIENT_NAME, "Client Name cannot be empty.");
@@ -122,19 +132,25 @@ public static PagerDutyNotificationConfig.Builder create() {
122132
}
123133

124134
@JsonProperty(FIELD_ROUTING_KEY)
125-
public abstract PagerDutyNotificationConfig.Builder routingKey(String routingKey);
135+
public abstract Builder routingKey(String routingKey);
126136

127137
@JsonProperty(FIELD_CUSTOM_INCIDENT)
128-
public abstract PagerDutyNotificationConfig.Builder customIncident(boolean customIncident);
138+
public abstract Builder customIncident(boolean customIncident);
129139

130140
@JsonProperty(FIELD_KEY_PREFIX)
131-
public abstract PagerDutyNotificationConfig.Builder keyPrefix(String keyPrefix);
141+
public abstract Builder keyPrefix(String keyPrefix);
132142

133143
@JsonProperty(FIELD_CLIENT_NAME)
134-
public abstract PagerDutyNotificationConfig.Builder clientName(String clientName);
144+
public abstract Builder clientName(String clientName);
135145

136146
@JsonProperty(FIELD_CLIENT_URL)
137-
public abstract PagerDutyNotificationConfig.Builder clientUrl(String clientUrl);
147+
public abstract Builder clientUrl(String clientUrl);
148+
149+
@JsonProperty(FIELD_PAGER_DUTY_TITLE)
150+
public abstract Builder pagerDutyTitle(@Nullable String pagerDutyTitle);
151+
152+
@JsonProperty(FIELD_INCIDENT_KEY)
153+
public abstract Builder incidentKey(@Nullable String incidentKey);
138154

139155
public abstract PagerDutyNotificationConfig build();
140156
}
@@ -149,6 +165,8 @@ public EventNotificationConfigEntity toContentPackEntity(
149165
.keyPrefix(ValueReference.of(keyPrefix()))
150166
.clientName(ValueReference.of(clientName()))
151167
.clientUrl(ValueReference.of(clientUrl()))
168+
.pagerDutyTitle(ValueReference.ofNullable(pagerDutyTitle().orElse(null)))
169+
.incidentKey(ValueReference.ofNullable(incidentKey().orElse(null)))
152170
.build();
153171
}
154172
}

‎graylog2-server/src/main/java/org/graylog/integrations/pagerduty/PagerDutyNotificationConfigEntity.java‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,14 @@
2121
import com.fasterxml.jackson.annotation.JsonTypeName;
2222
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
2323
import com.google.auto.value.AutoValue;
24+
import jakarta.annotation.Nullable;
2425
import org.graylog.events.contentpack.entities.EventNotificationConfigEntity;
2526
import org.graylog.events.notifications.EventNotificationConfig;
2627
import org.graylog2.contentpacks.model.entities.EntityDescriptor;
2728
import org.graylog2.contentpacks.model.entities.references.ValueReference;
2829

2930
import java.util.Map;
31+
import java.util.Optional;
3032

3133
/**
3234
* Configuration entity for PagerDuty notification events.
@@ -55,6 +57,12 @@ public abstract class PagerDutyNotificationConfigEntity implements EventNotifica
5557
@JsonProperty(PagerDutyNotificationConfig.FIELD_CLIENT_URL)
5658
public abstract ValueReference clientUrl();
5759

60+
@JsonProperty(PagerDutyNotificationConfig.FIELD_PAGER_DUTY_TITLE)
61+
public abstract Optional<ValueReference> pagerDutyTitle();
62+
63+
@JsonProperty(PagerDutyNotificationConfig.FIELD_INCIDENT_KEY)
64+
public abstract Optional<ValueReference> incidentKey();
65+
5866
public static Builder builder() {
5967
return Builder.create();
6068
}
@@ -84,6 +92,12 @@ public static Builder create() {
8492
@JsonProperty(PagerDutyNotificationConfig.FIELD_CLIENT_URL)
8593
public abstract Builder clientUrl(ValueReference clientUrl);
8694

95+
@JsonProperty(PagerDutyNotificationConfig.FIELD_PAGER_DUTY_TITLE)
96+
public abstract Builder pagerDutyTitle(@Nullable ValueReference pagerDutyTitle);
97+
98+
@JsonProperty(PagerDutyNotificationConfig.FIELD_INCIDENT_KEY)
99+
public abstract Builder incidentKey(@Nullable ValueReference incidentKey);
100+
87101
public abstract PagerDutyNotificationConfigEntity build();
88102
}
89103

@@ -97,6 +111,8 @@ public EventNotificationConfig toNativeEntity(
97111
.keyPrefix(keyPrefix().asString(parameters))
98112
.clientName(clientName().asString(parameters))
99113
.clientUrl(clientUrl().asString(parameters))
114+
.pagerDutyTitle(pagerDutyTitle().map(vr -> vr.asString(parameters)).orElse(null))
115+
.incidentKey(incidentKey().map(vr -> vr.asString(parameters)).orElse(null))
100116
.build();
101117
}
102118
}

‎graylog2-server/src/main/java/org/graylog/integrations/pagerduty/client/MessageFactory.java‎

Lines changed: 42 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,21 @@
1616
*/
1717
package org.graylog.integrations.pagerduty.client;
1818

19+
import com.floreysoft.jmte.Engine;
1920
import com.google.common.collect.ImmutableList;
2021
import jakarta.inject.Inject;
21-
import org.apache.commons.lang3.StringUtils;
22+
import jakarta.inject.Named;
23+
import org.apache.commons.lang3.Strings;
2224
import org.graylog.events.notifications.EventNotificationContext;
2325
import org.graylog.events.notifications.EventNotificationModelData;
2426
import org.graylog.events.notifications.EventNotificationService;
25-
import org.graylog.events.processor.EventDefinitionDto;
26-
import org.graylog.events.processor.aggregation.AggregationEventProcessorConfig;
27+
import org.graylog.events.notifications.TemplateModelProvider;
2728
import org.graylog.integrations.pagerduty.PagerDutyNotificationConfig;
2829
import org.graylog.integrations.pagerduty.dto.Link;
2930
import org.graylog.integrations.pagerduty.dto.PagerDutyMessage;
3031
import org.graylog2.plugin.MessageSummary;
31-
import org.graylog2.plugin.streams.Stream;
32-
import org.graylog2.streams.StreamService;
3332
import org.graylog2.web.customization.CustomizationConfig;
33+
import org.joda.time.DateTimeZone;
3434

3535
import java.net.MalformedURLException;
3636
import java.net.URI;
@@ -40,7 +40,6 @@
4040
import java.util.List;
4141
import java.util.Locale;
4242
import java.util.Map;
43-
import java.util.stream.Collectors;
4443

4544
/**
4645
* Factory class for PagerDuty messages, heavily based on the works of the cited authors.
@@ -52,82 +51,82 @@
5251
* @author Edgar Molina
5352
*/
5453
public class MessageFactory {
55-
private static final List<String> PAGER_DUTY_PRIORITIES = Arrays.asList("info", "warning", "critical");
54+
private static final List<String> PAGER_DUTY_PRIORITIES = Arrays.asList("info", "warning", "critical", "critical");
5655

57-
private final StreamService streamService;
5856
private final EventNotificationService eventNotificationService;
5957
private final CustomizationConfig customizationConfig;
58+
private final Engine templateEngine;
59+
private final TemplateModelProvider templateModelProvider;
6060

6161
@Inject
62-
MessageFactory(StreamService streamService, EventNotificationService eventNotificationService,
63-
CustomizationConfig customizationConfig) {
64-
this.streamService = streamService;
62+
MessageFactory(EventNotificationService eventNotificationService,
63+
CustomizationConfig customizationConfig,
64+
@Named("JsonSafe") Engine jsonTemplateEngine,
65+
TemplateModelProvider templateModelProvider) {
6566
this.eventNotificationService = eventNotificationService;
6667
this.customizationConfig = customizationConfig;
68+
this.templateEngine = jsonTemplateEngine;
69+
this.templateModelProvider = templateModelProvider;
6770
}
6871

6972
public PagerDutyMessage createTriggerMessage(EventNotificationContext ctx) {
7073
final ImmutableList<MessageSummary> backlog = eventNotificationService.getBacklogForEvent(ctx);
7174
final EventNotificationModelData modelData = EventNotificationModelData.of(ctx, backlog);
7275
final PagerDutyNotificationConfig config = (PagerDutyNotificationConfig) ctx.notificationConfig();
76+
final Map<String, Object> messageModel = getCustomMessageModel(ctx, backlog);
7377

74-
String eventTitle = modelData.eventDefinitionTitle();
78+
final String eventTitle = config.pagerDutyTitle()
79+
.map(customTitle -> templateEngine.transform(customTitle, messageModel))
80+
.orElse(modelData.eventDefinitionTitle());
7581
String eventPriority = PAGER_DUTY_PRIORITIES.get(0);
7682
int priority = ctx.eventDefinition().get().priority() - 1;
77-
if (priority >= 0 && priority <= 2) {
83+
if (priority >= 0 && priority <= 3) {
7884
eventPriority = PAGER_DUTY_PRIORITIES.get(priority);
7985
}
8086

81-
List<Link> streamLinks =
82-
streamService
83-
.loadByIds(modelData.event().sourceStreams())
84-
.stream()
85-
.map(stream -> buildStreamWithUrl(stream, ctx, config))
86-
.collect(Collectors.toList());
87+
final List<Link> replayLink;
88+
try {
89+
final String replayUrl = Strings.CS.appendIfMissing(
90+
config.clientUrl(), "/") + "alerts/" + modelData.event().id() + "/replay-search";
91+
replayLink = List.of(new Link(new URI(replayUrl).toURL(), "Replay Event"));
92+
} catch (URISyntaxException | MalformedURLException e) {
93+
throw new IllegalStateException("Error when building the event replay URL.", e);
94+
}
8795

8896
String dedupKey = "";
8997
if (config.customIncident()) {
90-
dedupKey = String.format(Locale.ROOT,
91-
"%s/%s/%s", config.keyPrefix(), modelData.event().sourceStreams(), eventTitle);
98+
final String formattedPrefix = templateEngine.transform(config.keyPrefix(), messageModel);
99+
final String prefixedIncidentKey = String.format(Locale.ROOT,
100+
"%s/%s/%s", formattedPrefix, modelData.event().sourceStreams(), eventTitle);
101+
// Use the custom incident key if provided, otherwise fall back to the prefixed key.
102+
dedupKey = config.incidentKey()
103+
.map(incidentKeyTemplate -> templateEngine.transform(incidentKeyTemplate, messageModel))
104+
.orElse(prefixedIncidentKey);
92105
}
93106

94-
95-
Map<String, String> payload = new HashMap<String, String>();
96-
payload.put("summary", modelData.event().message());
107+
Map<String, Object> payload = new HashMap<>();
108+
payload.put("summary", config.pagerDutyTitle()
109+
.map(customTitle -> templateEngine.transform(customTitle, messageModel))
110+
.orElse(modelData.event().message()));
97111
payload.put("source", customizationConfig.productName() + ":" + modelData.event().sourceStreams());
98112
payload.put("severity", eventPriority);
99113
payload.put("timestamp", modelData.event().eventTimestamp().toString());
100114
payload.put("component", "GraylogAlerts");
101115
payload.put("group", modelData.event().sourceStreams().toString());
102116
payload.put("class", "alerts");
117+
payload.put("custom_details", ctx.event().fields());
103118

104119
return new PagerDutyMessage(
105120
config.routingKey(),
106121
"trigger",
107122
dedupKey,
108123
config.clientName(),
109124
config.clientUrl(),
110-
streamLinks,
125+
replayLink,
111126
payload);
112127
}
113128

114-
private Link buildStreamWithUrl(Stream stream, EventNotificationContext ctx, PagerDutyNotificationConfig config) {
115-
final String graylogUrl = config.clientUrl();
116-
String streamUrl =
117-
StringUtils.appendIfMissing(graylogUrl, "/") + "streams/" + stream.getId() + "/search";
118-
119-
if (ctx.eventDefinition().isPresent()) {
120-
EventDefinitionDto eventDefinitionDto = ctx.eventDefinition().get();
121-
if (eventDefinitionDto.config() instanceof AggregationEventProcessorConfig) {
122-
String query =
123-
((AggregationEventProcessorConfig) eventDefinitionDto.config()).query();
124-
streamUrl += "?q=" + query;
125-
}
126-
}
127-
try {
128-
return new Link(new URI(streamUrl).toURL(), stream.getTitle());
129-
} catch (URISyntaxException | MalformedURLException e) {
130-
throw new IllegalStateException("Error when building the stream link URL.", e);
131-
}
129+
private Map<String, Object> getCustomMessageModel(EventNotificationContext ctx, List<MessageSummary> backlog) {
130+
return templateModelProvider.of(ctx, backlog, DateTimeZone.UTC, Map.of("type", PagerDutyNotificationConfig.TYPE_NAME));
132131
}
133132
}

‎graylog2-server/src/main/java/org/graylog/integrations/pagerduty/dto/PagerDutyMessage.java‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818

1919
import com.fasterxml.jackson.annotation.JsonInclude;
2020
import com.fasterxml.jackson.annotation.JsonProperty;
21+
2122
import java.util.List;
2223
import java.util.Map;
2324

@@ -40,7 +41,7 @@ public class PagerDutyMessage {
4041
@JsonProperty("links")
4142
private final List<Link> links;
4243
@JsonProperty("payload")
43-
private final Map<String, String> payload;
44+
private final Map<String, Object> payload;
4445

4546
public PagerDutyMessage(
4647
String routingKey,
@@ -49,7 +50,7 @@ public PagerDutyMessage(
4950
String client,
5051
String clientUrl,
5152
List<Link> links,
52-
Map<String, String> payload) {
53+
Map<String, Object> payload) {
5354
this.routingKey = routingKey;
5455
this.eventAction = eventAction;
5556
this.dedupKey = dedupKey;
@@ -83,7 +84,7 @@ public List<Link> getLinks() {
8384
return links;
8485
}
8586

86-
public Map<String, String> getPayload() {
87+
public Map<String, Object> getPayload() {
8788
return payload;
8889
}
8990
}

0 commit comments

Comments
 (0)