-
Notifications
You must be signed in to change notification settings - Fork 373
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
refs #176 #332
refs #176 #332
Conversation
Add valuable information which is hidden in the pile of issues
Hello @noma4i and thanks for this suggestion! Actually we describe the Tracer configuration in this section: http://gems.datadoghq.com/trace/docs/#Configure_the_tracer Do you think it's better to state something in the |
@palazzem I know that yard docs contain that. On the other hand readme should contain base configuration suitable to jumpstart with. On/Off switch is valuable info. I think that it needs to be in readme as I came here accross issues and amount of people wondering how to disable tracer with new config is bigger then you think ;) |
Sure thing @noma4i ! consider that I'm collecting feedbacks to improve better our documentation. Let's keep it in the Quickstart section then. |
README.md
Outdated
@@ -76,6 +76,7 @@ you can activate it. The example above would become: | |||
require 'active_record' | |||
|
|||
Datadog.configure do |c| | |||
c.tracer enabled: false # optional flag to disable tracer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this is a quickstart and the default "expected behavior" is to have the tracer enabled (or at least we hope!), can we move this to a different section?
Before "To know if a given framework or lib is supported by our client, please consult our integrations list." we may add:
To configure the Datadog Tracer, you can define the `configure` block as follows:
Datadog.configure do |c|
c.tracer enabled: false, hostname: 'trace-agent.local'
# [...]
end
For a list of available options, check the [Tracer documentation](http://gems.datadoghq.com/trace/docs/#Configure_the_tracer).
What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! as soon you update the PR I'm going to merge it! thank you very much for pointing out this important issue about documentation!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Iv pushed changes. Looks way better
@noma4i thank you very much! going to merge that! |
Add valuable information which is hidden in the pile of issues