Apache monitoring integration

Our Apache integration reports data from your Apache web server to the New Relic platform. You can view dashboards of your Apache metric data, create alert policies, and create your own custom queries and charts.

To get the most out of this page, select the installation method that fits your environment. You need a New Relic account before starting the installation process.

Tip

Use guided install to quickly see your data in the UI

The guided install is a single CLI command you can run to monitor your instance. It's a good option for small organizations, or for anyone who wants to test out New Relic.

Guided install

EU guided install

For a more permanent and scalable solution, we recommend the standard manual install of the agent: keep reading for how to do that.

Apache configuration options

The Apache integration collects both metrics and inventory information. This table provides a description for each config setting and whether it applies to metrics, inventory, or both.

Setting	Description	Default	Applies to
`STATUS_URL`	The URL set up to provide the metrics using the status module.	`http://127.0.0.1/server-status?auto`	Metrics, inventory
`REMOTE_MONITORING`	Enable multi-tenancy monitoring.	`true`	Metrics, inventory
`BINARY_PATH`	Set location of the Apache binary file.	[None]	Inventory
`CA_BUNDLE_FILE`	Alternative certificate authority bundle file.	[None]	Metrics
`CA_BUNDLE_DIR`	Alternative certificate authority bundle directory.	[None]	Metrics
`VALIDATE_CERTS`	Set to `false` if the status URL is HTTPS with a self-signed certificate.	`true`	Metrics
`METRICS`	Set to `true` to enable metrics-only collection.	`false`
`INVENTORY`	Set to `true` to enable inventory-only collection.	`false`

Example configurations

Here are some example YAML configurations:

This is a very basic configuration to collect metrics and inventory from your localhost:

integrations:
  - name: nri-apache
    env:
      METRICS: "true"
      STATUS_URL: http://127.0.0.1/server-status?auto
      REMOTE_MONITORING: true
    interval: 15s
    labels:
      env: production
      role: load_balancer

  - name: nri-apache
    env:
      INVENTORY: "true"
      STATUS_URL: http://127.0.0.1/server-status?auto
      REMOTE_MONITORING: true
    interval: 60s
    labels:
      env: production
      role: load_balancer
    inventory_source: config/apache

This configuration collects metrics and inventory from your localhost protected with basic authentication. Replace the username and password on the STATUS_URL with your credentials:

integrations:
  - name: nri-apache
    env:
      METRICS: "true"
      STATUS_URL: http://username:password@127.0.0.1/server-status?auto
      REMOTE_MONITORING: true
    interval: 15s
    labels:
      env: production
      role: load_balancer

  - name: nri-apache
    env:
      INVENTORY: "true"
      STATUS_URL: http://username:password@127.0.0.1/server-status?auto
      REMOTE_MONITORING: true
    interval: 60s
    labels:
      env: production
      role: load_balancer
    inventory_source: config/apache

By default the integration tries to detect the Apache binary on these 2 different locations: /usr/sbin/httpd and /usr/sbin/apache2ctl. If your Apache is installed on a custom location or you are using MS Windows, use the BINARY_PATH setting to specify the correct location and filename of your Apache binary:

integrations:
  - name: nri-apache
    env:
      METRICS: "true"
      STATUS_URL: http://127.0.0.1/server-status?auto
      REMOTE_MONITORING: true
    interval: 15s
    labels:
      env: production
      role: load_balancer

  - name: nri-apache
    env:
      INVENTORY: "true"
      STATUS_URL: http://127.0.0.1/server-status?auto
      BINARY_PATH: 'C:\Apache\bin\httpd.exe'
      REMOTE_MONITORING: true
    interval: 60s
    labels:
      env: production
      role: load_balancer
    inventory_source: config/apache

In this configuration we only have one integration block with METRICS: true to collect only metrics and added VALIDATE_CERTS: false to prevent validation of the server's SSL certificate when using a self-signed one:

integrations:
  - name: nri-apache
    env:
      METRICS: "true"
      STATUS_URL: https://my_apache_host/server-status?auto
      VALIDATE_CERTS: false
      REMOTE_MONITORING: true
    interval: 15s
    labels:
      env: production
      role: load_balancer

In this configuration we only have one integration block with METRICS: true to collect only metrics and added CA_BUNDLE_FILE pointing to an alternative certificate file:

integrations:
  - name: nri-apache
    env:
      METRICS: "true"
      STATUS_URL: https://my_apache_host/server-status?auto
      CA_BUNDLE_FILE: '/etc/ssl/certs/custom-ca.crt'
      REMOTE_MONITORING: true
    interval: 15s
    labels:
      env: production
      role: load_balancer

In this configuration we are using the environment variable APACHE_STATUS to populate the STATUS_URL setting of the integration:

