accelo config alerts notifications

Configuring Alert Notifications

The following command configures default alert notifications for Acceldata Pulse.

Note

Before executing, verify if this command is compatible to the targeted Pulse version.

accelo config alerts notifications

On entering the above command, the following inputs are required from you:

Enter the Joda Timezone value (Example: Asia/Jakarta): :

To find your Joda time zone value, see Joda Time.

? Select the metric groups you would like to enable: [Use arrows to move, space to select, type to filter] [] druid [] memsql [] nifi [] ntpd [] anomaly [] chrony [] customApp

? Select the notifications you would like to enable: [Use arrows to move, space to select, type to filter] [] slack [] pagerduty [] hangouts [] webhook [] fileLog [] email [] action [] opsgenie [] line [] telegram [] servicenow [] quantum [] xmatters [] Bigpanda [] Microsoft Teams

ServiceNow Notifications

Enter ServiceNow MaxServiceNowMessageThreshold: <default value = 1> Enter ServiceNow DefaultSnoozeIntervalInSecs: <default value = 0> Enter ServiceNow Table Names (comma separated list): : <Enter the Table Names obtained from ServiceNow> Enter ServiceNow BearerToken: : <Enter the BearerToken obtained from ServiceNow> Enter ServiceNow URL: : <Enter the URL obtained from ServiceNow> Enter ServiceNow Caller: : <Enter the Caller ID obtained from ServiceNow>

Line Notifications

Enter Line MaxLineMessageThreshold: <default value = 1> ✔ Enter Line DefaultSnoozeIntervalInSecs: <default value = 0> ✔ Enter Line API Keys (comma separated list): <Enter the API Keys obtained from Line>

Telegram Notifications

Enter Telegram MaxTelegramMessageThreshold: <default value = 1> Enter Telegram DefaultSnoozeIntervalInSecs: <default value = 0> Enter Telegram DefaultBotToken: <Enter the default BotToken obtained from Telegram> Enter Telegram DefaultChatIds (comma separated list): <Enter the default ChatIds obtained from Telegram>

Jira Notifications

Enter Jira MaxJiraMessageThreshold: <default value = 1> Enter Jira DefaultSnoozeIntervalInSecs: <default value = 0> Enter Jira Issue Type: <one of the three issue types"Bug", "Story", "Task"> Enter Jira URL:<Enter the URL obtained from Jira> Enter Jira Project Key: < Enter the project key> Enter Jira Username: <Enter the user name> Enter Jira Token:<Enter the Jira token of the user> Enter Jira Priority:<Enter Jira priority> Enter Jira Label (comma separated list):<Enter the label>

Opsgenie Notifications

To set up Opsgenie notifications, assign a value to following parameters after executing the config alerts notifications command.

Enter Opegenie MaxMessageThreshold: <default value = 1> Enter Opsgenie DefaultSnoozeIntervalInSecs: <default value = 0> Enter the Opsgenie API KEY: <Enter the API key obtained from Opsgenie>

Email Notifications

To set up email notifications, assign a value to the following parameters after executing the config alerts notifications command.

Enter Email DefaultToEmailIds (comma separated list): <Enter email addresses separated by commas> Enter Email DefaultSnoozeIntervalInSecs: <default value = 0> Enter Email MaxEmailThreshold: <default value = 1>

Quantum Notifications

To set up Quantum notifications, assign a value to the following parameters after executing the config alerts notifications command.

INFO: Configuring Quantum Notifications ✔ Enter Quantum MaxQuantumMessageThreshold: : 1█ Enter Quantum DefaultSnoozeIntervalInSecs: : 0 Enter Quantum URL: : ddd Enter Quantum Subscription Key: : ddd Default Quantum Ticket Type is: Reporting an Outage Default Quantum Ticket State is: Queue Default Quantum App or Platform type is: Pulse Enter Quantum ReportedBy [Single emailId]: : username@gmail.com Enter Quantum AssignedTo [Single emailId]: : username@gmail.com ✓ Done, Alerts Notifications Configuration file generated ✓ Done, Alerts Notifications pushed to Pulse DB

Sample Configuration

quantum: enable: false maxquantummessagethreshold: 1 defaultsnoozeintervalinsecs: 0 url: <quantum-ticking-url> subscriptionkey: "client-specific-quantum-subscription-key" tickettype: Reporting an Outage state: Queue apporplatform: Pulse reportedby: "<email-id-associated-with-all-tickets-by-pulse>" assignedto: "<automatic-assignee-for-tickets-by-pulse>"

