Skip to content

Moving the Workflow automation to GA #21252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 12 commits into
base: develop
Choose a base branch
from
Draft

Moving the Workflow automation to GA #21252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
ee75e0d
Moving the Workflow automation to GA
adutta-newrelic Jul 16, 2025
b92877f
Updated the API information
adutta-newrelic Jul 17, 2025
ed387a1
Added destinations and definition schema files
adutta-newrelic Jul 17, 2025
e47fb19
Updated the broken links to the workflow document
adutta-newrelic Jul 21, 2025
d1f9963
Updates made to the nav doc and changed the name of the document
adutta-newrelic Jul 23, 2025
0fb561a
Updates
adutta-newrelic Jul 28, 2025
15aad15
Branching doc
adutta-newrelic Jul 29, 2025
d16e170
Merge branch 'develop' into workflow-automation-lp-to-pp
adutta-newrelic Jul 29, 2025
10bbbc7
usecase
adutta-newrelic Jul 30, 2025
a8f53f2
Removed the branching doc
adutta-newrelic Jul 31, 2025
754f464
Updated and added more files
adutta-newrelic Aug 5, 2025
d77b84d
Updated additional steps
adutta-newrelic Aug 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
288 changes: 288 additions & 0 deletions ...ntent/docs/workflow-automation/create-a-workflow-automation/create-your-own.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,288 @@
---
title: Create your own customised workflow
tags:
- workflow automation
- create your own workflow
- build a workflow using New Relic
metaDescription: "Create your own customised workflow using New Relic"
freshnessValidatedDate: never
---

<Callout title="preview">
We're still working on this feature, but we'd love for you to try it out!

This feature is currently provided as part of a preview program pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy).
</Callout>

