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

Docs suggest only gateway collectors can support proxy settings #1634

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

billg-splunk
Copy link
Contributor

@billg-splunk billg-splunk commented Dec 16, 2024

This change is attempting to clarify that any collector can support proxy settings. However most customers would prefer to use a gateway collector so they don't need to configure proxy settings on each collector.

Feel free to wordsmith this PR to convey that message.

Requirements

  • Content follows Splunk guidelines for style and formatting.
  • You are contributing original content.

Describe the change

Enter a description of the changes, why they're good for the Observability Cloud documentation, and so on.

If this contribution is time sensitive, tell us when you'd like this PR to be merged.

This change is attempting to clarify that any collector can support proxy settings. However most customers would prefer to use a gateway collector so they don't need to configure proxy settings on each collector.

Feel free to wordsmith this PR to convey that message.
@billg-splunk billg-splunk requested a review from a team as a code owner December 16, 2024 18:27
@bhillmer bhillmer added the stop-alert Stops Slack notification in #o11y-docs-feedback so that PR can be worked wo unnecessary noise label Dec 16, 2024
@@ -28,7 +28,7 @@ Ensure that you give the proxy the ability to resolve the network names and make
Use the Splunk Distribution of the OpenTelemetry Collector
=======================================================================

Use the :new-page:`Splunk Distribution of OpenTelemetry Collector <https://docs.splunk.com/Observability/gdi/opentelemetry/deployment-modes.html>` in data forwarding (gateway) mode. You can forward metrics locally to the Splunk Distribution of OpenTelemetry Collector, which serves as your local store-and-forward service for telemetry.
The :new-page:`Splunk Distribution of OpenTelemetry Collector <https://docs.splunk.com/Observability/gdi/opentelemetry/deployment-modes.html>` supports configuring proxies. You can configure this on each collector, or a more typical method would be to configure a collector in data forwarding (gateway) mode. In the gateway paradigm you only need to configure the gateway collector(s) with the proxy settings; all other collectors can simply send data to the gateway collector.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The :new-page:`Splunk Distribution of OpenTelemetry Collector <https://docs.splunk.com/Observability/gdi/opentelemetry/deployment-modes.html>` supports configuring proxies. You can configure this on each collector, or a more typical method would be to configure a collector in data forwarding (gateway) mode. In the gateway paradigm you only need to configure the gateway collector(s) with the proxy settings; all other collectors can simply send data to the gateway collector.
The :new-page:`Splunk Distribution of OpenTelemetry Collector <https://docs.splunk.com/Observability/gdi/opentelemetry/deployment-modes.html>` supports proxies. You can configure proxies on each collector, or more typically, you would configure a collector in data forwarding (gateway) mode. In the gateway mode, you only need to configure the gateway collector(s) with the proxy settings; all other collectors can simply send data to the gateway collector.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
external stop-alert Stops Slack notification in #o11y-docs-feedback so that PR can be worked wo unnecessary noise
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants