Add an Opbeat Tracer

[olleolleolle]

This PR adds a new autoloaded Tracer implementation for Opbeat.

• load it only if Opbeat is defined (this is taken care of just like newrelic_rpm is required in the file that is autoloaded)
• ask @mikker if this is the way to use Opbeat.trace

[mikker]

Nice! I don't know Hutch – but I noticed one thing. You need to wrap the whole thing in a transaction. Translations have traces. In Rails for example, every action is wrapped in a Transaction, and the DB calls are traces.

Opbeat.transaction(sig, KIND, extra: extra_from(message)) do
  @klass.process(message)
end.done(true)

Be aware that the Opbeat client might need to be started manually if running in another process than Rails (where it's started during boot).

[olleolleolle]

@mikker Is this how to use trace/transaction?

[mikker]

Other way around 😄 Transaction(Trace())

[olleolleolle]

@mikker Thanks for checking my work. Re-check?

[olleolleolle]

Consider: Make this scrubbable, somehow?

[mikker]

Scrubbable how? You don't need the trace, actually. Transaction automatically have one root trace, so adding another one is probably redundant. I can see how I could've let you to add one. Sorry.

[olleolleolle]

Thanks for the note on the trace, I'll remove that inner bit.

[olleolleolle]

On scrubbing: As we may send confidential information in a Message, its body is perhaps not for everyone's eyes.

[olleolleolle]

The scrubbing feature is way outside the scope of this PR. (Use-cases include: Anonymize hospital person data, for instance. Name=Jane Doe, that kind of thing.)

[michaelklishin]

Data scrubbing is arguably outside of Hutch's scope. If you are serious about this, use TLS and payload encryption, then scrub as much as you need in your own app.

[olleolleolle]

@michaelklishin What's your preferred way to "only ever load this if defined?(Opbeat)"?

[olleolleolle]

The JRuby seems to have had a hiccup on an unrelated test.

[michaelklishin]

@olleolleolle Kernel#autoload? just a condition with a require? I don't have a strong opinion.

[michaelklishin]

Thank you!

[mikker]

Thank you for this! 👍 (cc @roncohen)

[olleolleolle]

Go team! So many incremental baby-steps, so many helpful nudges and high-fives.