Skip to main content

Airbrake integration

You can use an APEX AIOps Incident Management custom integration to ingest events from Airbrake.

Before you begin

Before you set up your Airbrake integration:

  • Make sure you are signed in to your Incident Management instance.

  • Make sure you are signed in to Airbrake.

Create a custom integration in Incident Management

  1. Within Incident Management, navigate to Integrations > Ingestion Services > Create your own Integration.

  2. Click Add New Integration.

  3. Under APEX AIOps Incident Management Endpoint, enter a unique name for your new integration (required).

    Note

    The name of the integration can be anything you choose. Incident Management will automatically generate an API endpoint URL independent of what you enter for this field.

  4. Under API Description, enter a description for the integration (optional).

  5. Under Data Type, select Events.

  6. Click Save.

  7. Keep the web page for this integration open in your browser while you complete the following steps in Airbrake.

Create a webhook in Airbrake

  1. Open Airbrake. At the top of the page, click Integrations.

  2. Within the left hand navigation, click Webhook.

  3. Construct the endpoint URL:

    1. In the URL field, paste the endpoint URL for your Incident Management integration.

      The endpoint URL is provided for you in Incident Management on the page for your custom integration, under Configuration Information > APEX AIOps Incident Management Endpoint.

    2. Modify the endpoint URL by adding your Incident Management API key (apiKey) and the name of your Incident Management integration (integrationName) in the following format:

      https://integrationName:apiKey@api.moogsoft.ai/express/v1/integrations/custom/32z178bf1f6a8b624c4fe019/integrationName

      Caution

      The name of your Incident Management integration is case-sensitive. If your integration is named "Airbrake", then "airbrake" will not be recognized in the modified endpoint URL.

      Example:

      If the endpoint URL is https://api.moogsoft.ai/express/v1/integrations/custom/32z178bf1f6a8b624c4fe019/, then given the following values:

      • apiKey = 1234567-1234-abcd-12345678

      • integrationName = Airbrake

      ...the modified endpoint URL would be:

      https://Airbrake:1234567-1234-abcd-12345678@api.moogsoft.ai/express/v1/integrations/custom/32z178bf1f6a8b624c4fe019/Airbrake

  4. Click Save.

  5. Click Test integration. This will send a test payload to your Incident Management integration.

Configure the custom integration in Incident Management

  1. Go to your Incident Management instance.

  2. Open the page for your custom integration by going to Integrations > Ingestion Services > Create your own Integration > your-integration-name.

  3. In the Map Your Data section, you can view cached payloads of incoming events sent from Airbrake. Confirm that the test payload you sent is there.

  4. Map your payload fields to the corresponding Incident Management fields. An example mapping is provided for you below as a reference, but you should tailor the mapping according to your business needs.

    For a complete list of mapping types, save options, and instructions on how to use them, read Use mapping types in custom integrations.

    Table 1. Example mapping

    Airbrake fields

    Incident Management field

    error.last_notice.request_url

    source

    error.error_message

    description

    error.error_class

    check

    error.severity

    severity

    Click Map Values and map the severity values according to the Severity Mapping table below.

    error.project.name

    service

    error.error_class

    class

    error.line_number

    tags.airbrake line_number

    error.id

    tags.airbrake ID

    error.file

    tags.airbrake file

    error.project.id

    tags.airbrake project_id

    error.last_notice.request_url

    tags.airbrake request_url

    error.last_notice.request_method

    tags.airbrake request_method

    error.last_notice.backtrace

    tags.airbrake backtrace

    error.environment

    tags.airbrake environment

    error.first_occurred_at

    tags.airbrake first_occurred_at

    error.last_occurred.at

    tags.airbrake last_occurred_at

    error.times_occurred

    tags.airbrake times_occurred

    airbrake_error_url

    tags.airbrake error_url



    Table 2. Severity mapping

    Airbrake severity field

    Incident Management severity field

    debug

    Unknown

    info

    Unknown

    notice

    Warning

    alert

    Major

    emergency

    Critical



  5. Go to the top of the page and click Save.

In this section: