Page Comparison

This guide will walk through everything needed in order to send a slack notification on workflow failures.

Configuring Slack integration

You will first need to configure your Slack integration with FlexDeploy. To do this you will need to create a new Slack bot and save the token to a credential in FlexDeploycreate a FlexDeploy Messaging Account for Slack. To get more information on this you can follow the guide located on our Slack plugin guide. This simple configuration will allow you to send notifications to your specified Slack channel . The bot token and Slack channel name will be used in the event listener groovy script to send the notification.

...

for this bot.

...

We will want to create a new credential with our bot tokenMessaging Account for Slack. We can do this by going to Administration → Security → Credentials. We can create a local credential and save the credential Id as it will be used later in our groovy script.

...

Topology→ Integrations → Messaging. For the Slack provider, the only required property is the Bot Token.

...

Creating an Outgoing Webhook Listener

Now that Slack is integrated with FlexDeploy we will now want to create the event listener Webhook Listener that will process all failed workflow completed Workflow Completed events. To do this we will navigate to the events screen through Administration → Integrations → Events. Once at the events screen we will start by creating the event listener by clicking the Outgoing Webhooks. To create a new Webhook Listener click the Create Listener button.

...

Add a name, event type, and mock payload to our the new event listener. Also remove the default script implementation. The event type will specify what events our new listener will process. We will want to select , in this case the Workflow Completed event type. The mock payload is used in the groovy script editor to give suggestions when accessing the events payload. We will want to select the workflow completed payload here as wellEVENT variable. Set this to the Workflow Completed payload.

Implement the Groovy Script

Our event listener is now Now with the Webhook Listener created, but we do not have any we can add the groovy script added to send our the Slack message. FlexDeploy has several built in Event Webhook Context Variables and Methods Reference that can be used to help you implement exactly what you want in this groovy script. We will be using FlexDeploy’s Slack methods in order to send a notification.

...

...

//Carry out any custom action you wish for this event. Check out the documentation for reference or ideas.
//Optionally filter out events you dont want to execute by returning false on the filter script tab.
def listenerName = "Failed Workflow Notification";
LOG.info("Running listener: ${listenerName}");

def channel = 'testing';
def slackAccountCode = 'SLACK';

//make the workflow complete message and include error data
def message = SLACK.makeWorkflowCompletedMessage(EVENT.payload,true);

//save the tsId so we can reply with the failed logs
def tsId = SLACK.postMessage(slackAccountCode,channel,message);

LOG.setMessage("Posted slack message ${tsId}");

//now get our failed plugin logs and attach them
def streams = FLEXDEPLOY.getPluginLogInputStreams(EVENT.payload.workflowExecutionId);
if(!streams || streams.size() == 0) {
  return;
}

def errorStream = streams.last();

//now attach the logs to our previous message
SLACK.postAttachment(slackAccountCode,channel,errorStream,'Failed logs',tsId);

LOG.setMessage("Posted slack message ${tsId} with logs");

As stated before you will need to add your Slack bot token to a credential within FlexDeploy. We then add this token as well as Slack channel name to the groovy script. We can create a message by simply using FlexDeploy’s built in methods. Then we will simply call our postMessage method and provide the specified information. We also set the log message to easily see what workflow has failed when viewing the event messages.

...

account prior to using this listener.

Implementing the Event Filter

We now have an event listener a Webhook Listener that will send a Slack notification to our specified channel every time a workflow is completed. In order to only send the notification when the workflow execution has failed we will need to implement a filter. This The filter is groovy script that will determine whether or not our event listener Listener will process a given event. To edit the filter we will need to click the filter tab to the left of our script tab. We will now create a groovy script that will return true when we want our listener to process the event and false otherwise.

...

...

def excludedProjects = [795341];

return !"SUCCESS".equals(EVENT.payload.executionStatus) && !excludedProjects.contains(EVENT.payload.project.projectId);

In this example we have also added a list of excluded projects that we do not want our listener to process even if the workflow execution has failed. The return value will check our event payload for the execution status. If the execution status is SUCCESS, or if the project Id of the workflow execution is in our excluded projects list we will return false. You can edit this filter to cater to your needs. For example, you can edit the return statement to only return true only if the workflow was a deployment and it failed when trying to deploy to Production.

Viewing

...

Outgoing Webhook Messages

Now that we have our event listener Webhook Listener completely set up we will create a workflow that will fail and attempt to execute it. In order to see if our filter is working correctly we will view our event messages after executing our faulty workflow. This can be found by clicking the Event Outgoing Webhook Messages button on the main events page.

...