Docs

Creating Alerts

Creating a new alert involves the following:

  1. Select the alert type
  2. Configure: Establish alert and cautionary limits, specify evaluation durations, and set up advanced alerting features.
  3. Describe: Craft a personalized alert title and message, incorporating values and set a severity
  4. Communicate: Select the preferred notification methods for your team, such as email, Slack, PagerDuty.

The following section will describe each of these steps in detail.

Select alert type

The first step is to select the type of alert to be handled. Any of the direct or derived metrics on Reveal can be tracked and alerted upon.

Configure

This is where details of alerts are entered into. This is the most critical part of the setup. As someone who creates the alerts the following is information you should have:

  1. Metric: Which metric are you tracking? The metric has to be one of those that the product line you are on should support.
  2. Nature of the metric: Is it a continuous trail of data or a discrete one? In other words, is the metric to be chosen from a discrete set of values or a number? Refer to the alert types supported below
  3. Prior knowledge: Know your data, the threshold you need to set, what is normal, and what needs to be alerted. Please feel free to reach out to Reveal if you need help to pick the right metric for your problem.
  4. Ensembling method: When analyzing a continuous stream of data and comparing it with a single number (threshold), a method of aggregating or ensembling the stream of data needs to be specified. The supported ensemble methods are commonly used ones such as less than, greater than, equal to, less than or equal to (le) , greater than or equal to (ge), above, below

Threshold-based alerts

The alerts are extremely configurable. You can

  1. trigger an alert when the metric filtered by
  2. Filtered by currency, processor, payment method, country . card scheme These filters are optional
  3. is less than, greater than, equal to, le, ge the threshold (# or %)
  4. over a past n hours or days.

Range-based alerts

To configure continuous data:

  1. trigger an alert when the metric filtered by
  2. Filtered by currency, processor, payment method, country . card scheme_ etc. These filters are optional_
  3. is below threshold-1 (#, %) OR above threshold-2 (#, %)
  4. over a past n hours or days.

Discrete data is not supported for range-based alerts

Describe

This involves telling Reveal-alerts the action you would want to take. In this step you can:

  1. Name the alert
  2. Select a title and a message to describe the alert. This could include a description of the alert or the remedial action you might want your team to take when this alert is encountered.
  3. Add dynamic variables (metrics and their values i.e. every parameter you enter in the configuration step) as a part of the message

Communicate

The last step in the new alert setup is to:

  1. Select medium: You choose to communicate the alert to. Reveal presently supports alerting via slack,
  2. Select the team: Choose the team you would like to notify this alert to. Reveal provides you with the facility to add your colleagues via the respective handles required for the communication medium.

You are now all set. Reveal-alerts will monitor your stack!

Was this article helpful?