Alerts and Activity Log Notifications

On this page

Overview

Activity Log Notifications (also known as Notifications or Alerts) let Org admins configure alert routing for specific event types within their Organizations. You must have Org admin permissions for managing alerts.

Support for Notifications through Slack

SnapLogic supports the Slack messaging app within the SnapLogic platform communications, enabling you as an Org admin to add Slack channels and recipients for your SnapLogic communications. For details on adding Slack communications to your Org, see SnapLogic Notifications through Slack.

You can create notifications that notify users based on the following events.

  • ACL: Changes to Asset Control List (ACL) for a project.
  • API: Threshold violation for API usage.
  • Asset: Changes to assets.
  • Dist: Changes in the distribution version of Snaplex instances.
  • Group: Changes to groups (creation, deletion, and update).
  • Session: Session start and end times for users.
  • Snaplex: Alerts to changes in Snaplex state, size or condition
  • Snaplex Node: Threshold violations for performance.
  • Task: Threshold violations for performance and reliability.
  • User: Changes to SnapLogic login credentials and access.

Managing Notifications

As an Org admin, you can create notification rules, view and delete notifications, and use them for tracking Snaplex congestion.

Creating Notification Rules

  1. Navigate to SnapLogic Manager > Settings, scroll down the page to Alerts/Activity Log Notifications, and click Settings.



  2. In the Settings > Notifications page, click Create Notification to display the Create Notification Rule dialog.


  3. In the Create Notification Rule dialog, click Event Type to display the drop-down list:

    See Event Type Parameters for a list of the Event Types and associated fields.

  4. Select the target Event Type and enter information for the displayed fields. 

    • For notification recipients, enter the recipient's email address or Slack channel. To send a direct message, enter the Slack username. 
    • For specific parameters for each event type, see the Event Type Parameters.

  5. Click Save to exit.

You can go to Settings > Notifications to validate that your notification is created. 

Viewing Alert Information

  1. Log in to SnapLogic and click the Manager tab.
    The Organization Settings page appears to display the Settings controls.

  2. In the left pane, click Alerts to display All the alerts in an Org.


  3. To filter the Open and Closed alerts, click the corresponding tabs.

  4. To filter the alerts by time period, enter the target Start and End dates.

  5. (Optional) Click the download icon () to download as a CSV file.

Updating Notifications

  1. Navigate to SnapLogic Manager > Settings, scroll down the page to Alerts/Activity Log Notifications, and click Settings.


  2. In the Settings > Notifications page, click any notification to display the Edit Notification Rule dialog:


  3. Edit the notification as required and click Save.

    You can make the following changes:
    • Event Type. Change to any event type.
    • Projects to notify. Select target project folders
    • Email. Add or remove email addresses.
    • Slack Recipients. Add or remove Slack channels and usernames.

Deleting a Notification

  1. Log in to SnapLogic and click the Manager tab.
    The Organization Settings page appears to display the Settings controls.

  2. Scroll down the page to Alerts/Activity Log Notifications and click Settings.
    The Settings > Notifications page displays the list of alerts.


  3. Click the Delete Notification icon () next to the alert that you want to delete.
    The alert disappears from the list.

Use Alerts to Track Snaplex Congestion

Snaplex alerts are generated in the following scenarios:

  • One or more Pipelines are in the Queued state on a Snaplex for more than:
    • the 75% of their respective Time To Live (TTL), or
    • the maximum time that SnapLogic attempts to execute a Pipeline.
    At most, one alert is generated per Snaplex regardless of the number of Pipelines over the threshold. The default Pipeline TTL is 5 minutes.
  • The daily API usage exceeds 75% of the limit.

  • The concurrent API usage exceeds 75% of the limit.

You must always investigate the cause of a Snaplex congestion Alert. Frequently queuing Alerts indicate that either the Snaplex needs more capacity or the running Pipelines need a redesign.

Open Alerts

