Inspector
  • 11 May 2023
  • 3 Minutes to read
  • Dark
    Light
  • PDF

Inspector

  • Dark
    Light
  • PDF

Article summary

AlertOps and Inspector

AlertOps’ alert management system can be integrated with Inspector to receive and respond to all (predefined status mappings) alerts through email, SMS, push notification or phone alerts. AlertOps would ensure that the alert/job status would reach the appropriate team by using proper workflows, escalation policies and schedules. Based on your ruleset, incidents can be automatically opened and closed, depending on what kind of alert Inspector reports.

 

The above scenario and scope for integration is due to the fact that AlertOps has a very flexible and simple API/Webhook configuration feature that can be leveraged with Inspector's alert and notification capabilities.

 

AlertOps - Inbound Integration

We can define rulesets in AlertOps so that Inspector can send out alerts to the AlertOps platform. AlertOps would ensure based on these notifications received, that it would always reach out and assign to the correct person/team by utilizing its escalation policies, schedules, and workflow features.

 

AlertOps provides Inbound Integrations to integrate with numerous monitoring, chat and ITSM tools. You can configure an inbound integration for Inspector.

 

At a high level this is how the flow looks like, you define an API integration in the AlertOps platform by defining settings like Integration Name, Escalation rules, recipient users/groups. Once an integration is defined, a unique API URL is generated. This acts as webhook or the gateway through which notifications from Inspector reach AlertOps and thus an incident/alert is created correspondingly. The API can be defined with various settings like URL mappings, filters, escalations etc. as required. Inspector has to be defined with a webhook notification channel, and alert thresholds for open and close conditions.


Configure Inbound Integration

  1. Navigate to Configuration àIntegrations àAdd API Integration à API Integration Detail page.
  2. Select Inspector (else select Custom)
  3. Once you selected the integration, you can then specify basic settings like the integration name, escalation policy, names of the recipients/groups for which the alerts must be assigned to.
  4. Once you click save, the API Integration will be created, and you will be given a unique URL which acts as the access point and needs to be configured at the source (in this case Inspector), to send alerts. You can find the integration you just created, and you can give advanced settings and define various configurations for the alerts to be received and processed. For example, you can define when to open and close alerts based on the payload obtained from the API call, filters etc.
  5. Make a note of the API URL, which will be used in Inspector, so it calls a HTTP POST request to this URL with the body in JSON format containing the alert specific information. AlertOps automatically creates an alert when the status variable (payload^title) contains 'OpenCondition'. The incident will also be closed automatically when the status 'CloseCondition' is received from Inspector.
  6. You can similarly define URL mappings as you want, owing to the flexibility provided by AlertOps’ OpenAPI/Plug-and-Play integrations. You can provide other filters and match with regex expressions as well. You can also test the generated URL with the sample data provided.


Configure Integration in Inspector 

  1. In your Inspector portal, go to your application, and under Settings, select Notification Channels.
  2. Select Configure for Webhook
  3. Under URLs, paste the AlertOps Inbound Integration API URL.
  4. For notifications, enable all
  5. Enable Channel.
  6. Different types of notifications may contain different JSON payloads. You can map them accordingly in AlertOps, under the created Inbound Integration and URL Mapping.
  7. Now under the 'Alerts' tab for you application, make sure you create Two Alert policies, one for the OpenCondition (configure required threshold for open condition), and one for CloseCondition (configure required threshold for the close condition).
  8. When you create the policy, ensure that the 'Name and Create' section contains the string 'OpenCondition' for open alert policy, and 'CloseCondition' for the close alert policy.


Thats it! You have configured a Webhook integration channel and two alert policies. Any alert will be sent to AlertOps for incident management.

Message logs, alert specific information can be viewed in the “Inbound Log” section in AlertOps Dashboard. Alerts can be viewed in the ‘Alerts’ tab as well.

 

Alert Triggering Information

AlertOps will automatically create an incident when a new alert is received from Inspector when the payload^title contains "OpenCondition".

 

If an alert with status "OpenCondition" matches an existing Open Alert, AlertOps will recognize the new alert as a duplicate and ignore the alert.

The alert will be recorded in the Inbound Messages table as “Mapped Appended.”

 

AlertOps will automatically close the same incident when an alert with payload^title contains "CloseCondition".

 

References

AlertOps Integration Guides

General Restful API Guide

Inspector Guide


Was this article helpful?

What's Next