docs(instrumentation-redis): add instrumentation options #1029
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which problem is this PR solving?
The Redis instrumentation already accepts several options on initialisation, in a similar manner to the IORedis instrumentation. Unlike in the IORedis instrumentation, however, these options are undocumented for the Redis instrumentation. This PR copies the relevant documentation about initialisation options from the IORedis instrumentation's README to the Redis one, tweaking it where the instrumentation libraries differ.
Short description of the changes
requestHook
option, as it is not supported by the Redis instrumentation.db.statement
serialiser returns the command name and arguments concatenated by spaces. The Redis instrumentation returns only the command name. The examples given for customdb.statement
serialiser functions on each library's README correspond to the other library's defaultdb.statement
serialiser.requireParentSpan
is true. In the Redis instrumentation, it is false.