A scheduled job runs every 5 minutes to monitor the queued Pipelines. If it detects any Pipeline above the 75% of TTL threshold at that instant, it generates an Open Alert. However, if an Open Alert already exists for that Snaplex, a new Alert is not generated. The previous Open Alert remains in the same state. 

After generating an Open Alert the scheduled job repeats monitoring the Pipelines that have been queued for more than 75% of their respective TTLs. If there are no Pipelines above the threshold for that Snaplex, the Alert is resolved and its state changes to Closed. 

Event Type Parameters

Use the following table to understand the event types and corresponding parameters for creating notification rules in different scenarios.


Event TypeEvent Type Specific ParametersSuggested Action for Recipients
ACLACL addProjects to notify: Select the Projects from the drop-down list to which this event applies.Consult your Org admin if you have received this notification. Your access to a project might have changed.
ACL remove
APIConcurrent API usageThreshold: Enter the limit as a percentage of usage allowed.

Recipients
: Enter the email addresses of the intended recipients of the event.
Monitor your usage of APIs. Consult your Org admin if the percentage needs to be increased.
Daily API usage
Asset

Asset create

Projects to notify: Select the Projects from the drop-down list to which this event applies.Consult your Org admin if your assets have been deleted moved, renamed, or if ownership has changed without your knowledge.

Asset delete

Asset move

Asset owner change

Asset rename

Asset update
Dist

Dist change

N/ANone: Informational
Dist override
Group

Group create

N/A


None: Informational


Group delete

Group update
Session

Session start

N/A

None: Informational

The notification indicates which user (by user email) started or ended a session and the following details about the user:

  • The Org to which the user accessed.
  • The IP address of the user.
Session end
SSO session login
Snaplex

Snaplex congestion

N/AChoose another Snaplex from which to run your Pipelines.
Snaplex node add

Snaplex node connection rejected

Snaplex node enter maintenance mode
Snaplex node leave maintenance mode
Snaplex node restart
Snaplex nodeSnaplex node cpu load avg

Load average: Enter the load average. When the CPU usage exceeds this value, a notification is sent. 

For example, for a quad-core machine, a load average of 4 would equate to a CPU utilization of 100%. You can set the load average to any number less than 4 (such as 3 or 3.5) to get alerts. 

Snaplex: Select the target Snaplex from the drop-down list.

Run your Pipelines on another Snaplex until more resources are allocated to the Snaplex or activity by other users decreases.
Snaplex node disk usage

Threshold: Enter this value as the remaining amount of disk space. Make sure you specify the capacity size in GB, MB, KB. When the free space available falls below this value, the alert notification is sent.
Snaplex: Select the target Snaplex from the drop-down list.
Type of the disk space: Enter the filesystem type (NFS, CIFS, TMP).
Name of the disk space: User given name for the space, if any.

Usage

  • If the type and name fields are not specified, then the check is done for all mounts, except system mounts: /proc, tmpfs, devtmpfs, rootfs.
  • If the type is specified and not the name, the check is done for all the mounts of the given type.
  • If the name is specified but not the type, the check is done for all the mounts with that given name and all mount types, except system mounts.
Run your Pipelines on another Snaplex until more resources are allocated to the Snaplex or activity by other users decreases.
Snaplex node memory usage

Threshold: Enter the threshold as a percentage of the amount of memory the user is limited to.

Snaplex: Select the target Snaplex from the drop-down list.

Run your Pipelines on another Snaplex until more resources are allocated to the Snaplex or activity by other users decreases.
TaskTask execution duration - percentage of normal

Threshold: Enter the threshold as a percentage based on the 30-day historical executions.

Investigate the following potential issues that could prevent the Task execution from completion: 

  1. The Snaplex is running low on resources, such as CPU, memory, or network bandwidth.
  2. The endpoint that the Pipeline is connecting to is congested or not available.
  3. The Pipeline is processing an unusually large number of documents or large-sized documents.
Task execution duration - time limitThreshold: Enter the threshold in minutes.

Apply to: Select one of the following options.

  • All Tasks: Applies the alert to all Tasks in your Org.
  • Only Infrequent Tasks: Applies the alert only to Tasks that are not run regularly.
