Integrations

Gravitee Alert Engine works both within and outside the Gravitee ecosystem. Keep reading to learn more.

Gravitee platform integrations

AE can be layered on top of:

• Gravitee API Management (APIM): bolster your existing Gravitee APIM implementation with advanced API monitoring and alerting capabilities. To learn more about how Alert Engine makes APIM better, please refer to the APIM alerting documentation.

• Gravitee Access Management: bolster your API Security strategy by using AE to notify teams when API consumption becomes suspicious. This looks like alerts sent when Gravitee Access Management notices potentially risky user profiles and/or consumption patterns. To learn more, refer to the Gravitee Access Management documentation.

Integrating with third party solutions

You can also plug AE into your own backends and benefit from all the same features. You can use WebSocket or HTTP endpoints to create triggers and send events later in time.

Requirements

Before using AE with your existing backend infrastructure, you must already have AE available as already deployed in your infrastructure, or, by running it with docker:

docker run -t -v "${PWD}/licence.key:/opt/graviteeio-alert-engine/license/license.key:ro" -p 8072:8072 graviteeio/ae-engine:latest

For running the Javascript scripts below, we use node version v18.7.0.

WebSocket connection

You can send triggers through a WebSocket connection, as shown in the Javascript implementation example below.

To test this script:

1. bootstrap a javascript project with npm init

2. add ws dependency with npm install --save ws

3. create the trigger.js file with the content below.

4. run that script with node trigger.js

Same goes with events:

A new Alert Engine log line should appear to confirm a new WebSocket is opened.

And on the trigger.js run you should see something like:

HTTP Endpoint

You can also submit triggers via HTTP:

Same with events: