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

Instrument your Apache web server quickly and send your telemetry data with guided install. Our guided install creates a customized CLI command for your environment that downloads and installs the New Relic CLI and the infrastructure agent.

Ready to get started? Click one of these button to try it out.

Our guided install uses the infrastructure agent to set up the Apache integration. Not only that, it discovers other applications and log sources running in your environment and then recommends which ones you should instrument.

The guided install works with most setups. But if it doesn't suit your needs, you can find other methods below to get started monitoring your Apache web server.

Install and activate

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

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.

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.

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

CA_BUNDLE_FILE='/etc/ssl/certs/custom-ca.crt'

CA_BUNDLE_DIR='/etc/ssl/certs/custom/'

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

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:

Troubleshooting

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.