HTTP Server plugin

This plugin collects metrics from an Apache HTTP server instance.

Prerequisites

Meter 4.2 or later must be installed.

The Apache HTTP Server plugin supports the following Operating Systems.

Linux
Windows
OS X

Plugin Setup

The Apache HTTP Server plugin requires the server-stats module for collecting metrics. Refer to the following procedures to enable and configure the server-stats module.

To enable the `server-status` module

Modify the Apache HTTP Server httpd.conf by adding the following:

<Location /server-status>
  SetHandler server-status
</Location>

To secure the EndPoint with a User Name and Password

Create a password file to secure the endpoint. The following example uses the path /etc/httpd/my_password_file.
```
$ sudo htpasswd -c /etc/httpd/my_password_file
```

Enable authentication by modifying the <Location/> added previously.

<Location /server-status>
     SetHandler server-status
     AuthType basic
     AuthName "Apache status"
     AuthUserFile /etc/httpd/my_password_file
     Require valid-user
</Location>

Restart Apache HTTP server reload the httpd.conf file.
Verify that statistics are being collected by visiting http://yourserver.com/server-status

To collect data for the 'requests per second' metric, add ExtendedStatus On outside the <Location /> block.

<Location /server-status>
     SetHandler server-status
     AuthType basic
     AuthName "Apache status"
     AuthUserFile /etc/httpd/my_password_file
     Require valid-user
</Location>
ExtendedStatus On

To install the plugin

From the top right of the screen, perform one of the following actions:
- Click > Data Collection, select the TrueSight meter, and select the Sources tab.
- Click > Configure Sources.
Use the search box or scroll through the page to find the source system which has the TrueSight meter on which you want to install the plugin.
Click the name of the source to view source details.
Select the Plugins tab.
Use the search box or scroll through the page to find the plugin you want to install.
Click + Install to start the installation.
Refer to the following sections for the configuration details required to collect data and view the list of plugin metrics.

Configuration details

Field Name	Description
Server-Status URL	The URL endpoint of where the Apache HTPP server statistics are hosted.
Username	If the URL is password protected, what username should the plugin use to authenticate
Password	If the URL is password protected, what password should the plugin use to authenticate
Poll Interval	How often (in milliseconds) to poll for metrics (default: 1000).
Source	Name identifying the specific instance of Apache HTTP server which is displayed in dashboards

Advanced configuration

To customize this plugin, see Apache HTTP Server plugin on GitHub.

Plugin metrics

Metric Name	Description
Apache Requests	Number of accesses
Apache Total Bytes	Bytes transferred
Apache Bytes per Request	Average bytes per request
Apache CPU	CPU used by all workers
Apache Busy Workers	Number of busy workers
Apache Idle Workers	Number of idle workers
Apache busy to idle ratio	Ratio of busy workers / (busy + idle workers)