Skip to content

Commit

Permalink
Update READMEs (#128)
Browse files Browse the repository at this point in the history
* Update READMEs

- Add information about sizing for agent vs. gateway
- Enhance Linux installed getting started doc
  • Loading branch information
flands committed Feb 25, 2021
1 parent 0a9191f commit cd05d0f
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 9 deletions.
27 changes: 23 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,13 +104,30 @@ If a Collector handles both trace and metric data then both must be accounted
for when sizing. For example, 5K spans per second plus 10K data points per
second would require 1 CPU core.

The recommendation is to use a ratio of 1:2 for CPU:memory and to allocate at
least a CPU core per Collector. Multiple Collectors can deployed behind a
simple round-robin load balancer. Each Collector runs independently, so scale
increases linearly with the number of Collectors you deploy.
The recommendation is to use a ratio of 1 CPU to 2 GB of memory. By default, the
Collector is configured to use 512 MB of memory.

> The Collector does not persist data to disk so no disk space is required.
### Agent

For Agent instances, scale up resources as needed. Typically only a single
agent runs per application or host so properly sizing the agent is important.
Multiple independent agents could be deployed on a given application or host
depending on the use-case. For example, a privileged agent could be deployed
alongside an unprivileged agent.

### Gateway

For Gateway instances, allocate at least a CPU core per Collector. Note that
multiple Collectors can deployed behind a simple round-robin load balancer for
availability and performance reasons. Each Collector runs independently, so
scale increases linearly with the number of Collectors you deploy.

The recommendation is to configure at least N+1 redundancy, which means a load
balancer and a minimum of two Collector instances should be configured
initially.

## Monitoring

The default configuration automatically scrapes the Collector's own metrics and
Expand All @@ -121,6 +138,8 @@ information about the health and status of Collector instances.

See the [Collector troubleshooting
documentation](https://github.com/open-telemetry/opentelemetry-collector/blob/master/docs/troubleshooting.md).
Additional troubleshooting information can be found in the [getting
started](getting-started) READMEs.

## License

Expand Down
24 changes: 19 additions & 5 deletions docs/getting-started/linux-installer.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
For non-containerized Linux environments, an installer script is available. The
script deploys and configures:

- Splunk Connector for Linux
- Splunk OpenTelemetry Connector for Linux
- [TD Agent
(Fluentd)](https://www.fluentd.org/)

> IMPORTANT: systemctl is required for automatic service management.
> IMPORTANT: systemd is required to use this script.
Currently, the following Linux distributions and versions are supported:

Expand All @@ -33,10 +33,11 @@ for more details and available options.

## Advanced Configuration

### Collector Memory Configuration
### Additional Script Options

Optionally, the `SPLUNK_MEMORY_TOTAL_MIB` variable can be passed to change the
memory allocation configured in the Collector:
Additional configuration options supported by the script can be found by
running the script with the `-h` flag. One variable that may need to changed
is `SPLUNK_MEMORY_TOTAL_MIB` in order to configure the memory allocation:

> By default, this variable is set to `512`.
Expand All @@ -46,6 +47,19 @@ sudo sh /tmp/splunk-otel-collector.sh --realm SPLUNK_REALM --memory SPLUNK_TOTAL
-- SPLUNK_ACCESS_TOKEN
```

### Collector Configuration

The Collector comes with a default configuration which can be found at
`/etc/otel/collector/splunk_otel_linux.yaml`. This configuration can be
modified as needed. Possible configuration options can be found in the
`receivers`, `processors`, `exporters`, and `extensions` folders of either:

- [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector)
- [OpenTelemetry Collector Contrib](https://github.com/open-telemetry/opentelemetry-collector-contrib)

After modification, the Collector services needed to be restarted: `sudo
systemctl restart splunk-otel-collector`.

### Fluentd Configuration

By default, the fluentd service will be installed and configured to forward
Expand Down

0 comments on commit cd05d0f

Please sign in to comment.