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.

Sign up for GitHub

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

[docs] update Sinatra documentation with the new API #259

Merged
merged 1 commit into from
Nov 30, 2017
Merged

[docs] update Sinatra documentation with the new API #259

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions docs/GettingStarted.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,10 @@ either ``sinatra`` or ``sinatra/base``:
require 'ddtrace'
require 'ddtrace/contrib/sinatra/tracer'

Datadog.configure do |c|
c.use :sinatra, default_service: 'my-app'
Copy link
Contributor

Choose a reason for hiding this comment

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

I find it strange that default service is not something like 'my-sinatra-app' but that's not the subject of the PR. Just noticed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I just kept the previous value for consistency. All docs will be rewritten after when the new API will be available for all integrations. Thanks for pointing that!

end

get '/' do
'Hello world!'
end
Expand All @@ -149,13 +153,6 @@ The tracing extension will be automatically activated.

#### Configure the tracer

To modify the default configuration, use the ``settings.datadog_tracer.configure`` method. For example,
to change the default service name and activate the debug mode:

configure do
settings.datadog_tracer.configure default_service: 'my-app', debug: true
end

Available settings are:

* ``enabled``: define if the ``tracer`` is enabled or not. If set to ``false``, the code is still instrumented
Expand Down