Skip to content

Commit

Permalink
Remove the networkExporter option from the helm chart
Browse files Browse the repository at this point in the history
  • Loading branch information
dmitryax committed Dec 13, 2023
1 parent dcb9791 commit 791ac08
Show file tree
Hide file tree
Showing 24 changed files with 24 additions and 1,320 deletions.
2 changes: 1 addition & 1 deletion .chloggen/TEMPLATE.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type:
# The name of the component, or a single word describing the area of concern, (e.g. agent, clusterReceiver, gateway, networkExplorer, operator, chart, other)
# The name of the component, or a single word describing the area of concern, (e.g. agent, clusterReceiver, gateway, operator, chart, other)
component:
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note:
Expand Down
15 changes: 15 additions & 0 deletions .chloggen/remove-network-explorer.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
change_type: breaking
# The name of the component, or a single word describing the area of concern, (e.g. agent, clusterReceiver, gateway, operator, chart, other)
component: networkExplorer
# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
note: Remove networkExplorer from helm chart
# One or more tracking issues related to the change
issues: [1076]
# (Optional) One or more lines of additional information to render under the primary note.
# These lines will be padded with 2 spaces and then inserted directly into the document.
# Use pipe (|) for multiline entries.
subtext: |
Network explorer is no longer part of this helm chart and should be installed separately.
See https://github.com/signalfx/splunk-otel-collector-chart/blob/main/docs/advanced-configuration.md#using-opentelemetry-ebpf-helm-chart-with-splunk-opentelemetry-collector-for-kubernetes
for more details.
3 changes: 0 additions & 3 deletions ci_scripts/sck_otel_values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,3 @@ gateway:
limits:
cpu: 300m
memory: 300Mi

networkExplorer:
enabled: true
72 changes: 0 additions & 72 deletions docs/advanced-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -555,78 +555,6 @@ If searching for indexed fields is turned off or you are running an older versio

For more information on index time field extraction please view this [guide](https://docs.splunk.com/Documentation/Splunk/latest/Data/Configureindex-timefieldextraction#Where_to_put_the_configuration_changes_in_a_distributed_environment).

## Network explorer
[Network explorer](network-explorer-architecture.md) allows you to collect network telemetry for ingest and analysis. This telemetry is sent to the Open Telemetry Collector Gateway.
To enable the network explorer, set the `enabled` flag to `true`
```yaml
networkExplorer:
enabled: true
```

Note: Enabling network explorer will automatically enable the Open Telemetry Collector Gateway.

### Prerequisites
Network Explorer is only supported in Kubernetes-based environments on Linux hosts: RedHat Linux 7.6+, Ubuntu 16.04+, Debian Stretch+, Amazon Linux 2, Google COS.

### Modifying the reducer footprint
The reducer is a single pod per Kubernetes cluster. If your cluster contains a large number of pods, nodes, and services, you can increase the resources allocated to it.

The reducer processes telemetry in multiple stages, with each stage partitioned into one or more shards, where each shard is a separate thread. Increasing the number of shards in each stage expands the capacity of the reducer. There are three stages: ingest, matching, and aggregation. You can set between 1-32 shards for each stage. There is 1 shard per reducer stage by default.

The following example sets the reducer to use 4 shards per stage.
```yaml
networkExplorer:
reducer:
ingestShards: 4
matchingShards: 4
aggregationShards: 4
```

### Customize network telemetry generated by Network Explorer
Metrics can be disabled, either singly or entire categories. See the [values.yaml](https://github.com/signalfx/splunk-otel-collector-chart/blob/main/helm-charts/splunk-otel-collector/values.yaml) for a complete list of categories and metrics.

To disable an entire category, give the category name, followed by `.all`.

```yaml
networkExplorer:
reducer:
disableMetrics:
- tcp.all
```

Individual metrics can be disabled by their names.

```yaml
networkExplorer:
reducer:
disableMetrics:
- tcp.bytes
```

You can mix categories and names. For example, this will disable all `http` metrics and the `udp.bytes` metric.
```yaml
networkExplorer:
reducer:
disableMetrics:
- http.all
- udp.bytes
```

`enableMetrics` allow you to turn back on metrics that were previously disabled.

Note: The `disableMetrics `flag is evaluated before the `enableMetrics` flag. This allows you to disable an entire category, then re-enable the individual metrics in that category that you are interested in.

This example disables all internal and http metrics but re-enables the `ebpf_net.collector_health` metric.
```yaml
networkExplorer:
reducer:
disableMetrics:
- http.all
- ebpf_net.all
enableMetrics:
- ebpf_net.collector_health
```
## Additional telemetry sources

Use `autodetect` config option to enable additional telemetry sources.
Expand Down
10 changes: 0 additions & 10 deletions docs/network-explorer-architecture.md

This file was deleted.

Binary file removed docs/network-explorer-architecture.png
Binary file not shown.
11 changes: 5 additions & 6 deletions helm-charts/splunk-otel-collector/templates/NOTES.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,6 @@ Splunk OpenTelemetry Collector is installed and configured to send data to Splun
{{- if eq (include "splunk-otel-collector.splunkO11yEnabled" .) "true" }}
Splunk OpenTelemetry Collector is installed and configured to send data to Splunk Observability realm {{ include "splunk-otel-collector.o11yRealm" . }}.
{{ end }}
{{- if .Values.networkExplorer.enabled }}
Splunk Network Explorer is installed and configured.
{{ end }}

{{- if .Values.splunkRealm }}
[WARNING] "splunkRealm" parameter is deprecated, please use "splunkObservability.realm" instead.
Expand Down Expand Up @@ -85,7 +82,9 @@ Splunk Network Explorer is installed and configured.
- Some libraries may be enabled by default. For current status, see: https://github.com/open-telemetry/opentelemetry-operator#controlling-instrumentation-capabilities
- Splunk provides best-effort support for native OpenTelemetry libraries, and full support for Splunk library distributions. For used libraries, refer to the values.yaml under "operator.instrumentation.spec".
{{- end }}
{{- if .Values.networkExplorer.enabled }}
[WARNING] `networkExplorer` option is deprecated and will be removed soon.
Follow https://github.com/signalfx/splunk-otel-collector-chart/blob/main/UPGRADING.md#0870-to-0880 to replace it with the upstream OpenTelemetry eBPF helm chart.
{{- if and (not (eq (toString .Values.networkExplorer) "<nil>")) .Values.networkExplorer.enabled }}
{{ fail "Network explorer is not part of this helm chart anymore. Please follow https://github.com/signalfx/splunk-otel-collector-chart/blob/main/UPGRADING.md#0870-to-0880 to replace it with the upstream OpenTelemetry eBPF helm chart." }}
{{- end }}
{{- if not (eq (toString .Values.networkExplorer) "<nil>")}}
[WARNING] `networkExplorer` option is no longer supported. Please remove it from your custom values.yaml.
{{- end }}
2 changes: 1 addition & 1 deletion helm-charts/splunk-otel-collector/templates/_helpers.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ Whether the gateway is enabled, either through network explorer, or through its
*/}}
{{- define "splunk-otel-collector.gatewayEnabled" -}}
{{- $gateway := fromYaml (include "splunk-otel-collector.gateway" .) }}
{{- or $gateway.enabled .Values.networkExplorer.enabled }}
{{- $gateway.enabled }}
{{- end -}}

{{/*
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading

0 comments on commit 791ac08

Please sign in to comment.