Skip to main content
Sumo Logic

Install the Nginx Plus Ingress App, Monitors, and View the Dashboards

This page has instructions for installing the Sumo App and Alerts for Nginx Ingress ULM, as well as descriptions and examples for each of the dashboards.

This page has instructions for installing the Sumo App and Alerts for Nginx Ingress ULM, as well as descriptions and examples for each of the dashboards.

Installing Monitors

To install these alerts, you need to have the Manage Monitors role capability.

Alerts can be installed by either importing them via a JSON or via a Terraform script.

Method 1: Install the monitors by importing a JSON file:

  1. Download the JSON file describing all the monitors. 

  2. Replace $$logs_data_source with logs data source.

    • For example, _sourceCategory=Labs/NginxIngress/Logs

  3. Go to Manage Data > Alerts > Monitors.

  4. Click Add:

Add monitors page.png

  1. Click Import to import monitors from the JSON above.

Method 2: Install the monitors via a Terraform script

Step 1: Generate a Sumo Logic access key and ID

Generate an access key and access ID for a user that has the Manage Monitors role capability in Sumo Logic using these instructions. Please identify your Sumo Logic deployment.

Step 2: Download and install Terraform 0.13 or later 

Step 3: Download the Sumo Logic Terraform package for Nginx Ingress alerts

The alerts package is available in the Sumo Logic github repository. You can either download it via the “git clone” command or as a zip file. 

Step 4: Alert Configuration 

After the package has been extracted, navigate to the package directory terraform-sumologic-sumo-logic-monitor/monitor_packages/nginx-plus-ingress/

Edit the nginxplusingress.auto.tfvars file as per below instruction

  1. Add the Sumo Logic Access Key, Access Id, Deployment from Step 1.

    • access_id   = "<YOUR SUMO ACCESS ID>"

    • access_key  = "<YOUR SUMO ACCESS KEY>"

    • environment = "<DEPLOYMENT>"

  2. Add the data source values.

    • Logs_data_source - Sumo Logic data source for logs.

  3. All monitors are disabled by default on installation, if you would like to enable all the monitors, set the parameter monitors_disabled to false.

  4. All monitors are configured in a monitor folder called “Nginx Plus Ingress”, if you would like to change the name of the folder, update the parameter folder.

Step 5: Email and Connection Notification Configuration Examples

Modify the file nginxplusingress.auto.tfvars and populate connection_notifications and email_notifications as per below examples.

Pagerduty Connection Example:
connection_notifications = [
    {
      connection_type       = "PagerDuty",
      connection_id         = "<CONNECTION_ID>",
      payload_override      = "{\"service_key\": \"your_pagerduty_api_integration_key\",\"event_type\": \"trigger\",\"description\": \"Alert: Triggered {{TriggerType}} for Monitor {{Name}}\",\"client\": \"Sumo Logic\",\"client_url\": \"{{QueryUrl}}\"}",
      run_for_trigger_types = ["Critical", "ResolvedCritical"]
    },
    {
      connection_type       = "Webhook",
      connection_id         = "<CONNECTION_ID>",
      payload_override      = "",
      run_for_trigger_types = ["Critical", "ResolvedCritical"]
    }
  ]

Replace <CONNECTION_ID> with the connection id of the webhook connection. The webhook connection id can be retrieved via calling the Monitors API.

For overriding payload for different connection types, refer to this document.

Email Notifications Example:
email_notifications = [
    {
      connection_type       = "Email",
      recipients            = ["abc@example.com"],
      subject               = "Monitor Alert: {{TriggerType}} on {{Name}}",
      time_zone             = "PST",
      message_body          = "Triggered {{TriggerType}} Alert on {{Name}}: {{QueryURL}}",
      run_for_trigger_types = ["Critical", "ResolvedCritical"]
    }
  ]
}

Step 6: Install the Alerts

  1. Navigate to the package directory terraform-sumologic-sumo-logic-monitor/monitor_packages/nginx-plus-ingress/ and run terraform init. This will initialize Terraform and will download the required components.

  2. Run terraform plan to view the monitors resources which will be created/modified by Terraform.

  3. Run terraform apply.

Step 7: Post Installation steps

If you haven’t enabled alerts and/or configured notifications via the terraform procedure outlined above, we highly recommend enabling alerts of interest and configuring each enabled alert to send notifications to other people or services. This is detailed in Step 4.

Install the App

To install the app:

