LogpointApi.Core.AlertRule (logpoint_api v2.2.0)

Manage alert rules and their notifications in Logpoint.

Wraps the Alert Rules API. Use the Rule, EmailNotification, and HttpNotification builders to compose structs for creation endpoints.

Summary

Functions

activate(client, ids)

Activate alert rules by IDs.

create(client, rule)

Create an alert rule.

create_email_notification(client, notif)

Create an email notification for alert rules.

create_email_notification(client, ids, params)

create_http_notification(client, notif)

Create an HTTP notification for alert rules.

create_http_notification(client, ids, params)

deactivate(client, ids)

Deactivate alert rules by IDs.

delete(client, ids)

Delete alert rules by IDs.

get(client, id)

Get an alert rule by ID.

get_notification(client, alert_id, type)

Get alert notification by alert ID and type.

list(client, params \\ %{})

List alert rules.

update(client, id, rule)

Update an alert rule.

Functions

activate(client, ids)

@spec activate(LogpointApi.Data.Client.t(), [String.t()]) ::
  {:ok, map()} | {:error, term()}

Activate alert rules by IDs.

create(client, rule)

@spec create(LogpointApi.Data.Client.t(), LogpointApi.Data.Rule.t() | map()) ::
  {:ok, map()} | {:error, term()}

Create an alert rule.

create_email_notification(client, notif)

@spec create_email_notification(
  LogpointApi.Data.Client.t(),
  LogpointApi.Data.EmailNotification.t()
) ::
  {:ok, map()} | {:error, term()}

Create an email notification for alert rules.

create_email_notification(client, ids, params)

@spec create_email_notification(LogpointApi.Data.Client.t(), [String.t()], map()) ::
  {:ok, map()} | {:error, term()}

create_http_notification(client, notif)

@spec create_http_notification(
  LogpointApi.Data.Client.t(),
  LogpointApi.Data.HttpNotification.t()
) ::
  {:ok, map()} | {:error, term()}

Create an HTTP notification for alert rules.

create_http_notification(client, ids, params)

@spec create_http_notification(LogpointApi.Data.Client.t(), [String.t()], map()) ::
  {:ok, map()} | {:error, term()}

deactivate(client, ids)

@spec deactivate(LogpointApi.Data.Client.t(), [String.t()]) ::
  {:ok, map()} | {:error, term()}

Deactivate alert rules by IDs.

delete(client, ids)

@spec delete(LogpointApi.Data.Client.t(), [String.t()]) ::
  {:ok, map()} | {:error, term()}

Delete alert rules by IDs.

get(client, id)

@spec get(LogpointApi.Data.Client.t(), String.t()) :: {:ok, map()} | {:error, term()}

Get an alert rule by ID.

get_notification(client, alert_id, type)

@spec get_notification(LogpointApi.Data.Client.t(), String.t(), :email | :http) ::
  {:ok, map()} | {:error, term()}

Get alert notification by alert ID and type.

list(client, params \\ %{})

@spec list(LogpointApi.Data.Client.t(), map()) :: {:ok, map()} | {:error, term()}

List alert rules.

Supported keys in params:

:limit - maximum number of rules to return
:page - page number for pagination
:return_all_data - when true, returns all rule data

Examples

AlertRule.list(client)
AlertRule.list(client, %{limit: 10, page: 1})

update(client, id, rule)

@spec update(
  LogpointApi.Data.Client.t(),
  String.t(),
  LogpointApi.Data.Rule.t() | map()
) ::
  {:ok, map()} | {:error, term()}

Update an alert rule.