Apache Web Server receiver

The Apache Web Server receiver fetches stats from a Apache Web Server instance.

The Apache Web Server receiver fetches stats from an Apache Web Server instance using the server-status?auto endpoint. The supported pipeline type is metrics. See Process your data with pipelines for more information.

Prerequisites

This receiver supports Apache Web Server version 2.4 or higher.

In order to receive server statistics, you must configure the server’s httpd.conf file to enable status support. Learn more at https://httpd.apache.org/docs/2.4/mod/mod_status.html in Apache's official documentation.

Get started

Follow these steps to configure and activate the component:

Deploy the Splunk Distribution of the OpenTelemetry Collector to your host or container platform:
Configure the receiver as described in the next section.
Restart the Collector.

Sample configuration

To activate the Apache Web Server receiver, add apache to the receivers section of your configuration file:

receivers:
  apache:
    endpoint: "http://localhost:8080/server-status?auto"
    collection_interval: 10s

To complete the configuration, include the receiver in the metrics pipeline of the service section of your configuration file:

service:
  pipelines:
    metrics:
      receivers: [apache]

Configuration options

The following settings are required:

endpoint. "http://localhost:8080/server-status?auto" by default. The URL of the httpd status endpoint.

The following settings are optional:

collection_interval. 10s by default. Sets the interval this receiver collects metrics on.
- This value must be a string readable by Golang’s time.ParseDuration. Learn more at Go’s official documentation ParseDuration function .
- Valid time units are ns, us (or µs), ms, s, m, h.

initial_delay. 1s by default. Determines how long this receiver waits before collecting metrics for the first time.

Settings

The following table shows the configuration options for the Apache Web Server receiver:

included

https://raw.githubusercontent.com/splunk/collector-config-tools/main/cfg-metadata/receiver/apache.yaml

Metrics

The following metrics, resource attributes, and attributes are available.

Note: The SignalFx exporter excludes some available metrics by default. Learn more about default metric filters in List of metrics excluded by default.

included

https://raw.githubusercontent.com/splunk/collector-config-tools/main/metric-metadata/apachereceiver.yaml

Activate or deactivate specific metrics

You can activate or deactivate specific metrics by setting the enabled field in the metrics section for each metric. For example:

receivers:
  samplereceiver:
    metrics:
      metric-one:
        enabled: true
      metric-two:
        enabled: false

The following is an example of host metrics receiver configuration with activated metrics:

receivers:
  hostmetrics:
    scrapers:
      process:
        metrics:
          process.cpu.utilization:
            enabled: true

Note: Deactivated metrics aren’t sent to Splunk Observability Cloud.

Billing

If you’re in a MTS-based subscription, all metrics count towards metrics usage.
If you’re in a host-based plan, metrics listed as active (Active: Yes) on this document are considered default and are included free of charge.

Learn more at Infrastructure Monitoring subscription usage (Host and metric plans).

Troubleshooting

If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.

Available to Splunk Observability Cloud customers

Submit a case in the Splunk Support Portal.
Contact Splunk Support.

Available to prospective customers and free trial users

Ask a question and get answers through community support at Splunk Answers.
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups.

Documentation