122 lines
4.2 KiB
Markdown
122 lines
4.2 KiB
Markdown
---
|
|
description: "Telegraf plugin for collecting metrics from Apache"
|
|
menu:
|
|
telegraf_v1_ref:
|
|
parent: input_plugins_reference
|
|
name: Apache
|
|
identifier: input-apache
|
|
tags: [Apache, "input-plugins", "configuration", "server", "web"]
|
|
introduced: "v1.8.0"
|
|
os_support: "freebsd, linux, macos, solaris, windows"
|
|
related:
|
|
- /telegraf/v1/configure_plugins/
|
|
- https://github.com/influxdata/telegraf/tree/v1.36.1/plugins/inputs/apache/README.md, Apache Plugin Source
|
|
---
|
|
|
|
# Apache Input Plugin
|
|
|
|
This plugin collects performance information from [Apache HTTP Servers](https://httpd.apache.org)
|
|
using the [`mod_status` module](). Typically, this module is
|
|
configured to expose a page at the `/server-status?auto` endpoint the server.
|
|
|
|
The [ExtendedStatus option](https://httpd.apache.org/docs/current/mod/core.html#extendedstatus) must be enabled in order to collect
|
|
all available fields. For information about configuration of your server check
|
|
the [module documentation](https://httpd.apache.org/docs/current/mod/mod_status.html).
|
|
|
|
**Introduced in:** Telegraf v1.8.0
|
|
**Tags:** server, web
|
|
**OS support:** all
|
|
|
|
[apache]: https://httpd.apache.org
|
|
[extended_status]: https://httpd.apache.org/docs/current/mod/core.html#extendedstatus
|
|
[mod_status_module]: https://httpd.apache.org/docs/current/mod/mod_status.html
|
|
|
|
## Global configuration options <!-- @/docs/includes/plugin_config.md -->
|
|
|
|
In addition to the plugin-specific configuration settings, plugins support
|
|
additional global and plugin configuration settings. These settings are used to
|
|
modify metrics, tags, and field or create aliases and configure ordering, etc.
|
|
See the [CONFIGURATION.md](/telegraf/v1/configuration/#plugins) for more details.
|
|
|
|
[CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins
|
|
|
|
## Configuration
|
|
|
|
```toml @sample.conf
|
|
# Read Apache status information (mod_status)
|
|
[[inputs.apache]]
|
|
## An array of URLs to gather from, must be directed at the machine
|
|
## readable version of the mod_status page including the auto query string.
|
|
## Default is "http://localhost/server-status?auto".
|
|
urls = ["http://localhost/server-status?auto"]
|
|
|
|
## Credentials for basic HTTP authentication.
|
|
# username = "myuser"
|
|
# password = "mypassword"
|
|
|
|
## Maximum time to receive response.
|
|
# response_timeout = "5s"
|
|
|
|
## Optional TLS Config
|
|
# tls_ca = "/etc/telegraf/ca.pem"
|
|
# tls_cert = "/etc/telegraf/cert.pem"
|
|
# tls_key = "/etc/telegraf/key.pem"
|
|
## Use TLS but skip chain & host verification
|
|
# insecure_skip_verify = false
|
|
```
|
|
|
|
## Metrics
|
|
|
|
- apache
|
|
- BusyWorkers (float)
|
|
- BytesPerReq (float)
|
|
- BytesPerSec (float)
|
|
- ConnsAsyncClosing (float)
|
|
- ConnsAsyncKeepAlive (float)
|
|
- ConnsAsyncWriting (float)
|
|
- ConnsTotal (float)
|
|
- CPUChildrenSystem (float)
|
|
- CPUChildrenUser (float)
|
|
- CPULoad (float)
|
|
- CPUSystem (float)
|
|
- CPUUser (float)
|
|
- IdleWorkers (float)
|
|
- Load1 (float)
|
|
- Load5 (float)
|
|
- Load15 (float)
|
|
- ParentServerConfigGeneration (float)
|
|
- ParentServerMPMGeneration (float)
|
|
- ReqPerSec (float)
|
|
- ServerUptimeSeconds (float)
|
|
- TotalAccesses (float)
|
|
- TotalkBytes (float)
|
|
- Uptime (float)
|
|
|
|
The following fields are collected from the `Scoreboard`, and represent the
|
|
number of requests in the given state:
|
|
|
|
- apache
|
|
- scboard_closing (float)
|
|
- scboard_dnslookup (float)
|
|
- scboard_finishing (float)
|
|
- scboard_idle_cleanup (float)
|
|
- scboard_keepalive (float)
|
|
- scboard_logging (float)
|
|
- scboard_open (float)
|
|
- scboard_reading (float)
|
|
- scboard_sending (float)
|
|
- scboard_starting (float)
|
|
- scboard_waiting (float)
|
|
|
|
## Tags
|
|
|
|
- All measurements have the following tags:
|
|
- port
|
|
- server
|
|
|
|
## Example Output
|
|
|
|
```text
|
|
apache,port=80,server=debian-stretch-apache BusyWorkers=1,BytesPerReq=0,BytesPerSec=0,CPUChildrenSystem=0,CPUChildrenUser=0,CPULoad=0.00995025,CPUSystem=0.01,CPUUser=0.01,ConnsAsyncClosing=0,ConnsAsyncKeepAlive=0,ConnsAsyncWriting=0,ConnsTotal=0,IdleWorkers=49,Load1=0.01,Load15=0,Load5=0,ParentServerConfigGeneration=3,ParentServerMPMGeneration=2,ReqPerSec=0.00497512,ServerUptimeSeconds=201,TotalAccesses=1,TotalkBytes=0,Uptime=201,scboard_closing=0,scboard_dnslookup=0,scboard_finishing=0,scboard_idle_cleanup=0,scboard_keepalive=0,scboard_logging=0,scboard_open=100,scboard_reading=0,scboard_sending=1,scboard_starting=0,scboard_waiting=49 1502489900000000000
|
|
```
|