NewRelic AI Application Error Reporting through Custom Channels

Question

Pulumi · Accepted Answer

To set up NewRelic AI application error reporting with custom channels using Pulumi, we'll take advantage of the `newrelic` provider for Pulumi. We will create a New Relic alert channel that will act as our custom channel for sending notifications when an error event occurs in our application. We'll also need to set up an alert policy and connect the channel to that policy.

Here is a step-by-step guide on how we'll achieve this:

1. **Setting up the Pulumi NewRelic Provider**: We'll start with importing the necessary New Relic modules from Pulumi's package and configure our New Relic provider with the required account ID.

2. **Creating a New Relic Alert Channel**: This will act as the custom channel where notifications will be sent. You can choose different types of channels like email, Slack, webhooks, etc. For this guide, let's assume we're using a webhook as a channel to receive alerts.

3. **Creating a New Relic Alert Policy**: This policy defines the conditions under which alerts are triggered. We will create an alert policy that looks for application errors.

4. **Associating the Alert Channel with the Alert Policy**: We will then attach our alert channel to the alert policy. This association ensures that alerts triggered by the policy get sent to the custom channel we created.

Below, you will find a Python program that uses Pulumi to set this up:

```python
import pulumi
import pulumi_newrelic as newrelic

# Configuration for the New Relic provider using the account ID.
newrelic_provider = newrelic.Provider('newrelic-provider', account_id='NEW_RELIC_ACCOUNT_ID')

# Create a New Relic alert channel (Webhook example).
# Replace `webhook_url` with the URL you want New Relic to send the alerts to.
webhook_channel = newrelic.AlertChannel('webhook-channel',
    name='Webhook Alert Channel',
    type='webhook',
    config=newrelic.AlertChannelConfigArgs(
        url='WEBHOOK_URL',
        base_url='WEBHOOK_BASE_URL', # Optional: URL without path (scheme + host + port).
        headers={"X-Custom-Header": "Header-Value"}, # Optional: Headers to include.
        payload_type='application/json', # Optional: The type of payload to send.
        payload_string='PAYLOAD_STRING'  # Optional: Custom payload as a JSON string.
    ),
    opts=pulumi.ResourceOptions(provider=newrelic_provider)
)

# Create a New Relic alert policy for application errors.
alert_policy = newrelic.AlertPolicy('error-alert-policy',
    name='Application Error Policy',
    incident_preference='PER_POLICY',
    opts=pulumi.ResourceOptions(provider=newrelic_provider)
)

# Create an alert condition for the policy that targets the whole application.
alert_condition = newrelic.AlertCondition('application-error-condition',
    policy_id=alert_policy.id,
    name='Application Error Condition',
    type='apm_app_metric',
    entities=['YOUR_APPLICATION_ID'], # Replace with your New Relic application ID.
    metric='error_percentage',
    runbook_url='YOUR_RUNBOOK_URL', # Optional: a link to a runbook that has more details/instructions.
    condition_scope='application',
    term=newrelic.AlertConditionTermArgs(
        duration=5,               # Duration in minutes of the condition to persist before creating an incident.
        operator='above',         # Operator defines the condition logic. Example: 'above', 'below', 'equal'.
        priority='critical',      # Priority of the condition. Example: 'critical', 'warning'.
        threshold='5',            # Threshold for the condition to be met.
        time_function='any',      # Timing function. Example: 'all', 'any'.
    ),
    opts=pulumi.ResourceOptions(provider=newrelic_provider)
)

# Create a notification channel and link it to the alert policy.
# Replace `WEBHOOK_CHANNEL_ID` with your New Relic webhook channel ID.
alert_channel_link = newrelic.AlertPolicyChannel('alert-channel-link',
    policy_id=alert_policy.id,
    channel_ids=[webhook_channel.id],
    opts=pulumi.ResourceOptions(provider=newrelic_provider)
)

# Export the ID of the alert policy and the alert channel.
# These exports allow us to easily reference the IDs outside of Pulumi.
pulumi.export('alert_policy_id', alert_policy.id)
pulumi.export('webhook_channel_id', webhook_channel.id)
```

In this program, replace `NEW_RELIC_ACCOUNT_ID`, `WEBHOOK_URL`, `YOUR_APPLICATION_ID`, and other placeholders with your actual New Relic account ID, your Webhook URL, and your New Relic application ID, respectively. This will allow New Relic to send alerts to the specified Webhook URL when your application experiences an error condition.

Please note that the `webhook_channel` might have other specific configurations depending on the actual service you are integrating with (e.g., Slack, email, or some other incident management tool). Make sure to consult the New Relic documentation for the specific settings related to the channel you are using.

After deploying this program with Pulumi, you will have a New Relic alert policy and channel set up to notify you of application errors via a custom channel. The `pulumi.export` statements provide you with the IDs of the created resources, which can be used to reference these resources in other Pulumi programs or in external systems.