Apache HTTP Server (HTTPD) Metrics Source

The Vector apache_metrics source collects metrics from Apache HTTP server (HTTPD).

Requirements

• The Apache Status module must be enabled.

Configuration

• Common
• Advanced

• vector.toml
• vector.yaml
• vector.json

[sources.my_source_id]
  type = "apache_metrics" # required
  endpoints = ["http://localhost:8080/server-status/?auto"] # required
  scrape_interval_secs = 15 # optional, default, seconds

• commonrequired[string]

  endpoints

  mod_status endpoints to scrape metrics from.

  • View examples
• optionalstring

  namespace

  The namespace of the metric. Disabled if empty.

  • Syntax: literal
  • Default: "apache"
• commonoptionaluint

  scrape_interval_secs

  The interval between scrapes.

  • Default: 15 (seconds)

Output

This component outputs the following metric events:

• counter

  access_total

  The total number of time the Apache server has been accessed. This metric includes the following tags:

  • endpoint - The absolute path of originating file.

  • host - The hostname of the Apache HTTP server.

• gauge

  connections

  The total number of time the Apache server has been accessed. This metric includes the following tags:

  • endpoint - The absolute path of originating file.

  • host - The hostname of the Apache HTTP server.

  • state - The state of the connection

• gauge

  cpu_load

  The current CPU of the Apache server. This metric includes the following tags:

  • endpoint - The absolute path of originating file.

  • host - The hostname of the Apache HTTP server.

• counter

  cpu_seconds_total

  The CPU time of various Apache processes. This metric includes the following tags:

  • endpoint - The absolute path of originating file.

  • host - The hostname of the Apache HTTP server.

  • state - The state of the connection

• counter

  duration_seconds_total

  The amount of time the Apache server has been running. This metric includes the following tags:

  • endpoint - The absolute path of originating file.

  • host - The hostname of the Apache HTTP server.

• gauge

  scoreboard

  The amount of times various Apache server tasks have been run. This metric includes the following tags:

  • endpoint - The absolute path of originating file.

  • host - The hostname of the Apache HTTP server.

  • state - The connect state

• counter

  sent_bytes_total

  The amount of bytes sent by the Apache server. This metric includes the following tags:

  • endpoint - The absolute path of originating file.

  • host - The hostname of the Apache HTTP server.

• gauge

  up

  If the Apache server is up or not. This metric includes the following tags:

  • endpoint - The absolute path of originating file.

  • host - The hostname of the Apache HTTP server.

• counter

  uptime_seconds_total

  The amount of time the Apache server has been running. This metric includes the following tags:

  • endpoint - The absolute path of originating file.

  • host - The hostname of the Apache HTTP server.

• gauge

  workers

  Apache worker statuses. This metric includes the following tags:

  • endpoint - The absolute path of originating file.

  • host - The hostname of the Apache HTTP server.

  • state - The state of the worker

Telemetry

This component provides the following metrics that can be retrieved through the internal_metrics source. See the metrics section in the monitoring page for more info.

• counter

  events_in_total

  The number of events accepted by this component either from tagged origin like file and uri, or cumulatively from other origins. This metric includes the following tags:

  • component_kind - The Vector component kind.

  • component_name - The Vector component ID.

  • component_type - The Vector component type.

  • container_name - The name of the container from which the event originates.

  • file - The file from which the event originates.

  • instance - The Vector instance identified by host and port.

  • job - The name of the job producing Vector metrics.

  • mode - The connection mode used by the component.

  • peer_addr - The IP from which the event originates.

  • peer_path - The pathname from which the event originates.

  • pod_name - The name of the pod from which the event originates.

  • uri - The sanitized uri from which the event originates.

• counter

  http_error_response_total

  The total number of HTTP error responses for this component. This metric includes the following tags:

  • instance - The Vector instance identified by host and port.

  • job - The name of the job producing Vector metrics.

• counter

  http_request_errors_total

  The total number of HTTP request errors for this component. This metric includes the following tags:

  • instance - The Vector instance identified by host and port.

  • job - The name of the job producing Vector metrics.

• counter

  parse_errors_total

  The total number of errors parsing metrics for this component. This metric includes the following tags:

  • instance - The Vector instance identified by host and port.

  • job - The name of the job producing Vector metrics.

• counter

  processed_bytes_total

  The number of bytes processed by the component. This metric includes the following tags:

  • component_kind - The Vector component kind.

  • component_name - The Vector component ID.

  • component_type - The Vector component type.

  • container_name - The name of the container from which the bytes originate.

  • file - The file from which the bytes originate.

  • instance - The Vector instance identified by host and port.

  • job - The name of the job producing Vector metrics.

  • mode - The connection mode used by the component.

  • peer_addr - The IP from which the bytes originate.

  • peer_path - The pathname from which the bytes originate.

  • pod_name - The name of the pod from which the bytes originate.

  • uri - The sanitized uri from which the bytes originate.

• counter

  processed_events_total

  The total number of events processed by this component. This metric includes the following tags:

  • component_kind - The Vector component kind.

  • component_name - The Vector component ID.

  • component_type - The Vector component type.

  • file - The file that produced the error

  • instance - The Vector instance identified by host and port.

  • job - The name of the job producing Vector metrics.

• counter

  requests_completed_total

  The total number of requests completed by this component. This metric includes the following tags:

  • component_kind - The Vector component kind.

  • component_name - The Vector component ID.

  • component_type - The Vector component type.

  • instance - The Vector instance identified by host and port.

  • job - The name of the job producing Vector metrics.

• counter

  events_out_total

  The total number of events emitted by this component. This metric includes the following tags:

  • component_kind - The Vector component kind.

  • component_name - The Vector component ID.

  • component_type - The Vector component type.

  • instance - The Vector instance identified by host and port.

  • job - The name of the job producing Vector metrics.

• histogram

  request_duration_nanoseconds

  The total request duration in nanoseconds. This metric includes the following tags:

  • instance - The Vector instance identified by host and port.

  • job - The name of the job producing Vector metrics.

How It Works

Context

By default, the apache_metrics source will augment events with helpful context keys as shown in the "Output" section.

State

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