Subscriber base classes need documentation #3295
Description
node-newrelic/lib/subscribers/db.js
Line 10 in 436c3c9
^ as an example.
I am looking in to what it will take for #3289, and I am having difficulty understanding which parts I will need to use and how to use those parts. I think it would be easier to understand if the base classes were extensively documented with jsdoc.
For further illustration of this issue, what is the difference between a DbSubscriber and a DbQuerySubscriber? Which one, if either, should be used for instrumenting a traditional DBMS engine?
I would expect to see documentation like the following on all of the baseline subscriber classes:
/**
* DbQuerySubscriber provides a base class for instrumenting
* database engines like `MySQL` and `PostgreSQL`. See
* {@link DbOperationSubscriber} for key-value database engines
* and {@link Whatever} for document store engines.
*
* Probably some more text here that provides pointers for
* implementing new instrumentations based on this class.
* Maybe link to a particularly easy to understand specific
* implementation as an example to follow.
*/
class DbQuerySubscriber extends DbSubscriber {}