Apache HTTP Server 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector provides this integration as the Apache HTTP Server monitor with the SignalFx Smart Agent receiver. The integration monitors Apache web servers using information mod_status provides.

Note

This monitor is not available on Windows as collectd plugins are only supported in Linux and Kubernetes.

Apache worker threads can be in one of the following states:

State	Remark
Open	Open (unused) slot - no process
Waiting	Idle and waiting for request
Sending	Serving response
KeepAlive	Kept alive for possible next request
Idle_cleanup	Idle and marked for cleanup
Closing	Closing connection
Logging	Writing to log file
Reading	Reading request
Finishing	Finishing as part of graceful shutdown
Starting	Starting up to serve

Benefits 🔗

After you configure the integration, you can access these features:

View metrics. You can create your own custom dashboards, and most monitors provide built-in dashboards as well. For information about dashboards, see View dashboards in Observability Cloud.
View a data-driven visualization of the physical servers, virtual machines, AWS instances, and other resources in your environment that are visible to Infrastructure Monitoring. For information about navigators, see Splunk Infrastructure Monitoring navigators.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Use the Metric Finder.

Installation 🔗

Follow these steps to deploy this integration:

Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
- Install on Kubernetes
- Install on Linux
Configure the monitor, as described in the Configuration section.
Restart the Splunk Distribution of OpenTelemetry Collector.

Configuration 🔗

To use this Smart Agent monitor with the Collector, include the smartagent receiver and service pipeline in your configuration file. The Smart Agent receiver is fully supported only on x86_64/amd64 platforms.

Read more in Use Smart Agent monitors with the Collector.
Learn about config options in Collector default configuration.

See the examples below for more details.

receivers:
  smartagent/apache:
    type: collectd/apache
    ... # Additional config

The following is an example of what you can use to replace the placeholder, ... # Additional config:

host: localhost
port: 80

If mod_status is exposed on an endpoint other than /mod_status, you can use the url config option to specify the path:

type: collectd/apache
host: localhost
port: 80
url: "http://{{.Host}}:{{.Port}}/server-status?auto"

To complete the integration, include the monitor in a metrics pipeline. To do this, add the monitor to the service > pipelines > metrics > receivers section of your configuration file. For example:

service:
  pipelines:
    metrics:
      receivers: [smartagent/apache]

Configuration settings 🔗

The following configuration options are available for this monitor:

Options	Required	Type	Description
`host`	yes	`string`	The hostname of the Apache server
`port`	yes	`integer`	The port number of the Apache server
`name`	no	`string`	This will be sent as the `plugin_instance` dimension and can be any name you like.
`url`	no	`string`	The URL, either a final URL or a Go template that will be populated with the host and port values. (default: `http://{{.Host}}:{{.Port}}/mod_status?auto`)
`username`	no	`string`
`password`	no	`string`

Apache configuration 🔗

After you deploy the monitor in the Splunk Distribution of OpenTelemetry Collector, follow these steps to configure the Apache web server to expose status metrics:

Activate the mod_status module in your Apache server. Make sure that the URL you provide for your mod_status module ends in ?auto. This returns the status page as text/plain, which the monitor requires.

Add the following configuration to your Apache server:

 ExtendedStatus on
 <Location /mod_status>
 SetHandler server-status
 </Location>

Restart the Apache web server.

Metrics 🔗

These metrics are available for this integration.

Troubleshooting 🔗

If you are not able to see your data in Splunk Observability Cloud, try these tips:

Submit a case in the Splunk Support Portal
- Available to Splunk Observability Cloud customers
Call Splunk Customer Support
- Available to Splunk Observability Cloud customers
Ask a question and get answers through community support at Splunk Answers
- Available to Splunk Observability Cloud customers and free trial users
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide
- Available to Splunk Observability Cloud customers and free trial users
- To learn how to join, see Get Started with Splunk Community - Chat groups

To learn about even more support options, see Splunk Customer Success.

Related Topics