Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(redis instrumentation): Use latest options in readme #1058

Merged
merged 3 commits into from
Dec 8, 2021
Merged

doc(redis instrumentation): Use latest options in readme #1058

merged 3 commits into from
Dec 8, 2021

Conversation

miry
Copy link
Contributor

@miry miry commented Dec 8, 2021

There is no option enable_statement_obfuscation for
OpenTelemetry::Instrumentation::Redis.
Replace example with option db_statement in README.

@miry miry changed the title [Redis instrumentation] Use latest options in readme doc(redis instrumentation): Use latest options in readme Dec 8, 2021
@@ -47,8 +47,8 @@ end
OpenTelemetry::SDK.configure do |c|
c.use 'OpenTelemetry::Instrumentation::Redis', {
# The obfuscation of arguments in the db.statement attribute is enabled by default.
# To disable, set enable_statement_obfuscation to false.
enable_statement_obfuscation: true,
# To disable, set db_statement to :include or :omit if the tag not required.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Obfuscate is also a valid and supported option.

Suggested change
# To disable, set db_statement to :include or :omit if the tag not required.
# To disable, set db_statement to :include, :obfuscate or :omit if the tag not required.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A bit rephrased the comment - I split options to separate lines.

There is no option `enable_statement_obfuscation` for
`OpenTelemetry::Instrumentation::Redis`.
Replace example with option `db_statement` in README.
Copy link
Contributor

@fbogsany fbogsany left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @miry

@fbogsany fbogsany merged commit 4216a55 into open-telemetry:main Dec 8, 2021
@miry miry deleted the redis-instrumentation-readme branch December 9, 2021 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants