Apache HTTP Server 🔗

The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the Apache HTTP Server monitor type to monitor Apache web servers using information mod_status provides.

Note

Refer to the Apache Web Server receiver to monitor Apache web server instances with the OpenTelemetry Collector using native OpenTelemetry components.

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

This integration is only available on Kubernetes and Linux.

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 Splunk 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 Use navigators in Splunk Infrastructure Monitoring.
Access the Metric Finder and search for metrics sent by the monitor. For information, see Search the Metric Finder and Metadata catalog.

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 integration of a Smart Agent monitor with the Collector:

Include the Smart Agent receiver in your configuration file.
Add the monitor type to the Collector configuration, both in the receiver and pipelines sections.

See how to Use Smart Agent monitors with the Collector.
See how to set up the Smart Agent receiver.
For a list of common configuration options, refer to Common configuration settings for monitors.
Learn more about the Collector at Get started: Understand and use the Collector.

Example 🔗

To activate this integration, add the following to your Collector configuration:

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

Additional configuration options include host or port, as shown below. 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"

Next, add the monitor to the service.pipelines.metrics.receivers section of your configuration file:

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

Configuration options 🔗

The following configuration options are available for this integration:

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’ve set up the 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.

Notes 🔗

To learn more about the available in Splunk Observability Cloud see Metric types
In host-based subscription plans, default metrics are those metrics included in host-based subscriptions in Splunk Observability Cloud, such as host, container, or bundled metrics. Custom metrics are not provided by default and might be subject to charges. See Metric categories for more information.
In MTS-based subscription plans, all metrics are custom.
To add additional metrics, see how to configure extraMetrics in Add additional metrics

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 in the Get Started with Splunk Community manual.

This page was last updated on Oct 04, 2024.

Related Topics