# boundary-plugin-apache-http-server

**Repository Path**: mirrors_boundary/boundary-plugin-apache-http-server

## Basic Information

- **Project Name**: boundary-plugin-apache-http-server
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-11-23
- **Last Updated**: 2026-06-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Boundary Apache HTTP Server Plugin

Collects metrics from a Apache HTTP server instance. See video [walkthrough](https://help.boundary.com/hc/articles/201991151).

### Prerequisites

|     OS    | Linux | Windows | SmartOS | OS X |
|:----------|:-----:|:-------:|:-------:|:----:|
| Supported |   v   |    v    |    v    |  v   |

#### Boundary Meter versions v4.2 or later 

- To install new meter go to Settings->Installation or [see instructions](https://help.boundary.com/hc/en-us/sections/200634331-Installation).
- To upgrade the meter to the latest version - [see instructions](https://help.boundary.com/hc/en-us/articles/201573102-Upgrading-the-Boundary-Meter).

### Plugin Setup

- The Boundary Apache HTTP Server plugin depends on the `server-stats` module for collecting metrics. The sections below provide the procedures to enable and configure the `server-stats` module.

#### Enable the `server-status` Module

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

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

#### Secure the EndPoint with a User Name and Password
1. Create as password file to secure the endpoint. The example shown here is using the path `/etc/httpd/my_password_file`.

     ```bash
     $ sudo htpasswd -c /etc/httpd/my_password_file
     ```
2. Enable authentication by modifying the `<Location/>` added previously as shown here :

     ```xml
	<Location /server-status>
          SetHandler server-status
          AuthType basic
          AuthName "Apache status"
          AuthUserFile /etc/httpd/my_password_file
          Require valid-user
	</Location>
    ```
3. Restart Apache HTTP server reload the `httpd.conf` configuration.
4. Verify that statistics are being collected by visiting http://yourserver.com/server-status
5. To also capture the 'requests per second' metric, add `ExtendedStatus On` outside of your `<Location />` block:

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

### Plugin Configuration Fields

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

### Metrics Collected
Tracks the following metrics for [apache](http://httpd.apache.org/)

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

### Dashboards

Apache Server

### References

None