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.
Read on to install the integration, and to see what data we collect.
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:
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.
To install the Apache integration, follow the instructions for your environment:
- 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.
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,
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.
envlabel controls the
environmentattribute. The default value is
For more about general configuration structure, see Configuration.
remote_monitoring parameter enables remote monitoring and multi-tenancy for this integration.
remote_monitoring may change some attributes and/or affect your configured alerts. For more information, see remote monitoring in on-host integrations.
Infrastructure agent version 1.2.25 or higher is required to use
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.
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.
Data from this service is reported to an integration dashboard.
For more on how to find and use your data, see Understand integration data.
The Apache integration collects the following metric data attributes. Each metric name is prefixed with a category indicator and a period, such as
Rate of the number of bytes served, in bytes per second.
Rate of the number of client requests, in requests per second.
Current number of busy workers.
Current number of idle workers.
Current number of workers closing TCP connection after serving the response.
Current number of workers performing a DNS lookup.
Current number of workers gracefully finishing.
Current number of idle workers ready for cleanup.
Current number of workers maintaining a keep-alive connection.
Current number of workers that are logging.
Current number of workers reading requests (headers or body).
Current number of workers that are starting up.
Total number of workers available. Workers that are not needed to process requests may not be started.
Current number of workers that are writing.
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.
Besides the standard attributes collected by the infrastructure agent, the integration collects inventory data associated with the
ApacheSample event type:
The version of the Apache server. Example:
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.
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.