docs: update configuration.md (#2456)

splunk · Jul 3, 2024 · 30955b6 · 30955b6
1 parent 948ba67
commit 30955b6
Show file tree

Hide file tree

Showing 6 changed files with 194 additions and 284 deletions.
diff --git a/docs/configuration.md b/docs/configuration.md
diff --git a/docs/gettingstarted/docker-compose-MacOS.md b/docs/gettingstarted/docker-compose-MacOS.md
@@ -36,7 +36,7 @@ sudo docker volume create splunk-sc4s-var
 Acknowledgement when you deploy the HEC token on the Splunk side; syslog-ng http destination does not support this
 feature. 
 
-* The default number of `SC4S_DEST_SPLUNK_HEC_WORKERS` is 10. Consult the community if you feel the number of workers (threads) should
+* The default number of `SC4S_DEST_SPLUNK_HEC_<ID>_WORKERS` is 10. Consult the community if you feel the number of workers (threads) should
 deviate from this.
 
 * Splunk Connect for Syslog defaults to secure configurations.  If you are not using trusted SSL certificates, be sure to

diff --git a/docs/gettingstarted/docker-compose.md b/docs/gettingstarted/docker-compose.md
@@ -36,7 +36,7 @@ sudo docker volume create splunk-sc4s-var
 * Update `SC4S_DEST_SPLUNK_HEC_DEFAULT_URL` and `SC4S_DEST_SPLUNK_HEC_DEFAULT_TOKEN` to reflect the values for your environment. Do not configure HEC
 Acknowledgement when you deploy the HEC token on the Splunk side; syslog-ng http destination does not support this
 feature. 
-* The default number of `SC4S_DEST_SPLUNK_HEC_WORKERS` is 10. Consult the community if you feel the number of workers (threads) should
+* The default number of `SC4S_DEST_SPLUNK_HEC_<ID>_WORKERS` is 10. Consult the community if you feel the number of workers (threads) should
 deviate from this.
 
 NOTE:  Splunk Connect for Syslog defaults to secure configurations.  If you are not using trusted SSL certificates, be sure to

diff --git a/docs/gettingstarted/docker-systemd-general.md b/docs/gettingstarted/docker-systemd-general.md
@@ -49,7 +49,7 @@ sudo docker volume create splunk-sc4s-var
 Acknowledgement when deploying the HEC token on the Splunk side, the underlying syslog-ng HTTP destination does not support this
 feature. 
 
-7. The default number of `SC4S_DEST_SPLUNK_HEC_WORKERS` is 10. Consult the community if you feel the number of workers should
+7. The default number of `SC4S_DEST_SPLUNK_HEC_<ID>_WORKERS` is 10. Consult the community if you feel the number of workers should
 deviate from this.
 
 8. Splunk Connect for Syslog defaults to secure configurations. If you are not using trusted SSL certificates, be sure to

diff --git a/docs/gettingstarted/podman-systemd-general.md b/docs/gettingstarted/podman-systemd-general.md
@@ -39,7 +39,7 @@ NOTE:  Be sure to account for disk space requirements for the podman volume you
 
 5. Update `SC4S_DEST_SPLUNK_HEC_DEFAULT_URL` and `SC4S_DEST_SPLUNK_HEC_DEFAULT_TOKEN` to reflect the correct values for your environment.  Do not configure HEC
 Acknowledgement when deploying the HEC token on the Splunk side; the underlying syslog-ng http destination does not support this
-feature. The default value for `SC4S_DEST_SPLUNK_HEC_WORKERS` is 10. Consult the community if you feel the number of workers (threads) should
+feature. The default value for `SC4S_DEST_SPLUNK_HEC_<ID>_WORKERS` is 10. Consult the community if you feel the number of workers (threads) should
 deviate from this.
 
 NOTE:  Splunk Connect for Syslog defaults to secure configurations. If you are not using trusted SSL certificates, be sure to

diff --git a/docs/performance.md b/docs/performance.md
@@ -8,7 +8,7 @@ Performance testing against our lab configuration produces the following results
 
 * Loggen (syslog-ng 3.25.1) - m5zn.3xlarge
 * SC4S(2.30.0) + podman (4.0.2) - m5zn family
-* SC4S_DEST_SPLUNK_HEC_WORKERS=10 (default)
+* SC4S_DEST_SPLUNK_HEC_DEFAULT_WORKERS=10 (default)
 * Splunk Cloud Noah 8.2.2203.2 - 3SH + 3IDX
 
 ```bash
@@ -31,7 +31,7 @@ Performance testing against our lab configuration produces the following results
 
 * Loggen (syslog-ng 3.25.1) - m5zn.large
 * SC4S(2.30.0) + podman (4.0.2) - m5zn family
-* SC4S_DEST_SPLUNK_HEC_WORKERS=10 (default)
+* SC4S_DEST_SPLUNK_HEC_DEFAULT_WORKERS=10 (default)
 * Splunk Enterprise 9.0.0 Standalone
 
 ```bash