Skip to content

Commit 001734b

Browse files
committed
chore: update readme
1 parent 08cd7f5 commit 001734b

4 files changed

Lines changed: 9 additions & 7 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
- Updated OpenTelemetry to
66
[v1.0.1](https://github.com/open-telemetry/opentelemetry-go/releases/tag/v1.0.1).
7-
- Added [otelsql](/extra/otelsql/) instrumentation to instrument database/sql client.
7+
- Added [otelsql](/extra/otelsql/) instrumentation to instrument database/sql client. The
8+
instrumentation records processed queries and reports `sql.DBStats` metrics.
89
- Changed [otelzap](/extra/otelzap/) instrumentation to work with a standard unpatched version of
910
Zap. The logging API is compatible, but you now have to wrap a `zap.Logger` with a
1011
`otelzap.Logger` to add OpenTelemetry instrumentation.

extra/otellogrus/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ See [example](/example/) for details.
4040

4141
## Options
4242

43-
`otellogrus.NewHook` supports the following
43+
[otellogrus.NewHook](https://pkg.go.dev/github.com/uptrace/uptrace-go/extra/otellogrus#NewHook)
44+
accepts the following
4445
[options](https://pkg.go.dev/github.com/uptrace/uptrace-go/extra/otellogrus#Option):
4546

4647
- `otellogrus.WithLevels(logrus.PanicLevel, logrus.FatalLevel, logrus.ErrorLevel, logrus.WarnLevel)`

extra/otelsql/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ See [example](/example/) for details.
3737

3838
## Options
3939

40-
[otelzap.Open](https://pkg.go.dev/github.com/uptrace/uptrace-go/extra/otelsql#Open) and
41-
[otelzap.OpenDB](https://pkg.go.dev/github.com/uptrace/uptrace-go/extra/otelsql#OpenDB) accept a
42-
couple of [options](https://pkg.go.dev/github.com/uptrace/uptrace-go/extra/otelsql#Option):
40+
Both [otelsql.Open](https://pkg.go.dev/github.com/uptrace/uptrace-go/extra/otelsql#Open) and
41+
[otelsql.OpenDB](https://pkg.go.dev/github.com/uptrace/uptrace-go/extra/otelsql#OpenDB) accept the
42+
same [options](https://pkg.go.dev/github.com/uptrace/uptrace-go/extra/otelsql#Option):
4343

4444
- [WithAttributes](https://pkg.go.dev/github.com/uptrace/uptrace-go/extra/otelsql#WithAttributes)
4545
configures attributes that are used to create a span.

extra/otelzap/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ See [example](/example/) for details.
4040

4141
## Options
4242

43-
`otelzap.New` accepts a couple of
44-
[options](https://pkg.go.dev/github.com/uptrace/uptrace-go/extra/otelzap#Option):
43+
[otelzap.New](https://pkg.go.dev/github.com/uptrace/uptrace-go/extra/otelzap#New) accepts a couple
44+
of [options](https://pkg.go.dev/github.com/uptrace/uptrace-go/extra/otelzap#Option):
4545

4646
- `otelzap.WithMinLevel(zap.WarnLevel)` sets the minimal zap logging level on which the log message
4747
is recorded on the span.

0 commit comments

Comments
 (0)