This plugin collects metrics from the
mod_status module, targeting the
server-status endpoint. The plugin requests the machine-readable content from this endpoint and parses metrics out from the retrieved data.
This plugin can fetch metrics from multiple Apache servers.
This plugin is currently only available for x86_64 Linux.
apache plugin is included with the AppOptics host agent by default, please follow the directions below to enable it for a host agent instance.
This plugin requires that
mod_status with the
ExtendedStatus option is enabled for your Apache server. Below is an example configuration:
<Location /server-status> SetHandler server-status Order deny,allow Deny from all Allow from 127.0.0.1 ::1 Allow from your.ip.address.here </Location> ExtendedStatus on
Please refer to the Apache mod_status documentation for more information.
The host agent provides an example configuration file to help you get started quickly. It defines the plugin and task file to be loaded by the agent, but requires you to provide the correct settings for your Apache server. To enable the plugin:
- Make a copy of the apache example configuration file
/opt/appoptics/etc/plugins.d/apache.yaml.example, renaming it to
$ sudo cp /opt/appoptics/etc/plugins.d/apache.yaml.example /opt/appoptics/etc/plugins.d/apache.yaml
/opt/appoptics/etc/plugins.d/apache.yamlconfiguration file with settings specific to your Apache server for example:
collector: apache: all: apache_mod_status_url: "http://localhost/server-status?auto myserver" safe: false load: plugin: snap-plugin-collector-aoapache task: task-aoapache.yaml
apache_mod_status_urlis a required setting and defaults to an empty string, it should be set to the
mod_statusURL to query.
The setting of
apache_mod_status_urlsupports two formats:
for single instance:apache_mod_status_url: "<url> <optional server name>"
for multiple instances:apache_mod_status_url: | <url> <optional server name> <url> <optional server name>
Optional server name is not a mandatory field. If defined, it will be used to tag dynamic metrics. If not, hostname and port will be used to tag dynamic metrics. If multiple instances are configured, only dynamic metrics are supported by the plugin.
safeis an optional setting that defaults to
true, which limits the plugin to only report metrics that don’t give away key details about the implementation of the
mod_statusendpoint or Apache itself. The metrics listing below notes which ones would be collected based on this setting.
- Restart the host agent:
$ sudo service appoptics-snapteld restart
- Enable the Apache plugin in the AppOptics UI
Select the Apache plugin to open the configuration menu in the UI, and enable the plugin.
You should soon see the
apachemetrics reported to your dashboard.