Start your 14-day free trial today

No Credit Card Required

Try Logit.io Free

Already have an account? Sign In

Send data via NGINX Metrics to your Logstash instance provided by Logit.io

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.

Step 1 - Install MetricbeatCopy

deb (Debian/Ubuntu/Mint)

curl -L -O https://artifacts.elastic.co/downloads/beats//-oss-7.15.1-amd64.deb
sudo dpkg -i -oss-7.15.1-amd64.deb

rpm (CentOS/RHEL/Fedora)

curl -L -O https://artifacts.elastic.co/downloads/beats//-oss-7.15.1-x86_64.rpm
sudo rpm -vi -oss-7.15.1-x86_64.rpm

macOS

curl -L -O https://artifacts.elastic.co/downloads/beats//-oss-7.15.1-darwin-x86_64.tar.gz
tar xzvf -oss-7.15.1-darwin-x86_64.tar.gz

Windows

  • Download and extract the Windows zip file.
  • Rename the -<version>-windows directory to ``.
  • Open a PowerShell prompt as an Administrator.
  • Run the following to install as a Windows service:
.\install-service-.ps1
If script execution is disabled on your system, you need to set the execution policy for the current session to allow the script to run. For example: PowerShell.exe -ExecutionPolicy UnRestricted -File .\install-service-.ps1.
My OS isn't here! Chat to support now

Step 2 - Copy configuration fileCopy

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

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

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

metricbeat.config.modules:
  # 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 =======================
setup.template.settings:
  index.number_of_shards: 1
  index.codec: best_compression
  #_source.enabled: false

# ================================== Outputs ===================================
# ------------------------------ Logstash Output -------------------------------
<div class="sw-warning">
    <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>
</div> 

Step 3 - Enable moduleCopy

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

deb/rpm

metricbeat modules list
metricbeat modules enable nginx

macOS

./metricbeat modules list
./metricbeat modules enable nginx

Windows

PS > .\metricbeat.exe modules enable nginx

Step 4 - Configure moduleCopy

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
  metricsets:
    - stubstatus
  period: 10s

  # NGINX hosts
  hosts: ["http://127.0.0.1"]

  # 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 MetricbeatCopy

Ok, time to start gathering metrics!

deb/rpm

sudo systemctl enable metricbeat
sudo systemctl start metricbeat

macOS

./metricbeat

Windows

PS C:\Program Files\Metricbeat> Start-Service metricbeat

Step 6 - how to diagnose no data in StackCopy

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 7 - CompatibilityCopy

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

Step 8 - NGINX Module DashboardCopy

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

Predefined Kibana dashboard

Toggle View

Expand View

Return to Search

© 2022 Logit.io Ltd, All rights reserved.