From c206efcae7b414b70b088fa08e4bb7f167618310 Mon Sep 17 00:00:00 2001
From: Joshua Williams <josh.williams@bluemedora.com>
Date: Mon, 20 Jul 2020 11:56:54 -0400
Subject: [PATCH] Added a new default config with comments

---
 scripts/unix-install.sh     | 47 +++++++++++++++++++++++++++++--------
 scripts/windows-install.ps1 | 47 +++++++++++++++++++++++++++++--------
 2 files changed, 74 insertions(+), 20 deletions(-)

diff --git a/scripts/unix-install.sh b/scripts/unix-install.sh
index 147f64e9a..9e395d805 100755
--- a/scripts/unix-install.sh
+++ b/scripts/unix-install.sh
@@ -450,16 +450,43 @@ create_config_file()
   fi
 
   cat << EOF > "$1"
-# pipeline:
-#   - id: example_input
-#     type: generate_input
-#     count: 1
-#     record:
-#       message: example log
-#     output: example_stdout
-
-#   - id: example_stdout
-#     type: stdout
+pipeline:
+  # An example input that generates a single log entry when Carbon starts up.
+  - id: example_input
+    type: generate_input
+    count: 1
+    entry:
+      record: This is a sample log generated by Carbon
+    output: example_output
+
+  # An example input that monitors the contents of a file.
+  # For more info: https://github.com/observIQ/carbon/blob/master/docs/plugins/file_input.md
+  #
+  # - id: example_input
+  #   type: file_input
+  #   include:
+  #     - /sample/file/path
+  #   output: example_output
+
+  # An example output that sends captured logs to stdout.
+  - id: example_output
+    type: stdout
+
+  # An example output that sends captured logs to google cloud logging.
+  # For more info: https://github.com/observIQ/carbon/blob/master/docs/plugins/google_cloud_output.md
+  #
+  # - id: example_output
+  #   type: google_cloud_output
+  #   credentials_file: /my/credentials/file
+
+  # An example output that sends captured logs to elasticsearch.
+  # For more info: https://github.com/observIQ/carbon/blob/master/docs/plugins/elastic_output.md
+  #
+  # - id: example_output
+  #   type: elastic_output
+  #   addresses:
+  #     - http://my_node_address:9200
+  #   api_key: my_api_key
 EOF
 }
 
diff --git a/scripts/windows-install.ps1 b/scripts/windows-install.ps1
index 9508073ed..827e6e6cd 100644
--- a/scripts/windows-install.ps1
+++ b/scripts/windows-install.ps1
@@ -466,16 +466,43 @@ new-module -name LogAgentInstall -scriptblock {
     if (Test-Path $args) { return }
 
     @"
-# pipeline:
-#   - id: example_input
-#     type: generate_input
-#     count: 1
-#     entry:
-#       record: example log
-#     output: example_stdout
-#
-#   - id: example_stdout
-#     type: stdout
+pipeline:
+# An example input that generates a single log entry when Carbon starts up.
+  - id: example_input
+    type: generate_input
+    count: 1
+    entry:
+      record: This is a sample log generated by Carbon
+    output: example_output
+
+  # An example input that monitors the contents of a file.
+  # For more info: https://github.com/observIQ/carbon/blob/master/docs/plugins/file_input.md
+  #
+  # - id: example_input
+  #   type: file_input
+  #   include:
+  #     - /sample/file/path
+  #   output: example_output
+
+  # An example output that sends captured logs to stdout.
+  - id: example_output
+    type: stdout
+
+  # An example output that sends captured logs to google cloud logging.
+  # For more info: https://github.com/observIQ/carbon/blob/master/docs/plugins/google_cloud_output.md
+  #
+  # - id: example_output
+  #   type: google_cloud_output
+  #   credentials_file: /my/credentials/file
+
+  # An example output that sends captured logs to elasticsearch.
+  # For more info: https://github.com/observIQ/carbon/blob/master/docs/plugins/elastic_output.md
+  #
+  # - id: example_output
+  #   type: elastic_output
+  #   addresses:
+  #     - http://my_node_address:9200
+  #   api_key: my_api_key
 "@ > $args
   }