Updated snap-config-sample files: added "Notice" to yaml, uniformity …

…config values

Renaming snapclt-config-sample.json to snaptel-config-sample.json

examples/configs/snap-config-sample.json

@@ -1,6 +1,6 @@
 {
     "log_level":2,
-    "log_path":"/some/log/dir",
+    "log_path":"/var/log/snap",
     "log_truncate":false,
     "log_colors":true,
     "gomaxprocs":2,

examples/configs/snap-config-sample.yaml

@@ -1,4 +1,10 @@
 ---
+#
+# ** Notice **
+# This file is a config file template to present all possibile config paramaters to customize.
+# Before you use this config file, please adjust it to your use-case.
+#
+
 # log_level for the snap daemon. Supported values are
 # 1 - Debug, 2 - Info, 3 - Warning, 4 - Error, 5 - Fatal.
 # Default value is 3.
@@ -7,7 +13,8 @@ log_level: 2
 # log_path sets the path for logs for the snap daemon. By
 # default snapteld prints all logs to stdout. Any provided
 # path will send snapteld logs to a file called snapteld.log in
-# the provided directory.
+# the provided directory. By default log path is empty
+# and snapteld logs to stdout.
 log_path: /var/log/snap
 
 # log_truncate specifies how the log file with be opened
@@ -65,14 +72,14 @@ control:
   # not be loaded. Valid values are 0 - Off, 1 - Enabled, 2 - Warning
   plugin_trust_level: 0
 
-  # temp_dir_path sets the temporary directory which houses the temporary files 
+  # temp_dir_path sets the temporary directory which houses the temporary files
   temp_dir_path: /tmp
 
   # max_plugin_restarts controls how many times a plugin is allowed to be restarted
   # before failing. Snap will not disable a plugin due to failures when this value is -1.
   max_plugin_restarts: 10
 
-  ## Secure plugin communication optional parameters:
+  # Secure plugin communication optional parameters:
   # tls_cert_path sets the TLS certificate path to enable secure plugin communication
   # and authenticate itself to plugins. Requires also: tls_key_path.
   tls_cert_path: /tmp/snaptest-cli.crt
@@ -107,7 +114,7 @@ control:
       influxdb:
         all:
           server: xyz.local
-          password: $password
+          password: password
     processor:
       movingaverage:
         all:
@@ -164,7 +171,7 @@ restapi:
   # port sets the port to start the REST API server on. Default is 8181
   port: 8282
 
-  # REST API in address[:port] format
+  # REST API in address[:port] format to bind to/listen on. Default is an empty string => listen on all interfaces
   addr: 127.0.0.1:12345
 
   # corsd sets the cors allowed domains in a comma separated list. It is the same origin if it's empty.
@@ -182,7 +189,7 @@ tribe:
   bind_port: 16000
 
   # name sets the name to use for this snapteld instance in the tribe
-  # membership. Default value defaults to local hostname of the system.
+  # membership. Default value is hostname of the system.
   name: localhost
 
   # seed sets the snapteld instance to use as the seed for tribe communications

mgmt/rest/server_test.go

@@ -135,7 +135,6 @@ func TestRestAPIConfigYaml(t *testing.T) {
 			So(cfg.RestKey, ShouldEqual, "/etc/snap/cert.key")
 		})
 	})
-
 }
 
 func TestRestAPIDefaultConfig(t *testing.T) {