Chapter 3. Installing the client-side tools

1. Create config.yaml in your home directory, for example, /home/templates/custom, and configure the MetricsQdrConnectors parameter to point to STF server side:

   MetricsQdrConnectors:
       - host: qdr-normal-sa-telemetry.apps.remote.tld
         port: 443
         role: inter-router
         sslProfile: sslProfile
         verifyHostname: false
   MetricsQdrSSLProfiles:
       - name: sslProfile

2. In the config.yaml file, list the plugins you want to use under CollectdExtraPlugins. You can also provide parameters in the ExtraConfig section. By default, collectd comes with the cpu, df, disk, hugepages, interface, load, memory, processes, tcpconns, unixsock, and uptime plugins. You can add additional plugins using the CollectdExtraPlugins parameter. You can also provide additional configuration information for the CollectdExtraPlugins using the ExtraConfig option. For example, to enable the virt plugin, and configure the connection string and the hostname format, use the following syntax:

   parameter_defaults:
     CollectdExtraPlugins:
       - disk
       - df
       - virt
   
     ExtraConfig:
       collectd::plugin::virt::connection: "qemu:///system"
       collectd::plugin::virt::hostname_format: "hostname uuid"

   Note

   Do not remove the unixsock plugin. Removal results in the permanent marking of the collectd container as unhealthy.

3. Optional: To collect metric and event data through AMQ Interconnect, add the line MetricsQdrExternalEndpoint: true to the config.yaml file:

   parameter_defaults:
       MetricsQdrExternalEndpoint: true

4. To enable collectd-sensubility, add the following environment configuration to the config.yaml file:

   parameter_defaults:
     CollectdEnableSensubility: true
   
     # Use this if there is restricted access for your checks by using the sudo command.
     # The rule will be created in /etc/sudoers.d for sensubility to enable it calling restricted commands via sensubility executor.
     CollectdSensubilityExecSudoRule: "collectd ALL = NOPASSWD: <some command or ALL for all commands>"
   
     # Connection URL to Sensu server side for reporting check results.
     CollectdSensubilityConnection: "amqp://sensu:sensu@<sensu server side IP>:5672//sensu"
   
     # Interval in seconds for sending keepalive messages to Sensu server side.
     CollectdSensubilityKeepaliveInterval: 20
   
     # Path to temporary directory where the check scripts are created.
     CollectdSensubilityTmpDir: /var/tmp/collectd-sensubility-checks
   
     # Path to shell used for executing check scripts.
     CollectdSensubilityShellPath: /usr/bin/sh
   
     # To improve check execution rate use this parameter and value to change the number of goroutines spawned for executing check  scripts.
     CollectdSensubilityWorkerCount: 2
   
     # JSON-formatted definition of standalone checks to be scheduled on client side. If you need to schedule checks
     # on overcloud nodes instead of Sensu server, use this parameter. Configuration is compatible with Sensu check definition.
     # For more information, see https://docs.sensu.io/sensu-core/1.7/reference/checks/#check-definition-specification
     # There are some configuration options which sensubility ignores such as: extension, publish, cron, stdin, hooks.
     CollectdSensubilityChecks:
       example:
         command: "ping -c1 -W1 8.8.8.8"
         interval: 30
   
     # The following parameters are used to modify standard, standalone checks for monitoring container health on overcloud nodes.
     # Do not modify these parameters.
     # CollectdEnableContainerHealthCheck: true
     # CollectdContainerHealthCheckCommand: <snip>
     # CollectdContainerHealthCheckInterval: 10
     # The Sensu server side event handler to use for events created by the container health check.
     # CollectdContainerHealthCheckHandlers:
     #   - handle-container-health-check
     # CollectdContainerHealthCheckOccurrences: 3
     # CollectdContainerHealthCheckRefresh: 90

5. Deploy the overcloud. Include config.yaml, collectd-write-qdr.yaml, and one of the qdr-*.yaml files in your overcloud deploy command:

   $ openstack overcloud deploy
   -e  /home/templates/custom/config.yaml
   -e tripleo-heat-templates/environments/metrics/collectd-write-qdr.yaml
   -e tripleo-heat-templates/environments/metrics/qdr-form-controller-mesh.yaml

6. Optional: To enable overcloud RabbitMQ monitoring, include the collectd-read-rabbitmq.yaml file in the overcloud deploy command.

Procedure

1. Log on to the Red Hat OpenStack Platform undercloud as the stack user.
2. Create a configuration file called data-collection.yaml in the /home/stack directory.

3. To enable external endpoints, add the MetricsQdrExternalEndpoint: true parameter to the data-collection.yaml file:

   parameter_defaults:
       MetricsQdrExternalEndpoint: true

4. To enable collectd and AMQ Interconnect, add the following files to your Red Hat OpenStack Platform director deployment:

   • the data-collection.yaml environment file

   • the qdr-form-controller-mesh.yaml file that enables the client side AMQ Interconnect to connect to the external endpoints

     openstack overcloud deploy <other arguments>
       --templates /usr/share/openstack-tripleo-heat-templates \
       --environment-file <...other-environment-files...> \
       --environment-file /usr/share/openstack-tripleo-heat-templates/environments/metrics/qdr-form-controller-mesh.yaml \
       --environment-file /home/stack/data-collection.yaml

5. Optional: To collect Ceilometer and collectd events, include ceilometer-write-qdr.yaml and collectd-write-qdr.yaml file in your overcloud deploy command.
6. Deploy the overcloud.