Skip to content

Commit

Permalink
Add architecture information and images (open-telemetry#179)
Browse files Browse the repository at this point in the history
* Add architecture information and images

* Address feedback
  • Loading branch information
flands authored Mar 18, 2021
1 parent e3a4946 commit 885fcb1
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/architecture.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Architecture

This distribution can be deployed in the below ways.

## Helm or Installer Script (Recommended)

![splunk-otel-collector-recommended-arch](images/splunk-otel-collector-recommended-arch.png)

If Helm or the installer script is used then the architecture will look similar
to above. The default configuration of the components is as follows:

- [splunk-otel-collector (otelcol)](https://github.com/signalfx/splunk-otel-collector/blob/main/cmd/otelcol/config/collector/agent_config.yaml)
- [td-agent (fluentd)](https://github.com/signalfx/splunk-otel-collector/tree/main/internal/buildscripts/packaging/fpm/etc/otel/collector/fluentd)

## Standalone

![splunk-otel-collector-standalone-arch](images/splunk-otel-collector-standalone-arch.png)

If deployed in standalone, only the splunk-otel-collector is deployed and
configured. Note the default configuration for standalone is gateway-mode instead of agent-mode like above:

- [splunk-otel-collector (otelcol)](https://github.com/signalfx/splunk-otel-collector/blob/main/cmd/otelcol/config/collector/gateway_config.yaml)

## Advanced

![splunk-otel-collector-recommended-gateway-arch](images/splunk-otel-collector-recommended-gateway-arch.png)

It is possible to manually configure the splunk-otel-collector running as an
agent to send to a splunk-otel-collector gateway instance/cluster. This
requires changing the pipeline exporters in the agent to point to the gateway.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 885fcb1

Please sign in to comment.