Skip to main content
Sumo Logic

Install the Nginx Ingress App, Alerts, and View the Dashboards

This page provides instructions for installing the Nginx Ingress App, as well as examples of each of the App dashboards. These instructions assume you have already set up the collection as described in the Collect Logs and Metrics for the Nginx Ingress App page.

Pre-Packaged Alerts

Sumo Logic has provided out-of-the-box alerts available through Sumo Logic monitors to help you monitor your Nginx Ingress farms. These alerts are built based on metrics and logs datasets and include preset thresholds based on industry best practices and recommendations.

For details on the individual alerts, see this page.

Installing Monitors

  • To install these alerts, you need to have the Manage Monitors role capability.
  • Alerts can be installed by either importing a JSON file or a Terraform script.
Install the monitors by importing a JSON file Method
  1. Download the JSON file that describes the monitors. 
  2. The JSON contains the alerts that are based on Sumo Logic searches that do not have any scope filters and therefore will be applicable to all Nginx Ingress farms, the data for which has been collected via the instructions in the previous sections. However, if you would like to restrict these alerts to specific farms or environments, update the JSON file by replacing the text webserver_system=nginx_ingress with ‘<Your Custom Filter>.  

Custom filter examples: 

  1. For alerts applicable only to a specific farm, your custom filter would be:  ‘webserver_farm=nginx-ingress.01
  2. For alerts applicable to all farms that start with nginx-ingress, your custom filter would be: webserver_system=nginx-ingress*
  3. For alerts applicable to a specific farm within a production environment, your custom filter would be: webserver_farm=nginx-ingress-1 AND environment=dev (This assumes you have set the optional environment tag while configuring collection)
  4. Go to Manage Data > Alerts > Monitors.
  5. Click Add:
    Add monitors page.png
  6. Click Import and then copy-paste the above JSON to import monitors.
Install the alerts using a Terraform script Method
  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. Identify which deployment your Sumo Logic account is in, using this link.
  2. Download and install Terraform 0.13 or later. 
  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 through the “git clone” command or as a zip file. 
  4. Alert Configuration. 
    After the package has been extracted, navigate to the package directory terraform-sumologic-sumo-logic-monitor/monitor_packages/Nginx Ingress/

Edit the nginx_ingress.auto.tfvars file and add the Sumo Logic Access Key, Access Id and Deployment from Step 1.

access_id   = "<SUMOLOGIC ACCESS ID>"
access_key  = "<SUMOLOGIC ACCESS KEY>"
environment = "<SUMOLOGIC DEPLOYMENT>"

The Terraform script installs the alerts without any scope filters, if you would like to restrict the alerts to specific farms or environments, update the variable ’nginx_ingress_data_source’. Custom filter examples: 

  1. A specific farm webserver_farm=nginx.ingress.01
  2. All farms in an environment environment=dev'
  3. For alerts applicable to all farms that start with nginx ingress, your custom filter would be: ‘webserver_farm=nginx-ingress*
  4. For alerts applicable to a specific farm within a production environment, your custom filter would be: 

webserver_system=nginx_ingress-1 and environment=dev (This assumes you have set the optional environment tag while configuring collection)

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

By default, the monitors are configured in a monitor folder called “Nginx Ingress”, if you would like to change the name of the folder, update the monitor folder name in “folder” key at nginx_ingress.auto.tfvars file.

If you would like the alerts to send email or connection notifications, configure these in the file nginx_ingress_notifications.auto.tfvars. For configuration examples, refer to the next section.

  1. Email and Connection Notification Configuration Examples
    Modify the file nginx_ingress_notifications.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 by 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"]
    }
  ]
  1. Install the Alerts
    1. Navigate to the package directory terraform-sumologic-sumo-logic-monitor/monitor_packages/Nginx Ingress/ and run terraform init. This will initialize Terraform and will download the required components.
    2. Run terraform plan to view the monitors which will be created/modified by Terraform.
    3. Run terraform apply.
  2. Post Installation
    If you haven’t enabled alerts and/or configured notifications through the Terraform procedure outlined above, we highly recommend enabling alerts of interest and configuring each enabled alert to send notifications to other users or services. This is detailed in Step 4 of this document.

Install the Sumo Logic App

This section demonstrates how to install the Nginx Ingress 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. 
  • Choose Enter a Custom Data Filter, and enter a custom Nginx Ingress farm filter. Examples: 

  1. For all Nginx Ingress farms
    webserver_farm=*.
  2. For a specific farm
    webserver_farm=nginx-ingress.dev.01.
  3. Farms within a specific environment
    webserver_farm=nginx-ingress.dev.01 and environment=prod
    (This assumes you have set the optional environment tag while configuring collection).
  4. Advanced. Select the Location in Library (the default is the Personal folder in the library), or click New Folder to add a new folder.
  5. Click Add to Library.

Once an app is installed, it will appear in your Personal folder, or another 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.

Dashboards

Nginx Ingress - Overview

The Nginx Ingress - Overview dashboard provides an at-a-glance view of the NGINX 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 Ingress - Error Logs

The Nginx 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.

The Nginx 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 Ingress - Trends

The Nginx 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 Ingress - Outlier Analysis

The Nginx 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 Ingress - Threat Intel

The Nginx 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 Ingress - Web Server Operations

The Nginx - 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 Ingress - Visitor Access Types

The Nginx 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 Ingress - Visitor Locations

The Nginx 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 Ingress - Visitor Traffic Insight

The Nginx 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 Ingress - Connections and Requests Metrics

The Nginx Ingress - Connections and Requests Metrics dashboard provides insight into active, dropped connections, reading, writing, and waiting requests.

Use this dashboard to:

  • Gain information about active and dropped connections. This helps you identify the connection rejected by Nginx Server.
  • Gain information about the total requests handled by Nginx Server per second. This helps you understand read, write requests on Nginx Server.

Nginx Ingress - Ingress Controller Metrics

The Nginx Ingress - Ingress Controller Metrics dashboard gives you insight on the status, reloads, failure of kubernetes Nginx 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.