Docs: fix collector environment location on registry (#4239)

signalfx · Feb 2, 2024 · b20add6 · b20add6
1 parent aec1970
commit b20add6
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/deployments/ansible/README.md b/deployments/ansible/README.md
@@ -9,6 +9,7 @@ collect metrics, traces and logs from Linux machines and send data to [Splunk
 Observability Cloud](https://www.splunk.com/en_us/observability.html). 
 
 ## Linux
+
 Currently, the following Linux distributions and versions are supported:
 
 - Amazon Linux: 2, 2023 (**Note:** Log collection with Fluentd not currently supported for Amazon Linux 2023.)
@@ -18,6 +19,7 @@ Currently, the following Linux distributions and versions are supported:
 - Ubuntu: 16.04, 18.04, 20.04, 22.04
 
 ## Windows
+
 Currently, the following Windows versions are supported:
 
 - Windows Server 2016 64-bit
@@ -29,12 +31,13 @@ variables are set at the service scope, i.e.: they are only available to the
 collector service and not to the entire machine.
 
 Ansible requires PowerShell 3.0 or newer and at least .NET 4.0 to be installed on Windows host.
-A WinRM listener should be created and activeted. 
+A WinRM listener should be created and activated.
 For setting up Windows Host refer [Ansible Docs](https://docs.ansible.com/ansible/latest/user_guide/windows_setup.html).
 
 ## Installation
 
 To install the Ansible collection from Ansible Galaxy:
+
 ```sh
 ansible-galaxy collection install signalfx.splunk_otel_collector
 ```

diff --git a/deployments/ansible/roles/collector/README.md b/deployments/ansible/roles/collector/README.md
@@ -40,7 +40,7 @@ how to use the role in a playbook with minimal required configuration:
 You can disable starting the collector and fluentd services by setting 
 the argument `start_service` to `false`:
 
-```
+```terminal
 $> ansible-playbook playbook.yaml -e start_service=false
 ```
 
@@ -153,8 +153,8 @@ $> ansible-playbook playbook.yaml -e start_service=false
   ```
   On Linux, the variables/values will be added to the
   `/etc/otel/collector/splunk-otel-collector.conf` systemd environment file.
-  On Windows, the variables/values will be added to the
-  `HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\Environment`
+  On Windows, the variables/values will be added to the `Environment` value under the
+  `HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\splunk-otel-collector`
   registry key.
 
 #### Windows Proxy

diff --git a/docs/getting-started/windows-manual.md b/docs/getting-started/windows-manual.md
@@ -201,7 +201,9 @@ To have choco remember parameters on upgrade, be sure to set `choco feature enab
 
 #### Notes
 
- * If the `SPLUNK_ACCESS_TOKEN` parameter is not specified on initial installation, the Collector service will not be started. In order to start the Collector service, manually create/set the `HKLM:\SYSTEM\CurrentControlSet\Control\Session Manager\Environment\SPLUNK_ACCESS_TOKEN` registry value to the Splunk access token and run the `Start-Service splunk-otel-collector` PowerShell command.
+ * If the `SPLUNK_ACCESS_TOKEN` parameter is not specified on initial installation, the Collector service will not be started. In order to start the Collector service, manually create/add `SPLUNK_ACCESS_TOKEN=<ACCESS_TOKEN>` to the 
+ `Environment` value under the `HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\splunk-otel-collector`
+  registry key and run the `Start-Service splunk-otel-collector` PowerShell command.
  * If the Collector configuration file or any of the service configuration settings are modified after installation, restart the Collector service by restarting the system or by running the `Restart-Service splunk-otel-collector` PowerShell command.
  * If the `WITH_FLUENTD` parameter is set to `true` and the `\opt\td-agent\etc\td-agent\td-agent.conf` Fluentd configuration file does not exist, this file will be created and customized to collect events from the Windows Event Log and forward the collected events to the Collector. If this file is modified after installation, restart the Fluentd service by restarting the system or by running the `Restart-Service fluentdwinsvc` PowerShell command.
  * See [Collector Configuration](https://github.com/signalfx/splunk-otel-collector/blob/main/docs/getting-started/windows-installer.md#collector-configuration) for additional configuration details.