Feature #2555: Allow easy debugging of RSB configuration - Robotics Service Bus - Open Source Collaboration Platform

Feature #2555

Status:

In Progress

Start date:

04/04/2013

Priority:

Normal

Due date:

Assignee:

% Done:

90%

Category:

Configuration

Target version:

Description

With RSB configuration, it is sometimes hard to debug issues or even understand what is going on exactly.

One way would be an appropriate logging configuration, but not an easy way:

Requires knowledge about logger hierarchy (i.e. something like export RSB_RSC_LOGGING_RSC_CONFIG=ALL)
Requires modifying the configuration which may interfere with the issue being debugged
Requires sifting through tons of output and figuring out what is going on
Depends on the RSB implementation

A better solution might be

Set an environment variable __CONFIG_DEBUG
Process it outside the configuration system (as to not interfere)
The output should be minimal (as to not require searching for the relevant information)

Subtasks

Config debug in {common-command-line-options,specification-config,troubleshooting,news}.rst

refs #2555, refs #2556

common-command-line-options.rst (Configuration Debugging): new
section; describe __CONFIG_DEBUG environment variable
specification-config.rst (Configuration Debugging): new section;
describe configuration debugging tools
troubleshooting.rst (Configuration Problems): new section; suggest
configuration debugging tools to solve configuration problems
news.rst (RSB 0.14): reference configuration debugging section

Backport: Config debug in {common-command-line-options,specification-config,troubleshooting,news}.rst

refs #2555, refs #2556

common-command-line-options.rst (Configuration Debugging): new
section; describe __CONFIG_DEBUG environment variable
specification-config.rst (Configuration Debugging): new section;
describe configuration debugging tools
troubleshooting.rst (Configuration Problems): new section; suggest
configuration debugging tools to solve configuration problems
news.rst (RSB 0.14): reference configuration debugging section

(cherry picked from commit 3ea7f7ad1af7030cb5e3675ea827f74d140a6712)

Updated configuration debugging description in *.rst

common-command-line-options.rst (Common Environment Variables):
changed variable name {__ -> RSB_}CONFIG_DEBUG
specification-config.rst (Configuration Debugging): likewise; updated
example output
news.rst (RSB 0.14): do not try to parse _CONFIG_DEBUG as an envvar
reference

Mention config debugging support in all implementations in news.rst

troubleshooting.rst (Configuration Problems): applies to all
implementations
news.rst (RSB 0.15): mention configuration debugging support in all
implementations, C++ already had it