Skip to content

Commit 7d01f05

Browse files
committed
update README
1 parent be02830 commit 7d01f05

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

instrumentation/faraday/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ To install the instrumentation, call `use` with the name of the instrumentation.
1919
```ruby
2020
OpenTelemetry::SDK.configure do |c|
2121
c.use 'OpenTelemetry::Instrumentation::Faraday'
22+
suppress_internal_instrumentation: true
2223
end
2324
```
2425

@@ -30,6 +31,11 @@ OpenTelemetry::SDK.configure do |c|
3031
end
3132
```
3233

34+
### Configuration options
35+
This instrumentation offers the following configuration options:
36+
* `suppress_internal_instrumentation` (default: `false`): When set to `true`, any spans with
37+
span kind of `internal` are suppressed from traces.
38+
3339
## Examples
3440

3541
Example usage of faraday can be seen in the `./example/faraday.rb` file [here](https://github.com/open-telemetry/opentelemetry-ruby-contrib/blob/main/instrumentation/faraday/example/faraday.rb)

0 commit comments

Comments
 (0)