👩‍🌾 Print debug messages when sensors advertise topics

[chapulina]

🎉 New feature

Summary

I've been trying to debug Gazebo test failures, and having these messages printed should help.

I thought of using ignmsg, but was afraid that it may become spammy on worlds with many sensors.

Test it

Load ign-gazebo with maximum verbosity (-v 4), or run some tests in this repo.

Checklist

• Signed all commits for DCO
• Added tests
• Added example and/or tutorial
• Updated documentation (as needed)
• Updated migration guide (as needed)
• codecheck passed (See contributing)
• All tests passed (See test coverage)
• While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge

🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸

https://github.com/osrf/buildfarmer/issues/224

[codecov]

Codecov Report

Merging #151 (fb61a0e) into ign-sensors3 (a9ce6f9) will increase coverage by 0.30%.
The diff coverage is 96.87%.

@@               Coverage Diff                @@
##           ign-sensors3     #151      +/-   ##
================================================
+ Coverage         77.17%   77.48%   +0.30%     
================================================
  Files                23       23              
  Lines              2344     2367      +23     
================================================
+ Hits               1809     1834      +25     
+ Misses              535      533       -2     

Impacted Files	Coverage Δ
src/CameraSensor.cc	75.37% <83.33%> (+0.55%)	⬆️
src/AirPressureSensor.cc	86.30% <100.00%> (+0.38%)	⬆️
src/AltimeterSensor.cc	88.50% <100.00%> (+0.27%)	⬆️
src/DepthCameraSensor.cc	74.48% <100.00%> (+0.42%)	⬆️
src/GpuLidarSensor.cc	88.53% <100.00%> (+0.14%)	⬆️
src/ImuSensor.cc	90.38% <100.00%> (+0.18%)	⬆️
src/Lidar.cc	73.15% <100.00%> (+0.14%)	⬆️
src/LogicalCameraSensor.cc	90.14% <100.00%> (+0.28%)	⬆️
src/MagnetometerSensor.cc	88.63% <100.00%> (+0.26%)	⬆️
src/RgbdCameraSensor.cc	75.21% <100.00%> (+0.65%)	⬆️
... and 1 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a9ce6f9...fb61a0e. Read the comment docs.

[adlarkin]

LGTM once the comments below are addressed.

Also, should similar debug messages be added to the proposed sensors in #133 and #136?

[chapulina]

Thanks for the review, @adlarkin ! I addressed your comments in fb61a0e

should similar debug messages be added to the proposed sensors in #133 and #136?

Yup, if this gets approved, it would be helpful to preemptively add messages to those sensors so we don't need to remember to do it when merging forward.

[adlarkin]

it would be helpful to preemptively add messages to those sensors so we don't need to remember to do it when merging forward

All done: see 40d86fe and cb19034

---

I approved this PR and all checks are green, so feel free to merge!

[osrf-triage]

This pull request has been mentioned on Gazebo Community. There might be relevant details there:

https://community.gazebosim.org/t/new-ignition-releases-2022-01-10/1228/1