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.

Sign up for GitHub

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

Improve documentation for Windows nodes #362

Merged
merged 3 commits into from
Jan 25, 2022
Merged

Improve documentation for Windows nodes #362

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3569aa3
Improve documentation for Windows nodes
dmitryax Jan 20, 2022
c6203c5
Merge branch 'main' into improve-windows-docs
dmitryax Jan 24, 2022
f496032
Merge branch 'main' into improve-windows-docs
dmitryax Jan 25, 2022
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
36 changes: 36 additions & 0 deletions docs/advanced-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,42 @@ splunkPlatform:
logsEnabled: true
```

## Windows worker nodes support

Splunk OpenTelemetry Collector for Kubernetes supports collection of metrics,
traces and logs (using OTel native logs collection only) from Windows nodes.

All windows images are available in a separate `quay.io` repository:
`quay.io/signalfx/splunk-otel-collector-windows`.

Use the following values.yaml configuration to install the helm chart on Windows
worker nodes:

```yaml
isWindows: true
image:
otelcol:
repository: quay.io/signalfx/splunk-otel-collector-windows
logsEngine: otel
readinessProbe:
initialDelaySeconds: 60
livenessProbe:
initialDelaySeconds: 60
```

If you have both Windows and Linux worker nodes in your Kubernetes cluster, you
need to install the helm chart twice. One of the installations with default
configuration `isWindows: false` will be applied on Linux nodes. Another
installation with values.yaml configuration that provided above will be applied
on Windows nodes. And it's important to disable `clusterReceiver` on one of the
installations to avoid cluster-wide metrics duplication, add the following line
to values.yaml of one of the installations:

```yaml
clusterReceiver:
enabled: false
```

## GKE Autopilot support

If you want to run Splunk OTel Collector in [Google Kubernetes Engine
Expand Down
19 changes: 0 additions & 19 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,25 +29,6 @@ splunkObservability:
accessToken: my-access-token
```

## Deploy for k8s cluster with windows worker node.

This configuration will install application for windows worker node only.

All windows images are available in a separate `quay.io` repository: `quay.io/signalfx/splunk-otel-collector-windows`.

Logs collection on Windows is only available using OTel native logs collection. Fluentd log engine is not supported.

```yaml
image:
otelcol:
repository: quay.io/signalfx/splunk-otel-collector-windows
readinessProbe:
initialDelaySeconds: 60
livenessProbe:
initialDelaySeconds: 60
isWindows: true
```

## Enable traces sampling

This example shows how to change default OTel Collector configuration to add
Expand Down