Skip to content

XSAM/otelsql

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

otelsql

ci codecov Go Report Card Documentation

It is an OpenTelemetry instrumentation for Golang database/sql, a port from open-telemetry/opentelemetry-go-contrib#505.

It instruments traces and metrics.

Install

$ go get github.com/XSAM/otelsql

Usage

This project provides four different ways to instrument database/sql:

otelsql.Open, otelsql.OpenDB, otesql.Register and otelsql.WrapDriver.

And then use otelsql.RegisterDBStatsMetrics to instrument sql.DBStats with metrics.

db, err := otelsql.Open("mysql", mysqlDSN, otelsql.WithAttributes(
	semconv.DBSystemMySQL,
))
if err != nil {
	panic(err)
}
defer db.Close()

err = otelsql.RegisterDBStatsMetrics(db, otelsql.WithAttributes(
	semconv.DBSystemMySQL,
))
if err != nil {
	panic(err)
}

Check Option for more features like adding context propagation to SQL queries when enabling WithSQLCommenter.

See godoc for details.

Blog

Getting started with otelsql, the OpenTelemetry instrumentation for Go SQL, is a blog post that explains how to use otelsql in miutes.

Examples

This project provides two docker-compose examples to show how to use it.

  • The stdout example is a simple example to show how to use it with a MySQL database. It prints the trace data to stdout and serves metrics data via prometheus client.
  • The otel-collector example is a more complex example to show how to use it with a MySQL database and an OpenTelemetry Collector. It sends the trace data and metrics data to an OpenTelemetry Collector. Then, it shows data visually on Jaeger and Prometheus servers.

Trace Instruments

It creates spans on corresponding methods.

Use SpanOptions to adjust creation of spans.

Metric Instruments

Name Description Units Instrument Type Value Type Attribute Key(s) Attribute Values
db.sql.latency The latency of calls in milliseconds ms Histogram float64 status ok, error
method method name, like sql.conn.query
db.sql.connection.max_open Maximum number of open connections to the database Asynchronous Gauge int64
db.sql.connection.open The number of established connections both in use and idle Asynchronous Gauge int64 status idle, inuse
db.sql.connection.wait The total number of connections waited for Asynchronous Counter int64
db.sql.connection.wait_duration The total time blocked waiting for a new connection ms Asynchronous Counter float64
db.sql.connection.closed_max_idle The total number of connections closed due to SetMaxIdleConns Asynchronous Counter int64
db.sql.connection.closed_max_idle_time The total number of connections closed due to SetConnMaxIdleTime Asynchronous Counter int64
db.sql.connection.closed_max_lifetime The total number of connections closed due to SetConnMaxLifetime Asynchronous Counter int64

Compatibility

This project is tested on the following systems.

OS Go Version Architecture
Ubuntu 1.23 amd64
Ubuntu 1.22 amd64
Ubuntu 1.23 386
Ubuntu 1.22 386
MacOS 1.23 amd64
MacOS 1.22 amd64
Windows 1.23 amd64
Windows 1.22 amd64
Windows 1.23 386
Windows 1.22 386

While this project should work for other systems, no compatibility guarantees are made for those systems currently.

The project follows the Release Policy to support major Go releases.

Why port this?

Based on this comment, OpenTelemetry SIG team like to see broader usage and community consensus on an approach before they commit to the level of support that would be required of a package in contrib. But it is painful for users without a stable version, and they have to use replacement in go.mod to use this instrumentation.

Therefore, I host this module independently for convenience and make improvements based on users' feedback.

Communication

I use GitHub discussions/issues for most communications. Feel free to contact me on CNCF slack.