Get a DemoStart Free TrialSign In

NGINX Metrics

Collect and ship NGINX server metrics to Logstash and Elasticsearch.

Metricbeat is a lightweight shipper that helps you monitor your NGINX web servers by collecting metrics running on the NGINX server. Configure Metricbeat using the pre-defined examples below to collect and ship NGINX web service metrics and statistics to Logstash or Elasticsearch.

Follow this step by step guide to start sending data from your system to

Step 1 - Install Metricbeat

To get started first follow the steps below:

Older versions can be found here metricbeat 7, metricbeat 6, metricbeat 5

Step 2 - Copy configuration file

The configuration file below is pre-configured to send data to your Stack via Logstash.

Copy the configuration file below and overwrite the contents of metricbeat.yml.

###################### Metricbeat Configuration #######################
# =========================== Modules configuration ============================

  # Glob pattern for configuration loading
  path: ${path.config}/modules.d/*.yml

  # Set to true to enable config reloading
  reload.enabled: false

  # Period on which files under path should be checked for changes
  #reload.period: 10s
# ======================= Elasticsearch template setting =======================
  index.number_of_shards: 1
  index.codec: best_compression
  #_source.enabled: false

# ================================== Outputs ===================================
# ------------------------------ Logstash Output -------------------------------
<div class="sw-warning">
        <img src="/images/source-wizard/warning-triangle.svg">
       <b>No input available! </b> Your stack is missing the required input for this data source <a href="#" onclick="Intercom('showNewMessage')" class="btn btn-info btn-sm">Talk to support to add the input</a>

Step 3 - Enable module

There are several built in metricbeat modules you can use. To enable the NGINX module, run the following:


metricbeat modules list
metricbeat modules enable nginx


./metricbeat modules list
./metricbeat modules enable nginx


PS > .\metricbeat.exe modules enable nginx

Step 4 - Configure module

Each module has its own configuration file where different metricsets can be enabled / disabled. Locate the configuration file for the NGINX module.

deb/rpm /etc/metricbeat/modules.d/nginx.yml

mac/win ~/<EXTRACTED_ARCHIVE>/modules.d/nginx.yml

By default the stubstatus metricset is disabled. To enable or disable a metric simply comment or uncomment the line out.

- module: nginx
    - stubstatus
  period: 10s

  # NGINX hosts
  hosts: [""]

  # Path to server status. Default server-status
  server_status_path: "nginx_status"

  #username: "user"
  #password: "secret"

In order for the status metricset to work and correctly display the dashboard on Kibana, you will need to enable ngx_http_stub_status on your NGINX web server.

Step 5 - Start Metricbeat

Start or restart metricbeat to apply the configuration changes.

Step 6 - Check for your logs

Data should now have been sent to your Stack.

View my data

If you don't see logs take a look at How to diagnose no data in Stack below for how to diagnose common issues.

Step 7 - how to diagnose no data in Stack

If you don't see data appearing in your Stack after following the steps, visit the Help Centre guide for steps to diagnose no data appearing in your Stack or Chat to support now.

Step 8 - Compatibility

The NGINX metricsets were tested with NGINX 1.9 and are expected to work with all versions >= 1.9.

Step 9 - NGINX Module Dashboard

The NGINX module comes with predefined Kibana dashboards. To view your dashboards for any of your stacks, launch Logs and choose Dashboards.

Predefined Kibana dashboard

Step 10 - NGINX Metricbeat Module Overview

The Metricbeat Module for NGINX is an expertly crafted tool designed to enhance the monitoring of NGINX servers by gathering crucial metrics. For those who have previously utilized Metricbeat for data collection across various platforms, its application to NGINX will be both familiar and remarkably efficient.

NGINX, known for its high performance, scalability, and ability to handle large volumes of concurrent connections, is a cornerstone in modern web architectures. The Metricbeat Module for NGINX taps into NGINX's status module to collect important metrics such as active connections, request rates, and error logs. This module thus provides vital insights into server performance, enabling proactive management and optimization.

This module is a favored choice among system administrators and DevOps professionals responsible for maintaining NGINX servers, thanks to its straightforward configuration and its seamless integration with the Elastic Stack. This powerful synergy offers an advanced platform for monitoring, visualizing, and analyzing NGINX metrics in real time, far surpassing the capabilities of traditional monitoring tools.

In contrast to other monitoring solutions that might use proprietary or inflexible formats, the Metricbeat Module for NGINX is designed for simplicity, thorough analysis, and ease of troubleshooting within NGINX environments.

Our platform extends robust support for the Metricbeat Module for NGINX, providing centralized metrics management designed for effortless analysis and active monitoring of your NGINX servers. This eliminates the need for manual metric collection and analysis across distributed server environments.

If you're seeking assistance with setting up the Metricbeat Module for NGINX or have any questions about how to best monitor your NGINX servers, the team is here to help. Feel free to visit our Help Centre or contact our support team through live chat & we'll be happy to assist.

Return to Search
Sign Up

© 2024 Ltd, All rights reserved.