feat: add support for email alert channel (#4599)

deploy/docker-swarm/clickhouse-setup/docker-compose.yaml

@@ -133,7 +133,7 @@ services:
  # - ./data/clickhouse-3/:/var/lib/clickhouse/
 
  alertmanager:
- image: signoz/alertmanager:0.23.4
+ image: signoz/alertmanager:0.23.5
  volumes:
  - ./data/alertmanager:/data
  command:

deploy/docker/clickhouse-setup/docker-compose-core.yaml

@@ -54,7 +54,7 @@ services:
 
  alertmanager:
  container_name: signoz-alertmanager
- image: signoz/alertmanager:0.23.4
+ image: signoz/alertmanager:0.23.5
  volumes:
  - ./data/alertmanager:/data
  depends_on:

deploy/docker/clickhouse-setup/docker-compose.yaml

@@ -149,7 +149,7 @@ services:
  # - ./user_scripts:/var/lib/clickhouse/user_scripts/
 
  alertmanager:
- image: signoz/alertmanager:${ALERTMANAGER_TAG:-0.23.4}
+ image: signoz/alertmanager:${ALERTMANAGER_TAG:-0.23.5}
  container_name: signoz-alertmanager
  volumes:
  - ./data/alertmanager:/data

ee/query-service/model/plans.go

@@ -90,6 +90,13 @@ var BasicPlan = basemodel.FeatureSet{
  UsageLimit: -1,
  Route: "",
  },
+ basemodel.Feature{
+ Name: basemodel.AlertChannelEmail,
+ Active: true,
+ Usage: 0,
+ UsageLimit: -1,
+ Route: "",
+ },
  basemodel.Feature{
  Name: basemodel.AlertChannelMsTeams,
  Active: false,
@@ -177,6 +184,13 @@ var ProPlan = basemodel.FeatureSet{
  UsageLimit: -1,
  Route: "",
  },
+ basemodel.Feature{
+ Name: basemodel.AlertChannelEmail,
+ Active: true,
+ Usage: 0,
+ UsageLimit: -1,
+ Route: "",
+ },
  basemodel.Feature{
  Name: basemodel.AlertChannelMsTeams,
  Active: true,
@@ -264,6 +278,13 @@ var EnterprisePlan = basemodel.FeatureSet{
  UsageLimit: -1,
  Route: "",
  },
+ basemodel.Feature{
+ Name: basemodel.AlertChannelEmail,
+ Active: true,
+ Usage: 0,
+ UsageLimit: -1,
+ Route: "",
+ },
  basemodel.Feature{
  Name: basemodel.AlertChannelMsTeams,
  Active: true,
@@ -279,17 +300,17 @@ var EnterprisePlan = basemodel.FeatureSet{
  Route: "",
  },
  basemodel.Feature{
- Name: Onboarding,
- Active: true,
- Usage: 0,
+ Name:  Onboarding,
+ Active:  true,
+ Usage:  0,
  UsageLimit: -1,
- Route: "",
+ Route:  "",
  },
  basemodel.Feature{
- Name: ChatSupport,
- Active: true,
- Usage: 0,
+ Name:  ChatSupport,
+ Active:  true,
+ Usage:  0,
  UsageLimit: -1,
- Route: "",
+ Route:  "",
  },
 }

frontend/public/locales/en/channels.json

@@ -23,6 +23,12 @@
  "field_opsgenie_api_key": "API Key",
  "field_opsgenie_description": "Description",
  "placeholder_opsgenie_description": "Description",
+ "help_email_to": "Email address(es) to send alerts to (comma separated)",
+ "field_email_to": "To",
+ "placeholder_email_to": "To",
+ "help_email_html": "Send email in html format",
+ "field_email_html": "Email body template",
+ "placeholder_email_html": "Email body template",
  "field_webhook_username": "User Name (optional)",
  "field_webhook_password": "Password (optional)",
  "field_pager_routing_key": "Routing Key",

frontend/src/api/channels/createEmail.ts

@@ -0,0 +1,34 @@
+import axios from 'api';
+import { ErrorResponseHandler } from 'api/ErrorResponseHandler';
+import { AxiosError } from 'axios';
+import { ErrorResponse, SuccessResponse } from 'types/api';
+import { PayloadProps, Props } from 'types/api/channels/createEmail';
+
+const create = async (
+ props: Props,
+): Promise<SuccessResponse<PayloadProps> | ErrorResponse> => {
+ try {
+ const response = await axios.post('/channels', {
+ name: props.name,
+ email_configs: [
+ {
+ send_resolved: true,
+ to: props.to,
+ html: props.html,
+ headers: props.headers,
+ },
+ ],
+ });
+
+ return {
+ statusCode: 200,
+ error: null,
+ message: 'Success',
+ payload: response.data.data,
+ };
+ } catch (error) {
+ return ErrorResponseHandler(error as AxiosError);
+ }
+};
+
+export default create;

frontend/src/api/channels/editEmail.ts

@@ -0,0 +1,34 @@
+import axios from 'api';
+import { ErrorResponseHandler } from 'api/ErrorResponseHandler';
+import { AxiosError } from 'axios';
+import { ErrorResponse, SuccessResponse } from 'types/api';
+import { PayloadProps, Props } from 'types/api/channels/editEmail';
+
+const editEmail = async (
+ props: Props,
+): Promise<SuccessResponse<PayloadProps> | ErrorResponse> => {
+ try {
+ const response = await axios.put(`/channels/${props.id}`, {
+ name: props.name,
+ email_configs: [
+ {
+ send_resolved: true,
+ to: props.to,
+ html: props.html,
+ headers: props.headers,
+ },
+ ],
+ });
+
+ return {
+ statusCode: 200,
+ error: null,
+ message: 'Success',
+ payload: response.data.data,
+ };
+ } catch (error) {
+ return ErrorResponseHandler(error as AxiosError);
+ }
+};
+
+export default editEmail;

frontend/src/api/channels/testEmail.ts

@@ -0,0 +1,34 @@
+import axios from 'api';
+import { ErrorResponseHandler } from 'api/ErrorResponseHandler';
+import { AxiosError } from 'axios';
+import { ErrorResponse, SuccessResponse } from 'types/api';
+import { PayloadProps, Props } from 'types/api/channels/createEmail';
+
+const testEmail = async (
+ props: Props,
+): Promise<SuccessResponse<PayloadProps> | ErrorResponse> => {
+ try {
+ const response = await axios.post('/testChannel', {
+ name: props.name,
+ email_configs: [
+ {
+ send_resolved: true,
+ to: props.to,
+ html: props.html,
+ headers: props.headers,
+ },
+ ],
+ });
+
+ return {
+ statusCode: 200,
+ error: null,
+ message: 'Success',
+ payload: response.data.data,
+ };
+ } catch (error) {
+ return ErrorResponseHandler(error as AxiosError);
+ }
+};
+
+export default testEmail;

frontend/src/container/CreateAlertChannels/config.ts

@@ -64,6 +64,16 @@ export interface OpsgenieChannel extends Channel {
  priority?: string;
 }
 
+export interface EmailChannel extends Channel {
+ // comma separated list of email addresses to send alerts to
+ to: string;
+ // HTML body of the email notification.
+ html: string;
+ // Further headers email header key/value pairs.
+ // [ headers: { <string>: <tmpl_string>, ... } ]
+ headers: Record<string, string>;
+}
+
 export const ValidatePagerChannel = (p: PagerChannel): string => {
  if (!p) {
  return 'Received unexpected input for this channel, please contact your administrator ';