rosshout

PROPOSAL/RFC

roshout is the name of the error reporting mechanism in ROS. It can be thought as comprising several components:

• a roshout node for subscribing, logging, and republishing the messages

• the global /roshout topic

• the global /roshout_agg topic for subscribing to an aggregated feed

• rostools/Log type

• client APIs to facilitate easy use of the roshout reporting mechanism

  • in ["rospy"]: rospy.logerr(), rospy.logdebug(), rospy.logout(), rospy.logwarn()

roshout is a core Node and has preferential startup order.

[http://pr.willowgarage.com/pr-docs/ros-packages/roshout/html/index.html Auto-generated code documentation]

CHANGES

• 8/21/08: renamed to roshout as it will accept messages of various log levels from DEBUG to INFO to ERROR, etc...
• 5/20/08: renamed to roserr, as Tully pointed out the confusion of saying "log it to stderr"
• 5/20/08: severity field added to .msg spec, along with our fancy new constants

• 5/20/08: StdErr.msg -> Log.msg. Slightly more general, so we don't need a separate type for other logging-style messages.

/roshout topic

All nodes connect to the /roshout topic at startup time as publishers.

Log.msg

##
## Severity level constants
##
int FATAL=1  #fatal/critical level
int ERROR=10 #error level
int WARN=20  #warning level
int DEBUG=30 #debug level
int INFO=100 #general level
##
## Fields
##
int level
string name #name of node that failed (autoset)
string msg #error message 
string[] topics #topic names that the node publishes

Client API

The client APIs should hide the actual implementation details. The actual usage should be as simple as:

reportError(msg) reportWarning(msg) reportFatal(msg)

DebugService is another proposal for usage syntax and filtering semantics

Package Status: GetVal(PackageStatusDict,roshout)

Package review meeting notes

FullSearch(title:"roshout/")

Create new package review

Enter the date in the appropriate box to generate a template for a design review meeting. Check the [:QAProcess] page for more information.

NewPage(PackageDesignReviewTemplate, Design Review, roshout, %s Design Review) NewPage(PackageSpecificationReviewTemplate, Specification Review, roshout, %s Specification Review) NewPage(PackageCodeReviewTemplate, Code Review, roshout, %s Code Review)

NewPage(PackageMeetingTemplate, Other meeting notes, roshout, %s)

CategoryPackage