Skip to content

Commit ccb7974

Browse files
authored
[otelcol] Rewrite the agent-to-gateway deployment page (#9173)
Signed-off-by: Tiffany Hrabusa <tiffany.hrabusa@grafana.com>
1 parent 81dc000 commit ccb7974

File tree

7 files changed

+486
-47
lines changed

7 files changed

+486
-47
lines changed

content/en/docs/collector/deploy/gateway/index.md renamed to content/en/docs/collector/deploy/gateway.md

Lines changed: 6 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ description:
66
backends
77
aliases: [/docs/collector/deployment/gateway]
88
weight: 300
9-
# prettier-ignore
10-
cSpell:ignore: filelogreceiver hostmetricsreceiver hostnames loadbalancer loadbalancing resourcedetectionprocessor
9+
cSpell:ignore: hostnames loadbalancer loadbalancing resourcedetectionprocessor
1110
---
1211

1312
The gateway Collector deployment pattern consists of applications or other
@@ -206,39 +205,6 @@ including `otelcol_loadbalancer_num_backends` and
206205
`otelcol_loadbalancer_backend_latency` that you can use to monitor the health
207206
and performance of the Collector serving the OTLP endpoint.
208207

209-
## Combined deployment of Collectors as agents and gateways
210-
211-
Often, a deployment of multiple OpenTelemetry Collectors runs both Collectors as
212-
gateways and as [agents](/docs/collector/deploy/agent/).
213-
214-
The following diagram shows an architecture for such a combined deployment:
215-
216-
- Use Collectors running in the agent deployment pattern (running on each host,
217-
similar to Kubernetes DaemonSets) to collect telemetry from services running
218-
on the host as well as the host's own telemetry, such as host metrics and
219-
scraped logs.
220-
- Use Collectors running in the gateway deployment pattern to process data, such
221-
as filtering, sampling, and exporting to backends.
222-
223-
![gateway](otel-gateway-arch.svg)
224-
225-
This combined deployment pattern is necessary when you use components in your
226-
Collector that either must be unique per host or consume information that is
227-
available only on the same host where the application runs:
228-
229-
- Receivers like the
230-
[`hostmetricsreceiver`](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/hostmetricsreceiver)
231-
or
232-
[`filelogreceiver`](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver)
233-
must be unique per host instance. Running multiple instances of these
234-
receivers on the same host results in duplicate data.
235-
236-
- Processors like the
237-
[`resourcedetectionprocessor`](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/resourcedetectionprocessor)
238-
add information about the host where both the Collector and the application
239-
are running. Running the processor in a Collector on a separate machine from
240-
the application results in incorrect data.
241-
242208
## Trade-offs
243209

244210
Pros:
@@ -300,3 +266,8 @@ order of the timestamps is incorrect. For example:
300266
- Use the
301267
[resource detector processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/processor/resourcedetectionprocessor/README.md)
302268
to detect resource information from the host and collect resource metadata.
269+
270+
## Next steps
271+
272+
Learn how to [combine](/docs/collector/deploy/other/agent-to-gateway/) the agent
273+
and gateway patterns to create a robust, scalable Collector architecture.

content/en/docs/collector/deploy/other/agent-to-gateway.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)