From c6e17ede26913dfe62336832d8642c2f24fd653b Mon Sep 17 00:00:00 2001 From: jvoravong Date: Mon, 16 Oct 2023 10:28:56 -0600 Subject: [PATCH] [chore] Add ALPHA notice for the Network Explorer in values.yaml, NOTES.txt, and advanced-configuration.md --- docs/advanced-configuration.md | 4 ++++ helm-charts/splunk-otel-collector/templates/NOTES.txt | 5 +++++ helm-charts/splunk-otel-collector/values.yaml | 5 +++++ 3 files changed, 14 insertions(+) diff --git a/docs/advanced-configuration.md b/docs/advanced-configuration.md index 4141c8a1c3..6e2758e544 100644 --- a/docs/advanced-configuration.md +++ b/docs/advanced-configuration.md @@ -539,6 +539,10 @@ Note: Running the collector agent for log collection in non-root mode is not cur [related GitHub feature request issue](https://github.com/signalfx/splunk-otel-collector-chart/issues/891). ## Network explorer + +**NOTE:** Network Explorer related features should be considered to have an ALPHA maturity level and be experimental. +There may be breaking changes or Network Explorer features may be replaced entirely with a better alternative in the future. + [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 diff --git a/helm-charts/splunk-otel-collector/templates/NOTES.txt b/helm-charts/splunk-otel-collector/templates/NOTES.txt index c71d593bab..d0e84ddb35 100644 --- a/helm-charts/splunk-otel-collector/templates/NOTES.txt +++ b/helm-charts/splunk-otel-collector/templates/NOTES.txt @@ -80,6 +80,11 @@ Splunk Network Explorer is installed and configured. Upgrade guidelines: https://github.com/signalfx/splunk-otel-collector-chart/blob/main/UPGRADING.md#0670-to-0680 {{ end }} {{- if .Values.operator.enabled }} +[INFO] You've activated the Network Explorer feature (networkExplorer.enabled=true), currently considered ALPHA. + - Performance may vary depending on host environment specifications. + - Splunk offers best-effort support; however, not all deployment environments for Network Explorer may be tested or fully supported. +{{- end }} +{{- if .Values.operator.enabled }} [INFO] You've enabled the operator's auto-instrumentation feature (operator.enabled=true), currently considered ALPHA. - Instrumentation library maturity varies (e.g., Java is more mature than Go). For library stability, visit: https://opentelemetry.io/docs/instrumentation/#status-and-releases - Some libraries may be enabled by default. For current status, see: https://github.com/open-telemetry/opentelemetry-operator#controlling-instrumentation-capabilities diff --git a/helm-charts/splunk-otel-collector/values.yaml b/helm-charts/splunk-otel-collector/values.yaml index e2a43c588f..7f1a29afe9 100644 --- a/helm-charts/splunk-otel-collector/values.yaml +++ b/helm-charts/splunk-otel-collector/values.yaml @@ -1111,6 +1111,11 @@ gateway: config: {} ################################################################################ +# Notice: Network Explorer related features should be considered to have an +# ALPHA maturity level and be experimental. There may be breaking changes or +# Network Explorer features may be replaced entirely with a better alternative +# in the future. +# # OpenTelemetry service config, used for otel collector deployment. # Disabled by default ################################################################################