Locate and install the app you need from the App Catalog. If you want to see a preview of the dashboards included with the app before installing, click Preview Dashboards.

  1. From the App Catalog, search for and select the app. 

  2. Select the version of the service you're using and click Add to Library.

  1. To install the app, complete the following fields.

    1. App Name. You can retain the existing name, or enter a name of your choice for the app.


    2. Data Source. Select either of these options for the data source.


      • Choose Source Category, and select a source category from the list.


      • Choose Enter a Custom Data Filter, and enter a custom source category beginning with an underscore. Example: (_sourceCategory=MyCategory).


    3. Advanced. Select the Location in Library (the default is the Personal folder in the library), or click New Folder to add a new folder.

  2. Click Add to Library.

Once an app is installed, it will appear in your Personal folder, or other folder that you specified. From here, you can share it with your organization. 

Panels will start to fill automatically. It's important to note that each panel slowly fills with data matching the time range query and received since the panel was created. Results won't immediately be available, but with a bit of time, you'll see full graphs and maps. 

Dashboard Filter with Template Variables

Template variables provide dynamic dashboards that rescope data on the fly. As you apply variables to troubleshoot through your dashboard, you can view dynamic changes to the data for a fast resolution to the root cause. For more information, see the Filter with template variables help page.

Nginx Plus Ingress - Overview

The Nginx Plus Ingress - Overview dashboard provides an at-a-glance view of the nginx plus server access locations, error logs along with connection metrics.

Use this dashboard to:

  • Gain insights into originated traffic location by region. This can help you allocate computer resources to different regions according to their needs.
  • Gain insights into your Nginx health using Critical Errors and Status of Nginx Server.
  • Get insights into Active and dropped connection.

Nginx Plus Ingress - Error Logs Analysis

The Nginx Plus Ingress - Error Logs Analysis dashboard provides a high-level view of log level breakdowns, comparisons, and trends. The panels also show the geographic locations of clients and clients with critical messages, new connections and outliers, client requests, request trends, and request outliers.

Use this dashboard to:

  • Track requests from clients. A request is a message asking for a resource, such as a page or an image.
  • To track and view client geographic locations generating errors.
  • Track critical alerts and emergency error alerts.

Nginx Plus Ingress - Logs Timeline Analysis

The Nginx Plus Ingress - Logs Timeline Analysis dashboard provides a high-level view of the activity and health of Nginx servers on your network. Dashboard panels display visual graphs and detailed information on traffic volume and distribution, responses over time, as well as time comparisons for visitor locations and server hits.

Use this dashboard to:

  • To understand the traffic distribution across servers, provide insights for resource planning by analyzing data volume and bytes served.
  • Gain insights into originated traffic location by region. This can help you allocate compute resources to different regions according to their needs.

Nginx Plus Ingress - Outlier Analysis

The Nginx Plus Ingress - Outlier Analysis dashboard provides a high-level view of Nginx server outlier metrics for bytes served, number of visitors, and server errors. You can select the time interval over which outliers are aggregated, then hover the cursor over the graph to display detailed information for that point in time.

Use this dashboard to:

  • Detect outliers in your infrastructure with Sumo Logic’s machine learning algorithm. 
  • To identify outliers in incoming traffic and the number of errors encountered by your servers.

Nginx Plus Ingress - Threat Intel

The Nginx Plus Ingress - Threat Intel dashboard provides an at-a-glance view of threats to Nginx servers on your network. Dashboard panels display the threat count over a selected time period, geographic locations where threats occurred, source breakdown, actors responsible for threats, severity, and a correlation of IP addresses, method, and status code of threats.

Use this dashboard to:

  • To gain insights and understand threats in incoming traffic and discover potential IOCs. Incoming traffic requests are analyzed using the Sumo - Crowdstrikes threat feed.

Nginx Plus Ingress - Web Server Operations

The Nginx Plus Ingress - Web Server Operations dashboard provides a high-level view combined with detailed information on the top ten bots, geographic locations, and data for clients with high error rates, server errors over time, and non 200 response code status codes. Dashboard panels also show information on server error logs, error log levels, error responses by a server, and the top URIs responsible for 404 responses.

Use this dashboard to:

  • Gain insights into Client, Server Responses on Nginx Server. This helps you identify errors in Nginx Server.
  • To identify geo locations of all Client errors. This helps you identify client location causing errors and helps you to block client IPs.

Nginx Plus Ingress - Visitor Access Types

