Skip to content

Alerts Console#

Introduction#

The Alerts Console shows all active and past alerts in your organization. It can be customized, per user, to show information relevant to them.

image

Read the Analytic and Alerting chapter to understand how Unryo detects anomalies, root cause and impacts.

Use the Alert Console#

Possible actions on alerts:

  • Alert Details: Shows information such as alert occurrences, tags, ChatGPT recommendations, alert policy information, resource information, etc.
  • Click on a resource to access the dashboard or topology map
  • Acknowledge/Unacknowledge
  • Take Ownership/Release Ownership. To advise your team you are working on it.
  • Force Clear: Force clear an alert. Forcibly cleared alerts are slightly different than naturally cleared alerts. They will stay cleared for the remainder of a specific occurrence while naturally cleared alerts will change back to being active on any re-notification.
  • Run Tools: Invoke a tool on the alarm for troubleshooting or repair.

Customize the Alerts Console#

  • To add a tab, select + from the tab bar.
  • To add a panel, select Add Panel from the gear menu.
  • To select columns to display, select Configuration from the panel's menu.
  • To filter alerts, select Manager Filter from the panel's menu.
  • To remove a panel, select Remove from the panel's menu.

image

Copy a Customized Console to other users#

  • Inside the Alerts container, find the user's dashboards you want to copy from in /etc/unryo/alerts/dashboard. You can do this simply by making a small change to the dashboards, saving it and then checking the latest update times.
  • In the same place and using the same method, find the user(s) dashboards you want to copy to.
  • Once both are located, simply copy the content of the first file to the other(s). They should now have the same dashboards configuration.

Run Tools#

A tool is an executable you can invoke on alarms, for example ping a resource, run a specialized check or integrate with an incident system. When a tool is invoked, it gets all the metatada associated to the alarm.

  • To run a tool: click the 3 dots icon (right to the alarm) and select Tools.

  • To add a tool: inside the Alerts container, copy your executable in /etc/unryo/tools. They should now be available in the console, under the actions button or in the top right of a panel when selecting alerts.

ChatGPT Integration#

The ChatGPT integration provides users with insight and potential solutions on their alerts. To access this feature, users need to set up their own API key and integrate it as an environment variable during the setup process.

image

Getting Started#

To enable the ChatGPT recommendation feature, follow these steps:

Obtain an API Key: To use the ChatGPT API, sign up or log into your account on https://www.openai.com to generate your unique API key.

Configuration:

  • Open the docker-compose.yaml file located in the unryo-setup directory. Within this file, find the appropriate section for alerts.
  • In the docker-compose.yaml file, ensure that the UNRYO_GPT_API_KEY field is present: UNRYO_GPT_API_KEY: ${UNRYO_GPT_API_KEY:-}
  • API Key Integration: In the .env file, add the same variable with your API key: UNRYO_GPT_API_KEY: Your API key

How to Use#

Once the ChatGPT integration is set up with your API key, you can interact with it seamlessly via the app's user interface.

  • Click on the 3-dots icon (right side of any alert) > Alert details > AI Chat

    The feature will enable you to to select between predefined questions regarding any errors you encounter, and ChatGPT will respond with insightful recommendations. The first prompt explains the alert, the second explains the causes, and the third describes a solution. Once you click on the corresponding buttons, the request will be sent to the OpenAI API and one of your tokens will be used per request.

If you don't see the action column: go to the alerts console, select the drop down with 3 lines on the right, and click configure. Enable actions (if it isn’t enabled already).

Security Considerations#

The security of your API key is of utmost importance. Treat it as a confidential credential and avoid sharing it publicly or including it in version control systems. Additionally, keep your app and its dependencies updated to prevent security vulnerabilities.

Disable ChatGPT integration#

If you don’t plan on using the ChatGPT integration and you want it to not be visible, you can delete the placeholder within the docker-compose.yaml file, or your entered key within the .env file, leaving it blank.