Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Completely skip alerting feature steps when alerting is disabled #494

Merged
merged 1 commit into from
May 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
46 changes: 30 additions & 16 deletions lib/trento/application/usecases/alerting/alerting.ex
Original file line number Diff line number Diff line change
Expand Up @@ -16,47 +16,61 @@ defmodule Trento.Application.UseCases.Alerting do
require Logger

@spec notify_heartbeat_failed(String.t()) :: :ok
def notify_heartbeat_failed(host_id) do
def notify_heartbeat_failed(host_id),
do: maybe_notify_heartbeat_failed(enabled?(), host_id)

@spec notify_critical_cluster_health(String.t()) :: :ok
def notify_critical_cluster_health(cluster_id),
do: maybe_notify_critical_cluster_health(enabled?(), cluster_id)

@spec notify_critical_database_health(String.t()) :: :ok
def notify_critical_database_health(id),
do: maybe_notify_critical_database_health(enabled?(), id)

@spec notify_critical_sap_system_health(String.t()) :: :ok
def notify_critical_sap_system_health(id),
do: maybe_notify_critical_sap_system_health(enabled?(), id)

defp enabled?, do: Application.fetch_env!(:trento, :alerting)[:enabled]

defp maybe_notify_heartbeat_failed(false, _), do: :ok

defp maybe_notify_heartbeat_failed(true, host_id) do
%HostReadModel{hostname: hostname} = Trento.Repo.get!(HostReadModel, host_id)

EmailAlert.alert("Host", "hostname", hostname, "heartbeat failed")
|> deliver_notification()
end

@spec notify_critical_cluster_health(String.t()) :: :ok
def notify_critical_cluster_health(cluster_id) do
defp maybe_notify_critical_cluster_health(false, _), do: :ok

defp maybe_notify_critical_cluster_health(true, cluster_id) do
%ClusterReadModel{name: name} = Trento.Repo.get!(ClusterReadModel, cluster_id)

EmailAlert.alert("Cluster", "name", name, "health is now in critical state")
|> deliver_notification()
end

@spec notify_critical_database_health(String.t()) :: :ok
def notify_critical_database_health(id) do
defp maybe_notify_critical_database_health(false, _), do: :ok

defp maybe_notify_critical_database_health(true, id) do
%DatabaseReadModel{sid: sid} = Trento.Repo.get!(DatabaseReadModel, id)

EmailAlert.alert("Database", "SID", sid, "health is now in critical state")
|> deliver_notification()
end

@spec notify_critical_sap_system_health(String.t()) :: :ok
def notify_critical_sap_system_health(id) do
defp maybe_notify_critical_sap_system_health(false, _), do: :ok

defp maybe_notify_critical_sap_system_health(true, id) do
%SapSystemReadModel{sid: sid} = Trento.Repo.get!(SapSystemReadModel, id)

EmailAlert.alert("Sap System", "SID", sid, "health is now in critical state")
|> deliver_notification()
end

@spec deliver_notification(Swoosh.Email.t()) :: :ok
defp deliver_notification(%Swoosh.Email{} = notification) do
maybe_deliver_notification(Application.fetch_env!(:trento, :alerting)[:enabled], notification)
end

@spec maybe_deliver_notification(false, Swoosh.Email.t()) :: :ok
defp maybe_deliver_notification(false, _), do: :ok

@spec maybe_deliver_notification(true, Swoosh.Email.t()) :: :ok
defp maybe_deliver_notification(true, %Swoosh.Email{subject: subject} = notification) do
defp deliver_notification(%Swoosh.Email{subject: subject} = notification) do
notification
|> Mailer.deliver()
|> case do
Expand Down
32 changes: 32 additions & 0 deletions test/trento/application/usecases/alerting_test.exs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,38 @@ defmodule Trento.Application.UseCases.AlertingTest do

@moduletag :integration

describe "Enabling/Disabling Alerting Feature" do
setup do
on_exit(fn ->
Application.put_env(:trento, :alerting,
enabled: true,
recipient: "some.recipient@email.com"
)
end)
end

test "No email should be sent when alerting is disabled" do
Application.put_env(:trento, :alerting, enabled: false)
host_id = Faker.UUID.v4()

Alerting.notify_heartbeat_failed(host_id)

assert_no_email_sent()
end

test "An error should be raised when alerting is enabled but no recipient was provided" do
Application.put_env(:trento, :alerting, enabled: true)
sap_system_id = Faker.UUID.v4()
sap_system_projection(id: sap_system_id)

assert_raise ArgumentError,
~r/Unexpected tuple format, {"Trento Admin", nil} cannot be formatted into a Recipient./,
fn -> Alerting.notify_critical_sap_system_health(sap_system_id) end

assert_no_email_sent()
end
end

describe "Alerting the configured recipient about crucial facts with email notifications" do
test "Notify Host heartbeating failure" do
host_id = Faker.UUID.v4()
Expand Down