xMatters Notifications

To set up xMatters notifications, assign a value to the following parameters after executing the accelo config alerts notifications command.

Select the notifications you would like to enable: xmatters INFO: Configuring XMatters Notifications ✔ Enter XMatters MaxXMattersMessageThreshold: : 1 Enter XMatters DefaultSnoozeIntervalInSecs: : 0 Enter XMatters URL: : "<https:x-matterts url>" ✔Register/Verify XMatters UserGroup Details Enter Group Name: <group1> Enter Group Key: <Key1> Do you want to add another UserGroup [Y/N] : Y Enter Group Name: <group2> Enter Group Key: <Key2> Do you want to add another UserGroup [Y/N] : Y Enter Group Name: <group3> Enter Group Key: <Key3> ✔These are the UserGroups created. Configure the required groups by selecting them. Enter XMatters Key: : "<x-matterts Key>"

Sample Configuration

xmatters: enable: true maxxmattersmessagethreshold: 1 defaultsnoozeintervalinsecs: 0 url: "<https:x-matterts url>" key: "<x-matters Key>" alerttype: ALERT version: alertapi-0.1 xmatters: enable: true maxxmattersmessagethreshold: 1 defaultsnoozeintervalinsecs: 0 url: "<https:x-matterts url>" alerttype: ALERT version: alertapi-0.1 usergroups: - usergroup: TestGroup 1 userkey: "<x-matters Key1>" - usergroup: Test Group 2 userkey: "<x-matters Key2>"
Info
  • Configurations need to be tailored based on specific user requirements, indicating a need for customization in different deployment environments.

  • For utilizing xMatters tickets and notifications, users must supply a valid API key and the xMatters URL during the notification setup process, emphasizing the necessity of having these credentials for the integration to function properly.

xMatters Webhook Configuration (Pulse 4.1.2 or later)

Starting with Pulse 4.1.2, you can configure the xMatters notification channel to send alert notifications using a flexible, environment-driven approach.

Configuration Behavior

Introduced an environment variable:

  • IS_XMATTERS_WEBHOOK

For details about behavior:

  • If false → Use the generic webhook implementation (default for all clients)

  • If true → Use the xMatters-specific request format

xMatters Payload Format

For details about payload behavior:

  • When IS_XMATTERS_WEBHOOK = false (default):

The built-in generic request payload is used (For example):

{ "@key": "abc", "@version": "1.0", "@type": "alert", "object": "abc_object", "severity": "CRITICAL", "text": "CLUSTER_NAME: abc_cluster \n SERVICE_NAME:abc_service \n SERVER_NAME:abc_server \n ISSUE: abc_issue_detected \n GROUPED_KEY : abc_group1, abc_group2, \n RESULT:\n metric1 : abc_value1 \n metric2 : abc_value2 \n \n HELP: abc_help_link \n ALERT_ID: abc_12345" }
  • When IS_XMATTERS_WEBHOOK = true, use the following payload structure:

{ "recipients": "targetName1,targetName2", "summary": "An alert was triggered", "description": "The alert's impact area", "priority": "MEDIUM" }

For details about payload:

  • recipients → Comma-separated list of target users/groups

  • summary → Short alert message

  • description → Detailed alert context

  • priority → Alert severity (e.g., LOW, MEDIUM, HIGH)

URL Configuration

For xMatters integration:

  • If IS_XMATTERS_WEBHOOK = false (default) → The endpoint is automatically appended with /api/sendAlert

  • If IS_XMATTERS_WEBHOOK = true→ The API endpoint is fully configurable and should be provided as required by xMatters

Summary

  • Controlled via IS_XMATTERS_WEBHOOK

  • Supports both generic and xMatters-specific formats

For client-specific configurations and validation, align accordingly.


Big Panda Notifications

To set up the Big Panda notifications, assign a value to the following parameters after executing the accelo config alerts notifications command.

INFO: Configuring BigPanda Notifications Enter BigPanda MaxBigPandaMessageThreshold: : 1 ✔ Enter BigPanda DefaultSnoozeIntervalInSecs (should be 0 or >= 60): : 0 Enter BigPanda URL: : "<https: big panda url>:" ✔ Enter BigPanda Auth Token: : ***** Enter Mnemonic: : BDP ✓ Done, Alerts Notifications Configuration file generated ✓ Done, Alerts Notifications pushed to Pulse DB

In the configuration, the supported Mnemonic options are BDO and BDP.

