From 422bcac072ade3dd0843f71035188886392a6827 Mon Sep 17 00:00:00 2001 From: jeffreyc-splunk Date: Fri, 14 Jul 2023 11:58:22 -0400 Subject: [PATCH] OTL-2195: Disable fluentd by default for choco package --- CHANGELOG.md | 5 +++++ docs/getting-started/windows-manual.md | 7 +++---- .../splunk-otel-collector/splunk-otel-collector.nuspec | 2 +- .../splunk-otel-collector/tools/chocolateyinstall.ps1 | 2 +- 4 files changed, 10 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9da4f12330..3056002171 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,11 @@ ## Unreleased +### 🛑 Breaking changes 🛑 + +- (Splunk) Fluentd disabled by default for the Windows Chocolatey package ([#3377](https://github.com/signalfx/splunk-otel-collector/pull/3377)) + - Specify the `/WITH_FLUENTD:true` parameter to enable installation + ## v0.81.0 This Splunk OpenTelemetry Collector release includes changes from the [opentelemetry-collector v0.81.0](https://github.com/open-telemetry/opentelemetry-collector/releases/tag/v0.81.0) and the [opentelemetry-collector-contrib v0.81.0](https://github.com/open-telemetry/opentelemetry-collector-contrib/releases/tag/v0.81.0) releases where appropriate. diff --git a/docs/getting-started/windows-manual.md b/docs/getting-started/windows-manual.md index 93d0dc174c..0efa97356d 100644 --- a/docs/getting-started/windows-manual.md +++ b/docs/getting-started/windows-manual.md @@ -184,9 +184,8 @@ privileges): A [Chocolatey package]( https://community.chocolatey.org/packages/splunk-otel-collector) is available -to download, install, and configure the Collector and Fluentd with the -following PowerShell command (replace `MY_SPLUNK_ACCESS_TOKEN` and -`MY_SPLUNK_REALM`): +to download, install, and configure the Collector with the following PowerShell +command (replace `MY_SPLUNK_ACCESS_TOKEN` and `MY_SPLUNK_REALM`): ```powershell choco install splunk-otel-collector --params="'/SPLUNK_ACCESS_TOKEN:MY_SPLUNK_ACCESS_TOKEN /SPLUNK_REALM:MY_SPLUNK_REALM'" @@ -205,7 +204,7 @@ The following package parameters are available: * `/SPLUNK_TRACE_URL`: URL of the Splunk trace endpoint (e.g. `https://ingest.us1.signalfx.com/v2/trace`). This parameter is saved to the `HKLM:\SYSTEM\CurrentControlSet\Control\Session Manager\Environment\SPLUNK_TRACE_URL` registry value. Default value is `https://ingest.$SPLUNK_REALM.signalfx.com/v2/trace` * `/SPLUNK_BUNDLE_DIR`: The path to the Smart Agent bundle directory for the `smartagent` receiver and extension. The default path is provided by the Collector package. If the specified path is changed from the default value, the path should be an existing directory on the system. This parameter is saved to the `HKLM:\SYSTEM\CurrentControlSet\Control\Session Manager\Environment\SPLUNK_BUNDLE_DIR` registry value. Default value is `\Program Files\Splunk\OpenTelemetry Collector\agent-bundle`. * `/MODE`: This parameter is used for setting the `HKLM:\SYSTEM\CurrentControlSet\Control\Session Manager\Environment\SPLUNK_CONFIG` registry value to `\ProgramData\Splunk\OpenTelemetry Collector\agent_config.yaml` or `\ProgramData\Splunk\OpenTelemetry Collector\gateway_config.yaml`. Possible values are `agent` and `gateway`. Default value is `agent`. - * `/WITH_FLUENTD`: Whether to download, install, and configure Fluentd to forward log events to the Collector. Possible values are `true` and `false`. If set to `true`, the Fluentd MSI package will be downloaded from `https://packages.treasuredata.com`. Default value is `true`. + * `/WITH_FLUENTD`: Whether to download, install, and configure Fluentd to collect and forward log events to the Collector. Possible values are `true` and `false`. If set to `true`, the Fluentd MSI package will be downloaded from `https://packages.treasuredata.com`. Default value is `false`. To pass parameters, use `--params "''"` (e.g. `choco install splunk-otel-collector --params="'/SPLUNK_ACCESS_TOKEN:MY_SPLUNK_ACCESS_TOKEN /SPLUNK_REALM:MY_SPLUNK_REALM'"`). diff --git a/internal/buildscripts/packaging/choco/splunk-otel-collector/splunk-otel-collector.nuspec b/internal/buildscripts/packaging/choco/splunk-otel-collector/splunk-otel-collector.nuspec index 73fff76c3e..f8ba4bf8b4 100644 --- a/internal/buildscripts/packaging/choco/splunk-otel-collector/splunk-otel-collector.nuspec +++ b/internal/buildscripts/packaging/choco/splunk-otel-collector/splunk-otel-collector.nuspec @@ -19,7 +19,7 @@ The following package parameters are available: * `/SPLUNK_TRACE_URL`: URL of the Splunk trace endpoint (e.g. `https://ingest.us1.signalfx.com/v2/trace`). Default value is `https://ingest.$SPLUNK_REALM.signalfx.com/v2/trace` * `/SPLUNK_BUNDLE_DIR`: The path to the Smart Agent bundle directory for the `smartagent` receiver and extension. The default path is provided by the Collector package. If the specified path is changed from the default value, the path should be an existing directory on the system. Default value is `\Program Files\Splunk\OpenTelemetry Collector\agent-bundle`. * `/MODE`: This parameter is used for setting the Collector configuration file to `\ProgramData\Splunk\OpenTelemetry Collector\agent_config.yaml` or `\ProgramData\Splunk\OpenTelemetry Collector\gateway_config.yaml`. Possible values are `agent` and `gateway`. Default value is `agent`. - * `/WITH_FLUENTD`: Whether to download, install, and configure Fluentd to forward log events to the Collector. Possible values are `true` and `false`. If set to `true`, the Fluentd MSI package will be downloaded from `https://packages.treasuredata.com`. Default value is `true`. + * `/WITH_FLUENTD`: Whether to download, install, and configure Fluentd to collect and forward log events to the Collector. Possible values are `true` and `false`. If set to `true`, the Fluentd MSI package will be downloaded from `https://packages.treasuredata.com`. Default value is `false`. To pass parameters, use `--params "''"` (e.g. `choco install splunk-otel-collector --params="'/SPLUNK_ACCESS_TOKEN:MY_SPLUNK_ACCESS_TOKEN /SPLUNK_REALM:MY_SPLUNK_REALM'"`). diff --git a/internal/buildscripts/packaging/choco/splunk-otel-collector/tools/chocolateyinstall.ps1 b/internal/buildscripts/packaging/choco/splunk-otel-collector/tools/chocolateyinstall.ps1 index a69168dd6a..bf1b29f233 100644 --- a/internal/buildscripts/packaging/choco/splunk-otel-collector/tools/chocolateyinstall.ps1 +++ b/internal/buildscripts/packaging/choco/splunk-otel-collector/tools/chocolateyinstall.ps1 @@ -5,7 +5,7 @@ $toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)" write-host "Checking configuration parameters ..." $pp = Get-PackageParameters -[bool]$WITH_FLUENTD = $TRUE +[bool]$WITH_FLUENTD = $FALSE [bool]$SkipFluentd = $FALSE $MODE = $pp['MODE']