Skip to content

Commit

Permalink
Merge pull request #650 from DataDog/fix/add_missing_sidekiq_client_d…
Browse files Browse the repository at this point in the history
…ocumentation

Add Sidekiq `client_service_name` option to documentation
  • Loading branch information
delner authored Dec 6, 2018
2 parents 57df6be + 49f34cc commit f91c184
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -1180,7 +1180,7 @@ Datadog.configure(postgres_database, service_name: 'my-postgres-db')

### Sidekiq

The Sidekiq integration is a server-side middleware which will trace job executions.
The Sidekiq integration is a client-side & server-side middleware which will trace job queuing and executions respectively.

You can enable it through `Datadog.configure`:

Expand All @@ -1196,7 +1196,8 @@ Where `options` is an optional `Hash` that accepts the following parameters:

| Key | Description | Default |
| --- | ----------- | ------- |
| `service_name` | Service name used for `sidekiq` instrumentation | `'sidekiq'` |
| `client_service_name` | Service name used for client-side `sidekiq` instrumentation | `'sidekiq-client'` |
| `service_name` | Service name used for server-side `sidekiq` instrumentation | `'sidekiq'` |
| `tracer` | `Datadog::Tracer` used to perform instrumentation. Usually you don't need to set this. | `Datadog.tracer` |
### Sinatra
Expand Down

0 comments on commit f91c184

Please sign in to comment.