Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xuan-cao-swi committed Oct 10, 2023
1 parent 9c89751 commit 987651c
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 5 deletions.
16 changes: 16 additions & 0 deletions instrumentation/dalli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,22 @@ OpenTelemetry::SDK.configure do |c|
end
```

### Configuration options

```ruby
OpenTelemetry::SDK.configure do |c|
c.use 'OpenTelemetry::Instrumentation::Dalli', {
# You may optionally set a value for 'peer.service', which
# will be included on all spans from this instrumentation:
peer_service: '',

# The obfuscation of query in the db.statement attribute is enabled by default.
# To disable, set db_statement to :include; to omit the query completely, set db_statement to :omit
db_statement: :include,
}
end
```

## How can I get involved?

The `opentelemetry-instrumentation-dalli` gem source is [on github][repo-github], along with related gems including `opentelemetry-api` and `opentelemetry-sdk`.
Expand Down
6 changes: 3 additions & 3 deletions instrumentation/mysql2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ end
```ruby
OpenTelemetry::SDK.configure do |c|
c.use 'OpenTelemetry::Instrumentation::Mysql2', {
# The obfuscation of SQL in the db.statement attribute is disabled by default.
# To enable, set db_statement to :obfuscate.
db_statement: :obfuscate,
# The obfuscation of SQL in the db.statement attribute is enabled by default.
# To disable, set db_statement to :include; to omit the query completely, set db_statement to :omit
db_statement: :include,
}
end
```
Expand Down
4 changes: 2 additions & 2 deletions instrumentation/pg/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ OpenTelemetry::SDK.configure do |c|
# will be included on all spans from this instrumentation:
peer_service: 'postgres:readonly',

# By default, this instrumentation includes the executed SQL as the `db.statement`
# By default, this instrumentation obfuscate/sanitize the executed SQL as the `db.statement`
# semantic attribute. Optionally, you may disable the inclusion of this attribute entirely by
# setting this option to :omit or sanitize the attribute by setting to :obfuscate
# setting this option to :omit or disbale sanitization the attribute by setting to :include
db_statement: :include,
}
end
Expand Down

0 comments on commit 987651c

Please sign in to comment.