Chapter 3. Installing and configuring operational measurement tools
You must install the data collecting agent, collectd, and the time-series database, Gnocchi.
3.1. Installing collectd Copy linkLink copied to clipboard!
When you install collectd, you can configure multiple collectd plug-ins to suit your environment.
Procedure
-
Copy the file
/usr/share/openstack-tripleo-heat-templates/environments/collectd-environment.yaml
to your local directory. Open
collectd-environment.yaml
and list the plug-ins you want underCollectdExtraPlugins
. You can also provide parameters in theExtraConfig
section:Copy to Clipboard Copied! Toggle word wrap Toggle overflow By default, collectd comes with the
disk
,interface
,load
,memory
,processes
, andtcpconns
plug-ins. You can add additional plug-ins using theCollectdExtraPlugins
parameter. You can also provide additional configuration information for the CollectdExtraPlugins using theExtraConfig
option as shown. This example adds thevirt
plug-in and configures the connection string and the hostname format.Include the modified YAML files in the
openstack overcloud deploy
command to install the collectd daemon on all overcloud nodes:openstack overcloud deploy
$ openstack overcloud deploy --templates \/home/templates/environments/collectd.yaml \ -e /path-to-copied/collectd-environment.yaml
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Additional resources
- For more information about collectd, see Section 1.3.2, “collectd”.
- To view the collectd plug-ins and configurations, see collectd plug-ins in the Service Telemetry Framework guide.
3.2. Installing Gnocchi Copy linkLink copied to clipboard!
By default, Gnocchi is not enabled on the undercloud. Red Hat does not recommend that you enable Telemetry on the undercloud as it generates a lot of data that the undercloud cannot handle due to limited resources and single point of failure.
By default, Telemetry and Gnocchi are installed on the controller and Compute nodes. The default storage back end for Gnocchi is file.
You can deploy Gnocchi on the overcloud in one of two ways:
- Internally. For more information, see Section 3.2.1, “Deploying Gnocchi internally”.
- Externally. For more information, see Section 3.2.2, “Deploying Gnocchi externally”.
3.2.1. Deploying Gnocchi internally Copy linkLink copied to clipboard!
The default deployment is internal.
Procedure
-
To deploy collectd to send metrics data to internal Gnocchi, add
/usr/share/openstack-tripleo-heat-templates/environments/services/collectd.yaml
to theovercloud deploy
command.
Additional resources
- For more information, see Section 3.1, “Installing collectd”.
3.2.2. Deploying Gnocchi externally Copy linkLink copied to clipboard!
Procedure
Create a custom YAML file in your local directory, for example
ExternalGnocchi.yaml
, and ensure that you include the following details:CollectdGnocchiServer: <IPofExternalServer> CollectdGnocchiUser: admin CollectdGnocchiAuth: basic
CollectdGnocchiServer: <IPofExternalServer> CollectdGnocchiUser: admin CollectdGnocchiAuth: basic
Copy to Clipboard Copied! Toggle word wrap Toggle overflow To deploy Gnocchi, add the custom YAML file to the
overcloud deploy
command. Replace<existing_overcloud_environment_files>
with the list of environment files that are part of your existing deployment.openstack overcloud deploy \ -e <existing_overcloud_environment_files> \ -e /usr/share/openstack-tripleo-heat-templates/environments/services/collectd.yaml \ -e /home/templates/environments/ExternalGnocchi.yaml \ ...
openstack overcloud deploy \ -e <existing_overcloud_environment_files> \ -e /usr/share/openstack-tripleo-heat-templates/environments/services/collectd.yaml \ -e /home/templates/environments/ExternalGnocchi.yaml \ ...
Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteYou can find all of the Gnocchi parameters in the following YAML file:
/usr/share/openstack-tripleo-heat-templates/puppet/services/metrics/collectd.yaml
3.2.3. Verifying the Gnocchi deployment Copy linkLink copied to clipboard!
Procedure
List the new resources and metrics:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow