Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Re-enable OOTB discovery for Apache Web Server #5353

Merged
merged 6 commits into from
Sep 10, 2024

Conversation

pjanotti
Copy link
Contributor

@pjanotti pjanotti commented Sep 9, 2024

Description:
Re-enable OOTB discovery for Apache Web Server with a default endpoint that matches the one from the OpenTelemetry apachereceiver: http://`endpoint`/server-status?auto

Collateral changes:

  • Consolidate Apache docker test image. There is no need to use 2 separate images for testing the legacy SmartAgent monitor and the apachereceiver discovery.
  • Renamed some files and folders that were using apachewebserver to apache. While the former is more descriptive it doesn't follow the pattern of other receivers from OpenTelemetry that can be discovered.

Link to Splunk idea:
https://splunk.atlassian.net/browse/OTL-2992

Testing:
Manually verified on Windows.

Documentation:
Updated changelog - need to follow-up with docs team if this needs to be updated on docs website.

@pjanotti pjanotti marked this pull request as ready for review September 10, 2024 02:48
@pjanotti pjanotti requested review from a team as code owners September 10, 2024 02:48
@pjanotti pjanotti changed the title DNM: Consolidate Apache docker test image Re-enable OOTB discovery for Apache Web Server Sep 10, 2024
### 💡 Enhancements 💡

- (Splunk) Apache Web Server Auto Discovery: set the default discovered endpoint to match the OpenTelemetry `apachereceiver` default: `http://`endpoint`/server-status?auto` ([#5353](https://github.com/signalfx/splunk-otel-collector/pull/5353))
If the collector is running as a process on the host OS and the Apache Web Server is in a Docker container add `--set=splunk.discovery.extensions.docker_observer.config.use_host_bindings=true` to the command-line arguments for the discovery to create the correct endpoint.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are already know facts here. I meant to say it holds for all discovery apps/services/dbs. May be we can skip linke16

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, unfortunately, use_host_bindings is not explicitly listed there. To be fair I didn't read that doc carefully, but, I will add a task to review and update the doc, I think that there are a few things that we should be more explicit about.

@@ -1,4 +1,4 @@
ExtendedStatus on
<Location /mod_status>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure what mod_status as have not played with Apache web server for a while but will go with your way.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is the path that one would use on the endpoint for the Apache receiver. The OTel receiver and most of the samples defaults to server-status, confusingly the name of the module that provides the functionality is actually mod_status, see https://httpd.apache.org/docs/2.4/mod/mod_status.html

@pjanotti pjanotti merged commit 84a21d6 into signalfx:main Sep 10, 2024
236 of 237 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Sep 10, 2024
@pjanotti pjanotti deleted the reenable-ootb-apache-discovery branch September 10, 2024 23:24
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants