Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion gdi/opentelemetry/deployment-modes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Use the host monitoring (agent) mode when you want to do these things:
Data forwarding (gateway) mode
======================================================================

Data forwarding (gateway) mode is typically deployed per cluster, data center, or region. The Collector in gateway mode collects data from one or more Collectors running in standalone agent mode and sends it to Splunk Observability Cloud. For the default gateway config file see :new-page:`data forwarding (gateway) mode configuration in GitHub <https://github.com/signalfx/splunk-otel-collector/blob/main/cmd/otelcol/config/collector/gateway_config.yaml>`.
Data forwarding (gateway) mode is typically deployed per cluster, data center, or region. A Collector in gateway mode collects data both from Kubernetes and from one or more Collectors running in standalone agent mode and sends it to Splunk Observability Cloud. For the default gateway config file see :new-page:`data forwarding (gateway) mode configuration in GitHub <https://github.com/signalfx/splunk-otel-collector/blob/main/cmd/otelcol/config/collector/gateway_config.yaml>`.

The following image shows the architecture for the data forwarding (gateway) mode:

Expand All @@ -74,6 +74,8 @@ The following image shows the architecture for the data forwarding (gateway) mod
When to use data forwarding (gateway) mode
-------------------------------------------------------------------------------

While optional, the Collector in gateway mode is beneficial for large-scale Kubernetes deployments, and you might consider adding a gateway Collector in big clusters. There isn't a strict rule for defining a large-scale Kubernetes setup due to varying host specifications, host and node numbers, and telemetry volume, although 25 hosts is sometimes considered the limit for a small environment.

Use data forwarding (gateway) mode when you want to do one of the following:

* Configure a larger buffer.
Expand Down
7 changes: 4 additions & 3 deletions gdi/opentelemetry/support-checklist.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ Support bundle scripts

Run support bundle scripts to collect information:

* Kubernetes: Run ``kubectl-splunk support``
* Linux (if installer script was used): Run ``/etc/otel/collector/splunk-support-bundle.sh``
* Windows (if MSI installer version 0.34.0 or higher was used): Run ``C:\Program Files\Splunk\OpenTelemetry Collector\splunk-support-bundle.ps1``
* For Kubernetes, run ``kubectl-splunk support``
* For Linux, if you used the installer script, run ``/etc/otel/collector/splunk-support-bundle.sh``
* For Windows, if you used the MSI installer version 0.34.0 or higher, run ``C:\Program Files\Splunk\OpenTelemetry Collector\splunk-support-bundle.ps1``
* If you used the :ref:`collector-addon-intro` to deploy the Collector see :new-page:`Generate a diagnostic file <https://docs.splunk.com/Documentation/Splunk/9.4.0/Troubleshooting/Generateadiag>`