This results in a request to BigPanda server:

  • The source is always be "Pulse"

  • Severity: Pulse severity to BigPanda severity mapping is as follows:

    • Critical => P2

    • High => P3

    • Everything else (low | medium | info) => P4

Microsoft Teams Notifications

To set up the Microsoft Teams notifications, assign a value to the following parameters after executing the accelo config alerts notifications command.

INFO: Configuring Microsoft Teams Notifications Enter Microsoft Teams MaxTeamsMessageThreshold: : 1 Enter Microsoft Teams DefaultSnoozeIntervalInSecs (should be 0 or >= 60): : 120 ✔ Enter Microsoft Teams Webhook URL: < Webhook URL > ✓ Done, Alerts Notifications Configuration file generated ✓ Done, Alerts Notifications pushed to Pulse DB

Create a Microsoft Teams Webhook URL

You can create the webhook URL using one of the following methods:

  1. Using the Microsoft Teams application: See Create Incoming Webhooks for instructions.

  2. Using Microsoft Workflows: See Create Incoming Webhooks with Workflows for detailed steps.

Important If using method 2 and your Microsoft Teams channel type is private, the target is set to “Chat with Flow bot” by default.

You must change it to a user who has permission to read messages in the private channel or authenticate the Flow bot to write to the private channel.


Netcool Notifications

To set up the Netcool notifications, assign a value to the following parameters after executing the accelo config alerts notifications command.

INFO: Configuring Netcool Notifications Enter Netcool MaxNetcoolMessageThreshold: : 1 Enter Netcool DefaultSnoozeIntervalInSecs (should be 0 or >= 60): : 0 Enter Netcool Webhook URL: : http://10.100.10.25:8000/odp_white/netcool Enter Netcool Component ID (COMPID) for this cluster: : ODPWHITE ✓ Done, Alerts Notifications Configuration file generated ✓ Done, Alerts Notifications pushed to Pulse DB

This results in a request to the Netcool server with the following fields:

  • SEV (Severity): Valid values are CRIT or WARN. This determines the priority of the incident ticket. Pulse alert priorities map to Netcool severity as follows:

    • Critical → CRIT

    • High → CRIT

    • Low, Medium

    • Info → WARN

  • COMPID (Component ID): Must be 3 to 64 characters and can contain only uppercase letters (A–Z), numbers (0–9), and underscores (_), with no spaces.

The Component ID identifies the affected application in ServiceFirst and indirectly determines the support queue where the ticket will be posted. The COMPID must already exist for the appropriate Application ITSI in ServiceFirst before generating alerts.

In Pulse, COMPID is tied to a specific cluster. Users configure this by running the accelo config alerts notifications command so that all alerts from that cluster send the configured COMPID.

  • EID (Event ID): An integer between 0 and 99999 containing only digits. Pulse converts the Pulse Alert ID into this format when sending notifications.

  • SOURCE (Source of the event): Must be 3 to 32 characters long and can include only uppercase letters, digits, underscores, and hyphens, with no spaces. This field always has the value: “PULSE_ALERTS_” + COMPID.

  • SUMMARY (Summary): A freeform description of the problem, between 3 and 4000 characters. Only specific characters are allowed (letters, digits, spaces, and common symbols). Pulse incident details JSON is provided in this field.

  • CI (Configuration Item / Node Name): Must be 3 to 64 characters and can contain only letters, digits, dots, underscores, and hyphens, with no spaces. This represents the node or server name related to the alert. Pulse uses the incident node hostname as the value.

  • ERRTYPE (Error Type): Must be 3 to 64 characters and can contain only uppercase letters, digits, and underscores, with no spaces. Pulse uses the alert type as the value of this field when sending notifications.

  • ALERTKEY (Alert Key): Must be 3 to 255 characters and can contain only uppercase letters, digits, dots, underscores, and hyphens, with no spaces. This is used to consolidate multiple alerts into a single incident ticket. If ALERTKEY is provided, Netcool deduplicates alerts using:

COMPID:SEV:ALERTKEY

If not provided, deduplication is based on: CI:SEV:COMPID:ERRTYPE:SOURCE:EID

Pulse derives this value from the Pulse Incident Reference ID after cleaning it to meet validation rules.

CLEAR (Clearing Indicator) Defines whether the alert is clearing. The only valid value is TRUE.


Options for [flags]

Enter the following command and append the below flags:

accelo config alerts notifications [flags]
-h, --help help for notifications -l, --load loads the config into the DB

SEE ALSO