Last updated

Manage Respect Monitoring

You can subscribe to notifications by Arazzo workflow, to receive a message when an API included in the Arazzo workflow does not pass the criteria checks. You can also archive old workflows, so they do not clutter the Respect Monitoring page, allowing you to focus on active workflows.

Before you begin

Make sure you have the following before you begin:

  • Realm owner organization role
  • If you are configuring Slack notifications:
    • Slack Workspace owner permissions
    • The name of the public channel you plan to use
  • Arazzo Description in project
  • A job configuration in your redocly.yaml file

Subscribe to notifications

Get Respect Monitoring incident updates and maintenance status updates sent directly to you. You can select what severity level events you want reported in the notifications. You can subscribe to Slack or email notifications.

Subscribe to Slack notifications

Slack notifications are sent to the specified channel for a specific workflow.

To set up Slack notifications:

  1. Select Respect Monitoring in the sidebar in Reunite.
  2. Select the workflow you want to subscribe to.
  3. Click Notifications in the top right side corner.
  4. Click Subscribe via Slack.
  5. Select the Slack workspace you want to install the Redocly app on and click Allow to install the Redocly Slack app to your Slack workspace.
  6. Select a public Slack channel as the Default channel where the notifications are delivered.
  7. (Optional) Add the default events you would like to receive notifications for. You must have at least one event listed to subscribe to notifications.
  8. (Optional) Deselect the Alert when back up checkbox if you do not want to receive a notification when a down workflow is back up again.
  9. (Optional) Use the slider or enter a lower number of errors for when the notification should be resent.
  10. Click Save.

After you have subscribed, notifications are sent based on the interval time frame configured in your redocly.yaml file.

Subscribe to email notifications

Email notifications are sent to the specified email address for a specific workflow../configure-respect-monitoring.md

To set up email notifications:

  1. Select Respect Monitoring in the sidebar in Reunite.
  2. Select the workflow you want to subscribe to.
  3. Click Notifications in the top right side corner.
  4. Select the Email tab in the modal.
  5. Add the default events you would like to receive notifications for. You must have at least one event listed to subscribe to notifications.
  6. Click Save.

After you have subscribed, notifications are sent based on the interval time frame configured in your redocly.yaml file.

Archive workflows

You can archive workflows you no longer wish to continue running../configure-respect-monitoring.md

To archive a workflow:

  1. On a new branch, remove the Arazzo Description from your project.
  2. Delete the job from your redocly.yaml file.
  3. Commit your changes and merge your pull request with your changes.
  4. After deployment, you can still see the old workflow data by clicking the Archived toggle.

Resources

  • Learn how to configure Reunite to monitor the performance of APIs in the Configure Respect Monitoring how-to documentation.
  • Explore the Respect Monitoring job configuration options in the reunite reference documentation.
 
Next page