Setting up integrations and alerts

This guide will walk you through the process of setting up integrations and creating alerts in Maxim.

Setting up integrations

Integrations allow you to connect Maxim with external services for notifications. Currently, we support Slack and PagerDuty integrations.

To set up alerts, we first need to set up integrations. Integrations are where you would configure the external channel you want Maxim to send out notifications to.

Adding a new integration

Navigate to the Settings page.

Click on "Integrations" in the left sidebar.

Click on "Add integration" button.

Choose the integration type (Slack or PagerDuty).

Follow the specific steps for each integration type.

Setup prerequisites

For Slack, we require the channel's webhook URL to which you want to send notifications. You can find this URL in the Slack channel settings.

For PagerDuty, you need to create a service in PagerDuty and obtain the routing key. You can find this key in the PagerDuty service settings.

You can edit or delete an integration by hovering over the respective integration and clicking on edit/delete icons respectively.

Setting up alerts

Alerts notify you when certain conditions are met in your logs metrics.

Creating a new alert

Go the logs and select the repository for which you want to configure the alerts.

Click "Create alert" button.

Configure the alert conditions:
- Choose a metric (Error, Cost, Tokens, User Feedback, or Latency)
- Select an operator (e.g., is equal to, is greater than etc)
- Enter the threshold value
- Set the minimum occurrence count
- Choose the time range for evaluation

Select notification channels (integrations you have set up will show up here)

Click "Create alert" to save. That's it, your alerts are now set up. Any log entry that violates the rule you have set up above, will trigger an alert to the integration configuration you have set up.

You can edit or delete an alerts by going over the respective alerts card and clicking on edit/delete icons respectively from the options icon (denoted by the three dots).

Pausing alerts

You can pause an alert simply by clicking on the options icon (denoted by the three dots), and clicking on "Pause alert". This will pause all alerts for that configuration until resumed.

By following this guide, you'll be able to effectively set up integrations with external services and create alerts to monitor your integration's performance in Maxim.

Setting up custom token pricing

Distributed tracing using Maxim

Setting up integrations and alerts