integrations:
  - name: nri-apache
    env:
      METRICS: "true"
      STATUS_URL: { { APACHE_STATUS } }
      REMOTE_MONITORING: true
    interval: 15s
    labels:
      env: production
      role: load_balancer

In this configuration we are monitoring multiple Apache servers from the same integration. For the first instance (STATUS_URL: https://1st_apache_host/server-status?auto) we are collecting metrics and inventory while for the second instance (STATUS_URL: https://2nd_apache_host/server-status?auto) we will only collect metrics.

integrations:
  - name: nri-apache
    env:
      METRICS: "true"
      STATUS_URL: https://1st_apache_host/server-status?auto
      REMOTE_MONITORING: true
    interval: 15s
    labels:
      env: production
      role: load_balancer
  - name: nri-apache
    env:
      INVENTORY: "true"
      STATUS_URL: https://1st_apache_host/server-status?auto
      REMOTE_MONITORING: true
    interval: 60s
    labels:
      env: production
      role: load_balancer
    inventory_source: config/apache

  - name: nri-apache
    env:
      METRICS: "true"
      STATUS_URL: http://2nd_apache_host/server-status?auto
      REMOTE_MONITORING: true
    interval: 15s
    labels:
      env: production
      role: load_balancer

Labels

You can further decorate your metrics using labels. Labels allow you to add attributes (key/value pairs) to your metrics, which you can then use to query, filter, or group your metrics.

Our default sample config file includes examples of labels but, because they're not mandatory, you can remove, modify, or add new ones of your choice. The following example adds the attribute 'production:load_balancer' to reported metrics.

labels:
  env: production
  role: load_balancer

Metric data

The Apache integration collects the following metric data attributes. Each metric name is prefixed with a category indicator and a period, such as net. or server..

Name	Description
`net.bytesPerSecond`	Rate of the number of bytes served, in bytes per second.
`net.requestsPerSecond`	Rate of the number of client requests, in requests per second.
`server.busyWorkers`	Current number of busy workers.
`server.idleWorkers`	Current number of idle workers.
`server.scoreboard.closingWorkers`	Current number of workers closing TCP connection after serving the response.
`server.scoreboard.dnsLookupWorkers`	Current number of workers performing a DNS lookup.
`server.scoreboard.finishingWorkers`	Current number of workers gracefully finishing.
`server.scoreboard.idleCleanupWorkers`	Current number of idle workers ready for cleanup.
`server.scoreboard.keepAliveWorkers`	Current number of workers maintaining a keep-alive connection.
`server.scoreboard.loggingWorkers`	Current number of workers that are logging.
`server.scoreboard.readingWorkers`	Current number of workers reading requests (headers or body).
`server.scoreboard.startingWorkers`	Current number of workers that are starting up.
`server.scoreboard.totalWorkers`	Total number of workers available. Workers that are not needed to process requests may not be started.
`server.scoreboard.writingWorkers`	Current number of workers that are writing.

Inventory data

Inventory data captures the version numbers from running Apache and from all loaded Apache modules. Those version numbers are added under the config/apache namespace. For more about inventory data, see Understand data.

System metadata

Besides the standard attributes collected by the infrastructure agent, the integration collects inventory data associated with the ApacheSample event type:

Name	Description
`software.version`	The version of the Apache server. Example: `Apache/2.4.7 (Ubuntu)`.

Troubleshooting

If you are having issues accessing the HTTPS endpoint for Apache, here are two possible solutions:

Although you cannot ignore the SSL certification, you can set the config file parameters ca_bundle_file and ca_bundle_dir to point to an unsigned certificate in the Apache config file. Example:

instances:
  - name: apache-server-metrics
command: metrics
arguments:
  status_url: http://127.0.0.1/server-status?auto
  ca_bundle_file: /etc/newrelic-infra/integrations.d/ssl/b2b.ca-bundle

An example using ca_bundle_dir:

ca_bundle_dir: /etc/newrelic-infra/integrations.d/ssl

Alternatively, you can use HTTP instead of HTTPS.

Apache monitoring integration

Tip

Apache configuration options

Example configurations

Basic configuration

HTTP basic authentication

Custom Apache binary location

Metrics only with self-signed certificate

Metrics only with alternative certificate

Environment variables replacement

Multi-instance monitoring

Labels

Metric data

Inventory data

System metadata

Troubleshooting

Problem accessing HTTPS endpoint for Apache

Apache monitoring integration

Tip

Apache configuration options .css-21sua1{background:none;border:none;width:0;padding:0;}

Example configurations

HTTP basic authentication

Custom Apache binary location

Metrics only with self-signed certificate

Metrics only with alternative certificate

Environment variables replacement

Multi-instance monitoring

Labels

Metric data

Inventory data

System metadata

Troubleshooting

Problem accessing HTTPS endpoint for Apache

Apache configuration options