The Nginx Plus Ingress - Visitor Access Types dashboard provides insights into visitor platform types, browsers, and operating systems, as well as the most popular mobile devices, PC and Mac versions used.

Use this dashboard to:

  • Understand which platform and browsers are used to gain access to your infrastructure.
    These insights can be useful for planning in which browsers, platforms, and operating systems (OS) should be supported by different software services.

Nginx Plus Ingress - Visitor Locations

The Nginx Plus Ingress - Visitor Locations dashboard provides a high-level view of Nginx visitor geographic locations both worldwide and in the United States. Dashboard panels also show graphic trends for visits by country over time and visits by  US region over time.

Use this dashboard to:

  • Gain insights into geographic locations of your user base.  This is useful for resource planning in different regions across the globe.

Nginx Plus Ingress - Visitor Traffic Insight

The Nginx Plus Ingress - Visitor Traffic Insight dashboard provides detailed information on the top documents accessed, top referrers, top search terms from popular search engines, and the media types served.

Use this dashboard to:

  • To understand the type of content that is frequently requested by users. 
  • It helps in allocating IT resources according to the content types.

Nginx Plus Ingress - Ingress Controller Metrics

The Nginx Plus Ingress - Ingress Controller Metrics dashboard provides you insight on the status, reloads, failure of kubernetes Nginx Plus ingress controller.

Use this dashboard to:

  • Gain information about Nginx ingress Controller status and reloads. This helps you understand the availability of Nginx Ingress controllers.
  • Gain information about Nginx reload time and any reload errors.

Nginx Plus Ingress - HTTP Location Zones

The Nginx Plus Ingress - HTTP Location Zones metrics dashboard provides detailed statistics on the frontend performance, showing traffic speed, responses/requests count and various error responses.

Use this dashboard to:

  • Gain information about Location http zones traffic: received and sent; speed, requires/responses amount, discarded traffic.
  • Gain information about Location http zones error responses: percentage of responses by server, percentage of each type of error responses. 

Nginx Plus Ingress - HTTP Server Zones

The Nginx Plus Ingress - HTTP Server Zones metrics dashboard provides detailed statistics on the frontend performance, showing traffic speed, responses/requests count and various error responses.

Use this dashboard to:

  • Gain information about Server http zones traffic: received and sent; speed, requires/responses amount, discarded traffic.
  • Gain information about Server http zones error responses: percentage of responses by server, percentage of each type of error responses. 

Nginx Plus Ingress - HTTP Upstreams

The Nginx Plus Ingress - HTTP Upstreams metrics dashboard provides information about each upstream group for HTTP and HTTPS traffic, showing number of HTTP upstreams, servers, back-up servers, error responses and health monitoring.

Use this dashboard to:

  • Gain information about HTTP upstreams, servers and back-up servers.
  • Gain information about HTTP upstreams traffic: received and sent; speed, requires/responses amount, downtime and response time.
  • Gain information about HTTP upstreams error responses: percentage of responses by server, percentage of each type of error responses. 
  • Gain information about HTTP upstreams health monitoring.

Nginx Plus Ingress - Resolvers

The Nginx Plus Ingress - Resolvers metrics dashboard provides DNS server statistics of requests and responses per each DNS status zone.

Use this dashboard to:

  • Gain information about the total number of zones, responses and requests speed.
  • Gain information about error responses by each type of error.

Nginx Plus Ingress- TCP/UDP Upstreams

The Nginx Plus Ingress - TCP/UDP Upstreams metrics dashboard provides information about each upstream group for TCP and UDP traffic, showing number of TCP and UDP upstreams, servers, back-up servers, error responses and health monitoring.

Use this dashboard to:

  • Gain information about TCP and UDP upstreams, servers and back-up servers.
  • Gain information about TCP and UDP upstreams traffic: received and sent; speed, requests/responses amount, downtime and response time.
  • Gain information about TCP and UDP upstreams error responses: percentage of responses by server, percentage of each type of error responses.
  • Gain information about TCP and UDP upstreams health monitoring.

Nginx Plus Ingress - TCP/UDP Zones

The Nginx Plus Ingress - TCP/UDP Zones metrics dashboard provides TCP and UDP status zones with charts for connection limiting.

Use this dashboard to:

  • Gain information about TCP and UDP traffic: received and sent; speed, requires/responses amount, discarded traffic.
  • Gain information about TCP and UDP error responses: percentage of responses by server, percentage of each type of error responses.