Apache HTTP server (HTTPD) metrics

Collect metrics from Apache’s HTTPD server

status: beta role: daemon role: sidecar delivery: at-least-once egress: batch state: stateless output: metrics

Requirements

The Apache Status module must be enabled.

Configuration

Example configurations

{
  "sources": {
    "my_source_id": {
      "type": "apache_metrics",
      "endpoints": [
        "http://localhost:8080/server-status/?auto"
      ],
      "scrape_interval_secs": 15
    }
  }
}
[sources.my_source_id]
type = "apache_metrics"
endpoints = [ "http://localhost:8080/server-status/?auto" ]
scrape_interval_secs = 15
---
sources:
  my_source_id:
    type: apache_metrics
    endpoints:
      - http://localhost:8080/server-status/?auto
    scrape_interval_secs: 15
{
  "sources": {
    "my_source_id": {
      "type": "apache_metrics",
      "endpoints": [
        "http://localhost:8080/server-status/?auto"
      ],
      "scrape_interval_secs": 15,
      "namespace": "apache"
    }
  }
}
[sources.my_source_id]
type = "apache_metrics"
endpoints = [ "http://localhost:8080/server-status/?auto" ]
scrape_interval_secs = 15
namespace = "apache"
---
sources:
  my_source_id:
    type: apache_metrics
    endpoints:
      - http://localhost:8080/server-status/?auto
    scrape_interval_secs: 15
    namespace: apache

endpoints

required [string]
mod_status endpoints to scrape metrics from.
Array string literal
Examples
[
  "http://localhost:8080/server-status/?auto"
]

namespace

optional string
The namespace of the metric. Disabled if empty.
default: apache

scrape_interval_secs

common optional uint
The interval between scrapes.
default: 15 (seconds)

Output

Metrics

access_total

counter
The total number of time the Apache server has been accessed.
endpoint required
The absolute path of originating file.
host required
The hostname of the Apache HTTP server.

connections

gauge
The total number of time the Apache server has been accessed.
endpoint required
The absolute path of originating file.
host required
The hostname of the Apache HTTP server.
state required
The state of the connection

cpu_load

gauge
The current CPU of the Apache server.
endpoint required
The absolute path of originating file.
host required
The hostname of the Apache HTTP server.

cpu_seconds_total

counter
The CPU time of various Apache processes.
endpoint required
The absolute path of originating file.
host required
The hostname of the Apache HTTP server.
state required
The state of the connection

duration_seconds_total

counter
The amount of time the Apache server has been running.
endpoint required
The absolute path of originating file.
host required
The hostname of the Apache HTTP server.

scoreboard

gauge
The amount of times various Apache server tasks have been run.
endpoint required
The absolute path of originating file.
host required
The hostname of the Apache HTTP server.
state required
The connect state

sent_bytes_total

counter
The amount of bytes sent by the Apache server.
endpoint required
The absolute path of originating file.
host required
The hostname of the Apache HTTP server.

up

gauge
If the Apache server is up or not.
endpoint required
The absolute path of originating file.
host required
The hostname of the Apache HTTP server.

uptime_seconds_total

counter
The amount of time the Apache server has been running.
endpoint required
The absolute path of originating file.
host required
The hostname of the Apache HTTP server.

workers

gauge
Apache worker statuses.
endpoint required
The absolute path of originating file.
host required
The hostname of the Apache HTTP server.
state required
The state of the worker

Telemetry

Metrics

link

events_in_total

counter
The number of events accepted by this component either from tagged origin like file and uri, or cumulatively from other origins.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.
container_name optional
The name of the container from which the event originates.
file optional
The file from which the event originates.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the event originates.
peer_path optional
The pathname from which the event originates.
pod_name optional
The name of the pod from which the event originates.
uri optional
The sanitized URI from which the event originates.

events_out_total

counter
The total number of events emitted by this component.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.

http_error_response_total

counter
The total number of HTTP error responses for this component.

http_request_errors_total

counter
The total number of HTTP request errors for this component.

parse_errors_total

counter
The total number of errors parsing metrics for this component.

processed_bytes_total

counter
The number of bytes processed by the component.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.
container_name optional
The name of the container from which the bytes originate.
file optional
The file from which the bytes originate.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the bytes originate.
peer_path optional
The pathname from which the bytes originate.
pod_name optional
The name of the pod from which the bytes originate.
uri optional
The sanitized URI from which the bytes originate.

processed_events_total

counter
The total number of events processed by this component. This metric is deprecated in place of using events_in_total and events_out_total metrics.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.

request_duration_seconds

histogram
The total request duration in seconds.

requests_completed_total

counter
The total number of requests completed by this component.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.

How it works

Context

By default, the apache_metrics source augments events with helpful context keys.

State

This component is stateless, meaning its behavior is consistent across each input.