From bf32465eb10068d3d6849ccaa971056598dfa3df Mon Sep 17 00:00:00 2001 From: Emma Foley Date: Wed, 14 Dec 2016 17:55:52 +0000 Subject: [PATCH] Add troubleshooting guide Add a trouble shooting guide for debugging common issues in your deployment Change-Id: I8629f2a8ddf21c57878e6b09374aa4558d89e10e --- doc/source/troubleshooting.rst | 45 +++++++++++++++++++ ...roubleshooting-guide-0aceb0a5e9b71787.yaml | 3 ++ 2 files changed, 48 insertions(+) create mode 100644 doc/source/troubleshooting.rst create mode 100644 releasenotes/notes/add-troubleshooting-guide-0aceb0a5e9b71787.yaml diff --git a/doc/source/troubleshooting.rst b/doc/source/troubleshooting.rst new file mode 100644 index 0000000..7c4f4fe --- /dev/null +++ b/doc/source/troubleshooting.rst @@ -0,0 +1,45 @@ +collectd-ceilometer-plugin troubleshooting guide +================================================ + +If you experience issues while deploying or using collectd-ceilometer-plugin, +the information below can help diagnose the problem: + +- What version of keystone is being used in the deployment? + - Version 2 is used in stable/mitaka version of the plugin, but Keystone V2 + has been deprecated. + - Support for Keystone V3 API is available for the Newton release and above. + +- Is ceilometer-acompute service enabled? + - The ceilometer-acompute service provides metrics as well. + - If the metrics from ceilometer-acompute are available, then the issue is + likely with authentication of collectd-ceilometer-plugin. + - If the metrics from ceilometer-acompute are not available, then the issue + is with the database/storage engine, since no metrics are being stored. + +- Are the credentials in collectd-ceilometer-plugin.conf valid? + - Export these credentials to your environment as OS_PROJECT_NAME, + OS_USERNAME and OS_PASSWORD, and use the openstack client. + - If the credentials are valid, you should be able to interact with the + OpenStack services + - If the credentials are invalid, then you should get a response telling + you that. + +- Is the correct OS_AUTH_URL is used? + $ openstack catalog show keystone + $ grep "OS_AUTH_URL" /path/to/collectd.conf.d/collectd-ceilometer-plugin.conf + +- Is collectd-ceilometer-plugin.conf being parsed? + - Does the collectd.conf have an Include block/directive? + :: + Include "/etc/collectd/collectd.conf.d/*.conf" + OR + :: + + Filter "*.conf" + + +- Enable the logfile plugin in collectd for better information (sample + configuration at `../etc/collectd.conf.d/logging.conf`_) + - Make sure to set the LogLevel to “debug” for maximum information + - Use "VERBOSE True" in collectd-ceilometer-plugin.conf, in order to elevate + debug messages to LogLevel info. diff --git a/releasenotes/notes/add-troubleshooting-guide-0aceb0a5e9b71787.yaml b/releasenotes/notes/add-troubleshooting-guide-0aceb0a5e9b71787.yaml new file mode 100644 index 0000000..aec51f3 --- /dev/null +++ b/releasenotes/notes/add-troubleshooting-guide-0aceb0a5e9b71787.yaml @@ -0,0 +1,3 @@ +--- +other: + - Added troubleshooting guide to help debugging.