The [Create Your Own](https://onenr.io/0OQM47KgxjG) feature in Workflow Automation enables you to build custom workflows that meet your specific requirements. With a drag-and-drop interface, you can combine various actions to construct workflows. A library of pre-built [actions](/docs/workflow-automation/setup-and-configuration/actions-catalog) is available to facilitate deployment.

Let's explore how a workflow operates by building a simple one from scratch using the example below, the goal is to automate provisioning, scaling, and termination of an EC2 instances for optimal performance and cost efficiency. The workflow's primary goal is to get user approval to resize an EC2 instance that is experiencing high CPU utilization and then execute the resize automatically using AWS Systems Manager.

## Workflow inputs

This workflow requires the following input parameters, many of which are securely retrieved from a [secrets manager](/docs/infrastructure/host-integrations/installation/secrets-management/).

<table>
<thead>
<tr>
<th style={{ width: "200px" }}>
**Parameter name**
</th>
<th>
**Type**
</th>
<th>
**Default value**
</th>
<th>
**Description**
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`awsAccessKeyId`
</td>
<td>
String
</td>
<td>
`${{ :secrets:awsAccessKeyId }}`
</td>
<td>
AWS Access Key ID for authentication.
</td>
</tr>
<tr>
<td>
`awsSecretAccessKey`
</td>
<td>
String
</td>
<td>
`${{ :secrets:awsSecretAccessKey }}`
</td>
<td>
AWS Secret Access Key for authentication.
</td>
</tr>
<tr>
<td>
`awsSessionToken`
</td>
<td>
String
</td>
<td>
`${{ :secrets:awsSessionToken }}`
</td>
<td>
AWS Session Token for temporary credentials.
</td>
</tr>
<tr>
<td>
`slackToken`
</td>
<td>
String
</td>
<td>
`${{ :secrets:slackToken }}`
</td>
<td>
Slack token for API interactions.
</td>
</tr>
<tr>
<td>
`accountId`
</td>
<td>
Int
</td>
<td>

</td>
<td>
The New Relic account ID to query.
</td>
</tr>
<tr>
<td>
`issueId`
</td>
<td>
String
</td>
<td>

</td>
<td>
The ID of the New Relic AI issue that triggered the workflow.
</td>
</tr>
<tr>
<td>
`awsRegion`
</td>
<td>
String
</td>
<td>
`us-east-2`
</td>
<td>
The AWS region where the EC2 instance is located.
</td>
</tr>
<tr>
<td>
`InstanceType`
</td>
<td>
String
</td>
<td>
`t4g.nano`
</td>
<td>
The new EC2 instance type for resizing.
</td>
</tr>
<tr>
<td>
`timestampUnit`
</td>
<td>
String
</td>
<td>

</td>
<td>
The unit for the timestamp from the alert.
</td>
</tr>
<tr>
<td>
`timezoneId`
</td>
<td>
String
</td>
<td>
`America/Los_Angeles`
</td>
<td>
The timezone for displaying the alert activation time.
</td>
</tr>
<tr>
<td>
`pattern`
</td>
<td>
String
</td>
<td>
`MM-dd-yyyy HH:mm`
</td>
<td>
The format pattern for the displayed datetime.
</td>
</tr>
<tr>
<td>
`channel`
</td>
<td>
String
</td>
<td>

</td>
<td>
The Slack channel ID to send messages to.
</td>
</tr>
</tbody>
</table>

## Workflow execution flow

The workflow follows a sequential path that includes a user-driven approval process and conditional branching to handle various outcomes.

<Steps>
<Step>
### Initial data gathering

* **`getAlertDetails`**: Queries the New Relic NerdGraph API to retrieve detailed information about the triggered alert, including the activation time, condition name, and the entity GUIDs of the impacted resources.
* **`activatedDateTime`**: Converts the `activatedAt` timestamp from the alert details into a human-readable date and time format for display in a Slack message.
* **`impactedEC2Instance`**: Queries the New Relic NRDB (New Relic Database) to retrieve the specific EC2 instance ID and its current instance type based on the entity GUID from the alert.

<img
title="Image of initial data gathering"
alt="Image of initial data gathering"
src="/images/initial-data-gathering.webp"
/>
</Step>

<Step>
### User approval process

* **`IssueDetected`**: Posts an initial message to a specified Slack channel, notifying the team of the high CPU utilization on the detected EC2 instance. The message requests confirmation to resize the instance and provides instructions to react with a `:+1:` (approve) or `:-1:` (cancel).
* **`GetUserReaction`**: Pauses the workflow for up to 300 seconds, waiting for a user to react to the message in Slack.
* (Switch)**: Evaluates the reactions to the Slack message using a conditional switch:
* **Condition `1`**: If a user reacts with `:+1:`, the workflow proceeds to `gotYesReaction`.
* **Condition `2`**: If a user reacts with `:-1:`, the workflow proceeds to `gotCancelReaction`.
* **Condition `3`**: If the user reacts with any other emoji, the workflow proceeds to `unexpectedReaction`, redirecting the user to provide a valid reaction using the `GetUserReaction` step.

<img
title="Image of user approval process"
alt="Image of user approval process"
src="/images/user-approval-process.webp"
/>
</Step>

<Step>
### Handling user responses

* **`unexpectedReaction`**: If an unexpected reaction is detected, the workflow sends a message to the Slack thread, informs the user, and loops back to `GetUserReaction`, waiting for a valid reaction again.
* **`gotCancelReaction`**: If the user reacts with `:-1:`, the workflow sends a cancellation message to the Slack thread and proceeds to `workflowCompleted`.
* **`gotYesReaction`**: If the user reacts with `:+1:`, the workflow sends a confirmation message to the Slack thread and proceeds to the resizing steps.
</Step>

<Step>
### EC2 resizing and automation

* **`createSsmDocument`**: A critical step in which the workflow dynamically writes an AWS Systems Manager (SSM) Automation document. This document contains a set of sequential steps to:
* Stop the EC2 instance.
* Wait for the instance to be in the `stopped` state.
* Modify the instance type.
* Start the instance.
* Wait for the instance to be in the `running` state.
* **`generateIdempotencyToken`**: A UUID is generated to serve as an idempotency token for the SSM Automation execution, ensuring the process is not duplicated.
* **`startResizing`**: The workflow initiates the newly created SSM Automation document, passing the EC2 instance ID and the new instance type as parameters.
* **`progressLoop` (Loop)**: A loop runs five times, with a 10-second wait between each iteration. During each iteration, a "resizing in progress" message is posted to the Slack thread to provide status updates.
* **`waitForCompletion`**: The workflow waits for the SSM Automation execution to complete, with a timeout of 120 seconds.
</Step>

<Step>
### Final status and cleanup

* **`hasCompleted` (Switch)**: After the SSM Automation finishes, this switch checks the final execution status:
* **Condition `Failed`**: Proceeds to `displayError`.
* **Condition `Success`**: Proceeds to `displaySuccess`.
* **Condition (Other)**: Proceeds to `displayUnexpected`.
* **`displayUnexpected`**: Logs an unexpected status message to New Relic Logs and proceeds to `cleanupSsmDocument`.
* **`displaySuccess`**: Logs a success message to New Relic Logs and proceeds to `sendSuccessMessage`.
* **`sendSuccessMessage`**: Sends a final success confirmation message to the Slack thread.
* **`displayError`**: Logs an error message to New Relic Logs and proceeds to `cleanupSsmDocument`.
* **`cleanupSsmDocument`**: The dynamically created SSM document is deleted from AWS to avoid clutter.
* **`sendSSMCleanMessage`**: A final message is sent to Slack, confirming that the SSM document has been cleaned up.
* **`workflowCompleted`**: The workflow sends a final message to the Slack thread, confirming that the entire automation process has been completed successfully.
</Step>
</Steps>
88 changes: 88 additions & 0 deletions ...ent/docs/workflow-automation/create-a-workflow-automation/managing-workflow.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
---
title: Managing Workflow Automation
tags:
- Workflow Automation
- workflow
- build a workflow using New Relic
metaDescription: "Build a Workflow Automation with New Relic"
freshnessValidatedDate: never
---

<Callout title="preview">
We're still working on this feature, but we'd love for you to try it out!

This feature is currently provided as part of a preview program pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy).
</Callout>