UserPassword changeN/AConsult your Org admin about your sign-on access.
Password reset

Password reset link

User authentication failure
User create
User delete
User lockout
User unlock
User update


Snaplex Node Notification Threshold Watermarks

You can adjust the behavior of the alerting system with threshold watermarks. In some scenarios, an alert is set against a CPU, memory, or disk resource that is overutilized, but not directly by Pipeline executions. For example, a disk alert might be triggered by accumulative files in a /temp directory mounted on the Snaplex node; in this case, the Org admin would put the Snaplex in maintenance mode and devops might clear the space in the directory. Threshold watermarks enhance the reporting accuracy of Snaplex node alerts and can be used to reduce the frequency of alerts.

For memory and CPU usage, the alert is removed when the usage falls below the lower watermark which is 40% below the threshold by default. For example: If you have set a threshold of 80% for memory usage, and there is an an alert present that is addressed by a user action, then the alert is removed from the Dashboard when the memory goes below 0.4 * 80 = 32%. Similarly, for disk alerts the high watermark is 40% above the threshold. So if the free space on the disk extends beyond 40% of the threshold then the alert is removed.


You can configure the following threshold watermarks through enabling a feature flag for your Org.

Enabling the Threshold Watermark Feature Flag

  1. Obtain your Org ID by navigating to Manager > Settings. You can find your Org ID below Organization Id at the top of the Settings page. Alternatively, you can run the following API call: 
    https://elastic.snaplogic.com/api/1/rest/asset/<org_name>
    The API call requires authentication. In the returned response, the Org Id is the value to the org_snode_id key.

  2. Check to see if you have any feature flags already set for your Org.

    Important

    If you have other existing feature flags set for your Org, then they must be appended to the request in Step 3. Contact SnapLogic Support for questions about current feature flags.

    1. Make the following request from a browser:

      https://elastic.snaplogic.com/api/1/rest/admin/snappack/org-dist/<org_snode_id>
      Sample Response
      {
          "response_map": {
            "overrides": {},
            "_id": "52e99318640a9a03d8681d0d",
            "flag_overrides": {
                <Existing_feature_flag>
                                 },
            "dist_id": "latest"
                              },
          "http_status_code": 200
      }

      Where <Existing_feature_flags> are the feature flags that are already enabled in the Org.

    2. Make note of any existing feature flags for Step 3.

  3. Apply the following feature flag to a specific Org, appending any existing feature flags from Step 2.

    "com.snaplogic.cc.service.UsageMonitorServiceImpl.LOW_WATERMARK = 0.4"
    "com.snaplogic.cc.service.UsageMonitorServiceImpl.HIGH_WATERMARK = 1.04"
    Sample Curl Command for Enabling Threshold Watermarks

    curl -u <org_admin_username> -H 'Content-Type: application/json' --data-binary '{"flag_overrides": { "com.snaplogic.cc.service.UsageMonitorServiceImpl.LOW_WATERMARK = 0.4":"true", "com.snaplogic.cc.service.UsageMonitorServiceImpl.HIGH_WATERMARK = 1.04":"true"...
             <Existing_feature_flags>
    ...}}' https://elastic.snaplogic.com/api/1/rest/admin/snappack/org-dist/<org_snode_id>

    Where:


    • The org_admin_username is the username of the Org admin.


    • The org_snode_id value is the Org ID (for example: 52e44318640a9a03d8681d0d).


    • <Existing_feature_flag> indicates any existing feature flags from Step 2a.

  4. To verify that the threshold watermark feature flag is enabled for a specific Org, make the following request in a browser:

    Request
    https://elastic.snaplogic.com/api/1/rest/admin/snappack/org-dist/<org_snode_id> 
  5. Navigate to the Dashboard to monitor the resource utilization of your Snaplex nodes against the alert reporting.


To verify that the threshold watermarks are enabled for a specific Org, make the following request in a browser:

https://elastic.snaplogic.com/api/1/rest/admin/snappack/org-dist/<org_snode_id>