Log with Logrus; allow for logger injection

[trevrosen]

Fixes #508

What

• Adds Logrus to the build
• Replaces usage of log package from std lib with Logrus
• Adds RegisterLogger functions to api and gobot packages

Why

• Requested in Override the default log with logrus? #508
• Logrus has more features than std lib
• Using a RegisterLogger function allows for injecting a common logger

Questions

• Does this solve the request in Override the default log with logrus? #508? (cc @ferventgeek)
• Should we leave the examples directory alone on the theory that it's best to show only Gobot packages and stdlib there? I opted to change b/c of the injection behavior's availability, but could see an argument for keeping it pure stdlib.

[trevrosen]

@ferventgeek please have a look here when you get a chance and let me know if this is what you have in mind or if you'd like to see further extension. Also: as we appear to have the same employer, feel free to get in touch IRL any time re Gobot. 😺

[trevrosen]

@deadprogram the thought occurs that we could go a step further and formalize a method of log support at either the driver or platform level. I've got a couple ideas around what that could look like.

[trevrosen]

@deadprogram any thoughts on whether we should continue w/ merging here? I'll update to fix the deps conflict if so. I'd also like to squash merge this one if possible due to my own vain desire to keep some of my derping around from the log and reduce noise 😃

[codecov]

Codecov Report

Merging #528 into dev will decrease coverage by 0.01%.
The diff coverage is 0%.

@@            Coverage Diff             @@
##              dev     #528      +/-   ##
==========================================
- Coverage   51.49%   51.48%   -0.02%     
==========================================
  Files         162      162              
  Lines       15536    15540       +4     
==========================================
  Hits         8001     8001              
- Misses       7133     7137       +4     
  Partials      402      402

Impacted Files	Coverage Δ
drivers/i2c/mcp23017_driver.go	91.25% <ø> (ø)	⬆️
device.go	100% <ø> (ø)	⬆️
drivers/i2c/adafruit_driver.go	74.46% <ø> (ø)	⬆️
platforms/ble/ble_client_adaptor.go	12.19% <ø> (ø)	⬆️
platforms/audio/audio_adaptor.go	80% <ø> (ø)	⬆️
platforms/keyboard/keyboard_driver.go	38.23% <ø> (ø)	⬆️
robot.go	100% <ø> (ø)	⬆️
connection.go	92.3% <0%> (-7.7%)	⬇️
api/api.go	94.8% <0%> (-0.83%)	⬇️

---

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 0f859ff...9ee6b8b. Read the comment docs.

[trevrosen]

Closing. May re-open later.

[ferventgeek]

This is awesome, thanks for the update. Logging refactoring is always tricky- this will really help with IoT projects and random robot images with no serial connector. I'll have time to test in early January.

[trevrosen]

The PR is closed now after being open for comment for 7 months. I’m not satisfied with the change as it stood anyway. May revisit at some point in the future.

[ferventgeek]

Ahh, well it happens. Would still like integrated exportable logs, but then again who doesn't. ;-) I'm all over the Arduino/ESP32 gizmo over the holiday anyway. ;-)

[NikolaeVarius]

So, what were you not satisfied with? Is there some sort of design goal we want to work torward with logging?

I'm specifically interested in how we might want to handle telemetry data. I think that should be considered a seperate thread alongside logging.