Apache monitoring integration

Our Apache integration sends performance metrics and inventory data from your Apache web server to the New Relic platform. You can view pre-built dashboards of your Apache metric data, create alert policies, and create your own custom queries and charts.

The integration works by gathering data from Apache's status module, so that module must be enabled and configured for your Apache instance (more details in Requirements).

Read on to install the integration, and to see what data we collect.

Compatibility and requirements

Our integration is compatible with Apache versions 2.2 or 2.4.

Before installing the integration, make sure that you meet the following requirements:

Apache status module enabled and configured for Apache instance.
Apache status module endpoint (default server-status) available from the host containing the Apache integration.
If Apache is not running on Kubernetes or Amazon ECS, you must have the infrastructure agent installed on a Linux OS host that's running Apache. Otherwise:
- If running on Kubernetes, see these requirements.
- If running on ECS, see these requirements.

Quick start

The quickest way to get started is through our guided install.

Tip

Try our guided install for yourself. (If you're hosted in the EU, use our EU guided install.)

Install and activate

To install the Apache integration, follow the instructions for your environment:

Follow the instructions for installing an integration, using the file name nri-apache.
Change directory to the integration's folder:
```
cd /etc/newrelic-infra/integrations.d
```

Copy of the sample configuration file:

sudo cp apache-config.yml.sample apache-config.yml

Edit the apache-config.yml file as described in the configuration settings.
Restart the infrastructure agent.

Additional notes:

Advanced: Integrations are also available in tarball format to allow for install outside of a package manager.
On-host integrations do not automatically update. For best results, regularly update the integration package and the infrastructure agent.

Configure the integration

The Apache integration configuration is how you can set required login credentials and configure how data is collected. Which options you change depend on your setup and preference.

There are several ways to configure the integration, depending on how it was installed:

If enabled via Kubernetes: see Monitor services running on Kubernetes.
If enabled via Amazon ECS: see Monitor services running on ECS.
If installed on-host: edit the config in the integration's YAML config file, apache-config.yml.

Configuration options include:

metrics: This command captures the metrics of a particular Apache server. This takes a single argument:
- status_url: The URL set up to provide the metrics using the Apache status info module. Default value: http://127.0.0.1/server-status?auto. If you have customized your setup to use a different endpoint, you will need to set this value.
inventory: This command captures the modules loaded by Apache as inventory data, using Apache's binary file. To disable the collection of inventory data, delete the inventory command from the config file.
- status_url: The URL is used to attach the inventory data to the same Apache instance for which we collect metrics data.
labels: The env label controls the environment attribute. The default value is production.

For more about general configuration structure, see Configuration.

Activate remote monitoring

The remote_monitoring parameter enables remote monitoring and multi-tenancy for this integration.

Activating remote_monitoring may change some attributes and/or affect your configured alerts. For more information, see remote monitoring in on-host integrations.

Important

Infrastructure agent version 1.2.25 or higher is required to use remote_monitoring.

Environment variable passthroughs

Environment variables can be used to control config settings, and are then passed through to the infrastructure agent. For instructions on how to use this feature, see Configure the infrastructure agent.

Important

With secrets management, you can configure on-host integrations with New Relic infrastructure's agent to use sensitive data (such as passwords) without having to write them as plain text into the integration's configuration file. For more information, see Secrets management.

The URL set up to provide the metrics using the Apache status info module.

Type	String
Default	http://127.0.0.1/server-status?auto

Example:

STATUS_URL='http://your.ip.address:8080/server-status?auto'

Find and use data

Data from this service is reported to an integration dashboard.

Apache data is attached to the ApacheSample event type. You can query this data for troubleshooting purposes or to create charts and dashboards.

For more on how to find and use your data, see Understand integration data.

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, and adds those version numbers 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.

Check the source code

This integration is open source software. That means you can browse its source code and send improvements, or create your own fork and build it.

For more help

If you need more help, check out these support and learning resources:

Browse the Explorers Hub to get help from the community and join in discussions.
Find answers on our sites and learn how to use our support portal.
Run New Relic Diagnostics, our troubleshooting tool for Linux, Windows, and macOS.
Review New Relic's data security and licenses documentation.

Compatibility and requirements

Quick start

Tip

Install and activate

ECS

Kubernetes

Linux

Configure the integration

Activate remote monitoring

Important

Environment variable passthroughs

Important

STATUS_URL

CA_BUNDLE_FILE

CA_BUNDLE_DIR

Find and use data

Metric data

Inventory data

System metadata

Troubleshooting

Problem accessing HTTPS endpoint for Apache

Check the source code

For more help

Apache monitoring integration

Compatibility and requirements

Quick start

Tip

Install and activate

ECS

Kubernetes

Linux

Configure the integration

Activate remote monitoring

Important

Environment variable passthroughs

Important

STATUS_URL

CA_BUNDLE_FILE

CA_BUNDLE_DIR

Find and use data

Metric data

Inventory data

System metadata

Troubleshooting

Problem accessing HTTPS endpoint for Apache

Check the source code

.css-s3mb0o{fill:none;stroke:currentColor;stroke-width:2;stroke-linecap:round;stroke-linejoin:round;}.css-1bvd50p{width:1rem;height:1rem;fill:none;stroke:currentColor;stroke-width:2;stroke-linecap:round;stroke-linejoin:round;}For more help

For more help