Cherry-pick #19848 to 7.x: Agent config cleanup (#19867)

* [Ingest Manager] Agent config cleanup (#19848) [Ingest Manager] Agent config cleanup (#19848) * vscode saving issues * test * fixed tests
elastic · Jul 14, 2020 · bd44c50 · bd44c50
1 parent c1e3d63
commit bd44c50
Show file tree

Hide file tree

Showing 71 changed files with 1,003 additions and 1,050 deletions.
diff --git a/x-pack/elastic-agent/CHANGELOG.asciidoc b/x-pack/elastic-agent/CHANGELOG.asciidoc
@@ -82,3 +82,4 @@
 - Agent now downloads Elastic Endpoint {pull}19503[19503]
 - Refuse invalid stream values in configuration {pull}19587[19587]
 - Agent now load balances across multiple Kibana instances {pull}19628[19628]
+- Configuration cleanup {pull}19848[19848]
diff --git a/x-pack/elastic-agent/_meta/config/common.p2.yml.tmpl b/x-pack/elastic-agent/_meta/config/common.p2.yml.tmpl
@@ -35,14 +35,25 @@ inputs:
       - metricset: filesystem
         dataset.name: system.filesystem
 
-# settings.monitoring:
+# agent.monitoring:
 #   # enabled turns on monitoring of running processes
 #   enabled: true
 #   # enables log monitoring
 #   logs: true
 #   # enables metrics monitoring
 #   metrics: true
 
+# # Allow fleet to reload his configuration locally on disk.
+# # Notes: Only specific process configuration will be reloaded.
+# agent.reload:
+#   # enabled configure the Elastic Agent to reload or not the local configuration.
+#   #
+#   # Default is true
+#   enabled: true
+
+#   # period define how frequent we should look for changes in the configuration.
+#   period: 10s
+
 # management:
 #   # Mode of management, the Elastic Agent support two modes of operation:
 #   #
@@ -51,49 +62,29 @@ inputs:
 #   # Default is local.
 #   mode: "local"
 
-#   fleet:
-#     access_token: ""
-#     kibana:
-#       # kibana minimal configuration
-#       hosts: ["localhost:5601"]
-#       ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
-
-#       # optional values
-#       #protocol: "https"
-#       #username: "elastic"
-#       #password: "changeme"
-#       #path: ""
-#       #ssl.verification_mode: full
-#       #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2]
-#       #ssl.cipher_suites: []
-#       #ssl.curve_types: []
-
+# fleet:
+#   access_api_key: ""
+#   kibana:
+#     # kibana minimal configuration
+#     hosts: ["localhost:5601"]
+#     ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
+
+#     # optional values
+#     #protocol: "https"
+#     #username: "elastic"
+#     #password: "changeme"
+#     #path: ""
+#     #ssl.verification_mode: full
+#     #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2]
+#     #ssl.cipher_suites: []
+#     #ssl.curve_types: []
 #   reporting:
-#     log:
-#       # format in which logs will be written, options are json or default.
-#       format: "default"
-#     fleet:
-#       # enables fleet reporter. fleet reporting can be enabled only in fleet management.mode.
-#       enabled: false
-
-#       # Reporting threshold indicates how many events should be kept in-memory before reporting them to fleet.
-#       reporting_threshold: 10000
-
-#       # Frequency used to check the queue of events to be sent out to fleet.
-#       reporting_check_frequency_sec: 30
-
-#   # Allow fleet to reload his configuration locally on disk.
-#   # Notes: Only specific process configuration will be reloaded.
-#   reload:
-#     # enabled configure the Elastic Agent to reload or not the local configuration.
-#     #
-#     # Default is true
-#     enabled: true
-
-#     # period define how frequent we should look for changes in the configuration.
-#     period: 10s
-
-# download:
+#     # Reporting threshold indicates how many events should be kept in-memory before reporting them to fleet.
+#     #reporting_threshold: 10000
+#     # Frequency used to check the queue of events to be sent out to fleet.
+#     #reporting_check_frequency_sec: 30
+
+# agent.download:
 #   # source of the artifacts, requires elastic like structure and naming of the binaries
 #   # e.g /windows-x86.zip
 #   sourceURI: "https://artifacts.elastic.co/downloads/beats/"
@@ -108,21 +99,21 @@ inputs:
 #   # for reading program specifications.
 #   install_path: "${path.data}/install"
 
-# process:
+# agent.process:
 #   # timeout for creating new processes. when process is not successfully created by this timeout
 #   # start operation is considered a failure
 #   spawn_timeout: 30s
 #   # timeout for stopping processes. when process is not stopped by this timeout then the process.
 #   # is force killed
 #   stop_timeout: 30s
 
-# grpc:
+# agent.grpc:
 #   # listen address for the GRPC server that spawned processes connect back to.
 #   address: localhost
 #   # port for the GRPC server that spawned processes connect back to.
 #   port: 6789
 
-# retry:
+# agent.retry:
 #   # Enabled determines whether retry is possible. Default is false.
 #   enabled: true
 #   # RetriesCount specifies number of retries. Default is 3.
@@ -144,41 +135,41 @@ inputs:
 
 # Sets log level. The default log level is info.
 # Available log levels are: error, warning, info, debug
-#logging.level: info
+#agent.logging.level: info
 
 # Enable debug output for selected components. To enable all selectors use ["*"]
 # Other available selectors are "beat", "publish", "service"
 # Multiple selectors can be chained.
-#logging.selectors: [ ]
+#agent.logging.selectors: [ ]
 
 # Send all logging output to stderr. The default is false.
-logging.to_stderr: true
+agent.logging.to_stderr: true
 
 # Send all logging output to syslog. The default is false.
-#logging.to_syslog: false
+#agent.logging.to_syslog: false
 
 # Send all logging output to Windows Event Logs. The default is false.
-#logging.to_eventlog: false
+#agent.logging.to_eventlog: false
 
-# If enabled, {{.BeatName | title}} periodically logs its internal metrics that have changed
+# If enabled, Elastic-Agent periodically logs its internal metrics that have changed
 # in the last period. For each metric that changed, the delta from the value at
 # the beginning of the period is logged. Also, the total values for
 # all non-zero internal metrics are logged on shutdown. The default is true.
-#logging.metrics.enabled: true
+#agent.logging.metrics.enabled: true
 
 # The period after which to log the internal metrics. The default is 30s.
-#logging.metrics.period: 30s
+#agent.logging.metrics.period: 30s
 
 # Logging to rotating files. Set logging.to_files to false to disable logging to
 # files.
-#logging.to_files: true
-#logging.files:
+#agent.logging.to_files: true
+#agent.logging.files:
   # Configure the path where the logs are written. The default is the logs directory
   # under the home path (the binary location).
-  #path: /var/log/{{.BeatName}}
+  #path: /var/log/elastic-agent
 
   # The name of the files where the logs are written to.
-  #name: {{.BeatName}}
+  #name: elastic-agent
 
   # Configure log file size limit. If limit is reached, log file will be
   # automatically rotated
@@ -203,9 +194,9 @@ logging.to_stderr: true
   # rotateonstartup: true
 
 # Set to true to log messages in JSON format.
-#logging.json: false
+#agent.logging.json: false
 
 # Set to true, to log messages with minimal required Elastic Common Schema (ECS)
 # information. Recommended to use in combination with `logging.json=true`
 # Defaults to false.
-#logging.ecs: false
+#agent.logging.ecs: false
diff --git a/x-pack/elastic-agent/_meta/config/common.reference.p2.yml.tmpl b/x-pack/elastic-agent/_meta/config/common.reference.p2.yml.tmpl
@@ -43,49 +43,29 @@ inputs:
 #   # Default is local.
 #   mode: "local"
 
-#   fleet:
-#     access_token: ""
-#     kibana:
-#       # kibana minimal configuration
-#       hosts: ["localhost:5601"]
-#       ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
-
-#       # optional values
-#       #protocol: "https"
-#       #username: "elastic"
-#       #password: "changeme"
-#       #path: ""
-#       #ssl.verification_mode: full
-#       #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2]
-#       #ssl.cipher_suites: []
-#       #ssl.curve_types: []
-
+# fleet:
+#   access_api_key: ""
+#   kibana:
+#     # kibana minimal configuration
+#     hosts: ["localhost:5601"]
+#     ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]
+
+#     # optional values
+#     #protocol: "https"
+#     #username: "elastic"
+#     #password: "changeme"
+#     #path: ""
+#     #ssl.verification_mode: full
+#     #ssl.supported_protocols: [TLSv1.0, TLSv1.1, TLSv1.2]
+#     #ssl.cipher_suites: []
+#     #ssl.curve_types: []
 #   reporting:
-#     log:
-#       # format in which logs will be written, options are json or default.
-#       format: "default"
-#     fleet:
-#       # enables fleet reporter. fleet reporting can be enabled only in fleet management.mode.
-#       enabled: false
-
-#       # Reporting threshold indicates how many events should be kept in-memory before reporting them to fleet.
-#       reporting_threshold: 10000
-
-#       # Frequency used to check the queue of events to be sent out to fleet.
-#       reporting_check_frequency_sec: 30
-
-#   # Allow fleet to reload his configuration locally on disk.
-#   # Notes: Only specific process configuration will be reloaded.
-#   reload:
-#     # enabled configure the Elastic Agent to reload or not the local configuration.
-#     #
-#     # Default is true
-#     enabled: true
-
-#     # period define how frequent we should look for changes in the configuration.
-#     period: 10s
-
-# download:
+#     # Reporting threshold indicates how many events should be kept in-memory before reporting them to fleet.
+#     #reporting_threshold: 10000
+#     # Frequency used to check the queue of events to be sent out to fleet.
+#     #reporting_check_frequency_sec: 30
+
+# agent.download:
 #   # source of the artifacts, requires elastic like structure and naming of the binaries
 #   # e.g /windows-x86.zip
 #   sourceURI: "https://artifacts.elastic.co/downloads/beats/"
@@ -100,21 +80,21 @@ inputs:
 #   # for reading program specifications.
 #   install_path: "${path.data}/install"
 
-# process:
+# agent.process:
 #   # timeout for creating new processes. when process is not successfully created by this timeout
 #   # start operation is considered a failure
 #   spawn_timeout: 30s
 #   # timeout for stopping processes. when process is not stopped by this timeout then the process.
 #   # is force killed
 #   stop_timeout: 30s
 
-# grpc:
+# agent.grpc:
 #   # listen address for the GRPC server that spawned processes connect back to.
 #   address: localhost
 #   # port for the GRPC server that spawned processes connect back to.
 #   port: 6789
 
-# retry:
+# agent.retry:
 #   # Enabled determines whether retry is possible. Default is false.
 #   enabled: true
 #   # RetriesCount specifies number of retries. Default is 3.
@@ -129,56 +109,67 @@ inputs:
 #   # Default is false
 #   exponential: false
 
-# settings.monitoring:
+# agent.monitoring:
 #   # enabled turns on monitoring of running processes
 #   enabled: false
 #   # enables log monitoring
 #   logs: false
 #   # enables metrics monitoring
 #   metrics: false
 
+# # Allow fleet to reload his configuration locally on disk.
+# # Notes: Only specific process configuration will be reloaded.
+# agent.reload:
+#   # enabled configure the Elastic Agent to reload or not the local configuration.
+#   #
+#   # Default is true
+#   enabled: true
+
+#   # period define how frequent we should look for changes in the configuration.
+#   period: 10s
+
 # Logging
 
 # There are four options for the log output: file, stderr, syslog, eventlog
 # The file output is the default.
 
 # Sets log level. The default log level is info.
 # Available log levels are: error, warning, info, debug
-#logging.level: info
+#agent.logging.level: info
 
 # Enable debug output for selected components. To enable all selectors use ["*"]
 # Other available selectors are "beat", "publish", "service"
 # Multiple selectors can be chained.
-#logging.selectors: [ ]
+#agent.logging.selectors: [ ]
 
 # Send all logging output to stderr. The default is false.
-logging.to_stderr: true
+agent.logging.to_stderr: true
 
 # Send all logging output to syslog. The default is false.
-#logging.to_syslog: false
+#agent.logging.to_syslog: false
 
 # Send all logging output to Windows Event Logs. The default is false.
-#logging.to_eventlog: false
+#agent.logging.to_eventlog: false
 
-# If enabled, {{.BeatName | title}} periodically logs its internal metrics that have changed
+# If enabled, Elastic-Agent periodically logs its internal metrics that have changed
 # in the last period. For each metric that changed, the delta from the value at
 # the beginning of the period is logged. Also, the total values for
 # all non-zero internal metrics are logged on shutdown. The default is true.
-#logging.metrics.enabled: true
+#agent.logging.metrics.enabled: true
 
 # The period after which to log the internal metrics. The default is 30s.
-#logging.metrics.period: 30s
+#agent.logging.metrics.period: 30s
 
 # Logging to rotating files. Set logging.to_files to false to disable logging to
 # files.
-#logging.to_files: true
-#logging.files:
+#agent.logging.to_files: true
+#agent.logging.files:
   # Configure the path where the logs are written. The default is the logs directory
   # under the home path (the binary location).
-  #path: /var/log/{{.BeatName}}
+  #path: /var/log/elastic-agent
 
   # The name of the files where the logs are written to.
-  #name: {{.BeatName}}
+  #name: elastic-agent
 
   # Configure log file size limit. If limit is reached, log file will be
   # automatically rotated
@@ -203,9 +194,9 @@ logging.to_stderr: true
   # rotateonstartup: true
 
 # Set to true to log messages in JSON format.
-#logging.json: false
+#agent.logging.json: false
 
 # Set to true, to log messages with minimal required Elastic Common Schema (ECS)
 # information. Recommended to use in combination with `logging.json=true`
 # Defaults to false.
-#logging.ecs: false
+#agent.logging.ecs: false