Add support for Client#event and Client#service_check - Githubissues

Shopify / statsd-instrument

A StatsD client for Ruby apps. Provides metaprogramming methods to inject StatsD instrumentation into your code.

http://shopify.github.io/statsd-instrument

MIT License

570 stars 94 forks source link

Add support for Client#event and Client#service_check #196

Closed wvanbergen closed 4 years ago

wvanbergen commented 4 years ago

Those methods are only supported in DogStatsD, so will only be available when using the DogStatsD datagram builder. See https://docs.datadoghq.com/developers/dogstatsd/datagram_shell/ for the datagram format.

Questions:

Note that neither of these support sample rates in their datagram formats. We could still apply sampling if we want to, but I think that's generally not what you'd expect. What do you think?
Related, I don't expect these metrics to be emitted very often, and we can be a bit more strict w.r.t. input validation. Anything that we should check?
Should we still use prefixes when one is defined on the client?

TODO in followups or in this PR:

~Ensure the legacy API is compatible with the new one. (The old API is kind of awful, but we should do our best)~ A compatibility test has been added.
Ensure the datagram parser can parse these datagrams.

wvanbergen commented 4 years ago

Prefixes are now supported.

After refactoring the current implementation of StatsD.event and StatsD.service_check to make sure they are actually according to spec, I was able to add a compatibility test that affirms the different implementations now behave the same.

This is ready for a final look.