The Workflow Automation feature in New Relic enables you to build complex workflows for the tools and services you use. It allows you to automate tasks, integrate with third-party services, and respond to events within your New Relic account.

You can create or edit workflows from the [Workflow Automation page](https://onenr.io/0gR7XE8LXjo). This page provides comprehensive information about all workflows created in your account, including the workflow name, description, status, and version number.

You can create a Workflow Automation using one of the available templates or your own custom workflow and add actions to meet your requirements. For more information, refer

* [Use a template](#use-a-template)
* [Create your own](#create-your-own)

## Prerequisites

An active New Relic account with access to the Workflow Automation.

## Use a template [#use-a-template]

To create a Workflow Automation [using a template](/docs/workflow-automation/create-a-workflow-automation/use-a-template):

1. Go to **[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > Workflow Automation**. Click **Use template** to start your workflow setup.
2. In the **All Templates** section, select the desired template and click **Use template**. You can use **Preview** to examine the template before proceeding.
3. Configure the Workflow Automation with the required steps as per the template instructions.
4. Click **Save**.
5. In the **Save workflow** dialog box:
* Enter a name and description for your Workflow Automation.
* In the **Configure inputs** section:
* Add a name for each input.
* Select the **Type** from the dropdown list.
6. Select **Create** to finalize the workflow setup and click **Run**.
7. In the **Run workflow** dialog box, enter the required parameters and click **Start**.
8. Click **View logs** to view the logs of the Workflow Automation. For more information about log management, see [Get started with log management](/docs/logs/get-started/get-started-log-management).

## Create your own Workflow Automation [#create-your-own]

[Need to update the content](/docs/workflow-automation/create-a-workflow-automation/create-your-own)

## Update a Workflow Automation

You can update your existing Workflow Automation, duplicate the Workflow Automation, or delete an existing Workflow Automation using the more options menu (three vertical dots):

**To update a Workflow Automation:**

1. Log in to your New Relic account.
2. Go to the **left navigation pane > Workflow Automation**.
3. Select the required Workflow Automation, click the more options menu (three vertical dots) next to the workflow name.

<table>
<thead>
<tr>
<th>Options</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Edit</td>
<td>To update the existing name and description of the Workflow Automation.</td>
</tr>
<tr>
<td>Duplicate</td>
<td>To duplicate the selected Workflow Automation.</td>
</tr>
<tr>
<td>Delete</td>
<td>To delete the selected Workflow Automation.</td>
</tr>
</tbody>
</table>

<img
title="How to configure a workflow"
alt="Image of how to configure a workflow"
src="/images/workflow-automation-summary.webp"
/>
Loading
Loading