Lightmesh Alerting system documentation

Alerting

The Lightmesh Alerting System is divided into three primary components:

Alert Destinations

In the Alert Destination section, Lightmesh currently supports integration with the following third-party destinations:

  1. Slack: Receive alerts directly in your Slack workspace.
  2. Microsoft Teams: Receive alerts in your Microsoft Teams channels.
  3. Email: Get email notifications for alerts.

Alert Rules

Under Alert Rules, Lightmesh provides alerting functionality for two key metrics:

  1. Network Capacity: Receive alerts when network capacity thresholds are exceeded. Network capacity refers to the utilization of IP addresses within the subnet. Alerts are triggered at predefined thresholds such as 80%, 90%, 95%, and 99% capacity.

  2. Network Requests: Get notified when there’s a surge in network requests. This occurs when a person with the Requestor role requests certain IP addresses within a subnet. Alerts are generated to notify administrators of such requests.

  3. NMAP Scan Results: Alerts are generated when an NMAP scan is initiated. The alert will provide the total number of scan results and highlight any conflicts, if present. This allows administrators to promptly address potential issues detected by the scan.

In-App Alerts

Additionally, Lightmesh offers in-app notifications for Network Capacity, Network Requests and NMAP Scan Results, ensuring that you stay informed within the platform itself.

Setting Up Alert Destinations

Slack Integration

  1. Navigate to the Admin section within Lightmesh.
  2. Go to the Alerts submenu.
  3. Click on “Add Alert Destination”.
  4. Provide a title for this integration.
  5. Select “Slack” as the platform.
  6. Type the Slack Channel you wish to recieve alerts at.
  7. Enter the complete Webhook URL
  8. Submit the form.
  9. Check your slack channel for a verification code.
  10. Once received, return to Admin > Alerts.
  11. Find the pending integration and click “Verify”.
  12. Enter the verification code in the provided form.
  13. Once verified, your Slack integration is complete.

Alert Slack

Microsoft Teams Integration

  1. Follow steps 1-4 as outlined above for Slack integration.
  2. Select “Microsoft Teams” as the platform.
  3. Enter the complete Webhook URL
  4. Submit the form.
  5. Check your teams channel for a verification code.
  6. Once received, return to Admin > Alerts.
  7. Find the pending integration and click “Verify”.
  8. Enter the verification code in the provided form.
  9. Once verified, your Microsoft Teams integration is complete.
  10. Obtain the webhook URL from your Microsoft Teams channel settings.
  11. Configure the webhook URL within Lightmesh to complete the integration.

Alert Teams

Email Integration

  1. Follow steps 1-4 as outlined above for Slack integration.
  2. Select “Email” as the platform.
  3. Enter the email you wish to recieve the alerts at.
  4. Submit the form.
  5. Check your email for a verification code.
  6. Once received, return to Admin > Alerts.
  7. Find the pending integration and click “Verify”.
  8. Enter the verification code in the provided form.
  9. Once verified, your Email integration is complete.

Alert Email

Setting Up Alert Rules

  1. Navigate to Admin > Alerts.
  2. Select “Alert Rules” from the left-hand navigation bar.
  3. Click on “Add Alert Rule”.
  4. Choose the type of rule: either “Network Requests”, “Network Capacity” or “NMAP Scan Results”.
  5. Select the status as either “Active” or “Inactive”.
  6. Provide a title for the rule.
  7. Choose the subnet for which you wish to receive alerts.
  8. Select the destination where you want to receive the alerts (Email, Teams, or Slack).
  9. Optionally, add a description for the rule.
  10. Hit submit to save the rule.

Ensure that you have configured the appropriate alert destinations before setting up alert rules to receive notifications effectively.

Alert Rules

Setting Up In-App Alerts

  1. Navigate to the desired subnet for which you wish to receive alerts.
  2. Go to the “Alerts” section.
  3. Click on “Add Alert Rule”.
  4. Choose the type of rule: either “Network Requests”, “Network Capacity” or “NMAP Scan Results”.
  5. Choose the status as either “Active” or “Inactive”.
  6. Type the title for the alert.
  7. Optionally, add a description.
  8. Select the user of the workspace who will receive the alerts.
  9. Hit submit to save the alert rule.

Alert Rules

Obtaining Webhook URLs

To obtain webhook URLs for Slack and Microsoft Teams integrations:

  • Slack: Go to your Slack workspace’s settings and navigate to the “Incoming Webhooks” section. Create a new webhook for Lightmesh and copy the generated URL.
  • Microsoft Teams: In your Microsoft Teams channel settings, go to the “Connectors” tab and add a new incoming webhook connector. Generate a webhook URL and copy it for use in Lightmesh.