README
¶
v3/integrations/nrpgx5 
Package nrpgx5 instruments https://github.com/jackc/pgx/v5.
import "github.com/newrelic/go-agent/v3/integrations/nrpgx5"
For more information, see godocs.
Documentation
¶
Overview ¶
Package nrpgx5 instruments https://github.com/jackc/pgx/v5.
Use this package to instrument your PostgreSQL calls using the pgx library.
This integration is specifically aimed at instrumenting applications which use the pgx/v5 library to directly communicate with the Postgres database server (i.e., not via the standard database/sql library).
To instrument your database operations, you will need to call nrpgx5.NewTracer() to obtain a pgx.Tracer value. You can do this either with a normal pgx.ParseConfig() call or the pgxpool.ParseConfig() call if you wish to use pgx connection pools.
For example:
import (
"github.com/jackc/pgx/v5"
"github.com/newrelic/go-agent/v3/integrations/nrpgx5"
"github.com/newrelic/go-agent/v3/newrelic"
)
func main() {
cfg, err := pgx.ParseConfig("postgres://postgres:postgres@localhost:5432") // OR pgxpools.ParseConfig(...)
if err != nil {
panic(err)
}
cfg.Tracer = nrpgx5.NewTracer()
conn, err := pgx.ConnectConfig(context.Background(), cfg)
if err != nil {
panic(err)
}
}
See the programs in the example directory for working examples of each use case.
Index ¶
- type Tracer
- func (t *Tracer) TraceBatchEnd(ctx context.Context, conn *pgx.Conn, data pgx.TraceBatchEndData)
- func (t *Tracer) TraceBatchQuery(ctx context.Context, conn *pgx.Conn, data pgx.TraceBatchQueryData)
- func (t *Tracer) TraceBatchStart(ctx context.Context, conn *pgx.Conn, data pgx.TraceBatchStartData) context.Context
- func (Tracer) TraceConnectEnd(ctx context.Context, data pgx.TraceConnectEndData)
- func (t *Tracer) TraceConnectStart(ctx context.Context, data pgx.TraceConnectStartData) context.Context
- func (t *Tracer) TracePrepareEnd(ctx context.Context, conn *pgx.Conn, data pgx.TracePrepareEndData)
- func (t *Tracer) TracePrepareStart(ctx context.Context, conn *pgx.Conn, data pgx.TracePrepareStartData) context.Context
- func (t *Tracer) TraceQueryEnd(ctx context.Context, conn *pgx.Conn, data pgx.TraceQueryEndData)
- func (t *Tracer) TraceQueryStart(ctx context.Context, conn *pgx.Conn, data pgx.TraceQueryStartData) context.Context
- type TracerOption
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Tracer ¶
type Tracer struct {
BaseSegment newrelic.DatastoreSegment
ParseQuery func(segment *newrelic.DatastoreSegment, query string)
SendQueryParameters bool
}
func NewTracer ¶
func NewTracer(o ...TracerOption) *Tracer
NewTracer creates a new value which implements pgx.BatchTracer, pgx.ConnectTracer, pgx.PrepareTracer, and pgx.QueryTracer. This value will be used to facilitate instrumentation of the database operations performed. When establishing a connection to the database, the recommended usage is to do something like the following:
cfg, err := pgx.ParseConfig("...")
if err != nil { ... }
cfg.Tracer = nrpgx5.NewTracer()
conn, err := pgx.ConnectConfig(context.Background(), cfg)
If you do not wish to have SQL query parameters included in the telemetry data, add the WithQueryParameters option, like so:
cfg.Tracer = nrpgx5.NewTracer(nrpgx5.WithQueryParameters(false))
(The default is to collect query parameters, but you can explicitly select this by passing true to WithQueryParameters.)
Note that query parameters may nevertheless be suppressed from the telemetry data due to agent configuration, agent feature set, or policy independint of whether it's enabled here.
func (*Tracer) TraceBatchEnd ¶
TraceBatchEnd is called at the end of a batch. Here we will terminate the datastore segment we started when the batch was started.
func (*Tracer) TraceBatchQuery ¶
TraceBatchQuery is called for each batched query operation. We will add the SQL statement to the segment's ParameterizedQuery value.
func (*Tracer) TraceBatchStart ¶
func (t *Tracer) TraceBatchStart(ctx context.Context, conn *pgx.Conn, data pgx.TraceBatchStartData) context.Context
TraceBatchStart is called at the beginning of SendBatch calls. The returned context is used for the rest of the call and will be passed to TraceBatchQuery and TraceBatchEnd.
func (Tracer) TraceConnectEnd ¶
TraceConnectEnd is called by pgx/v5 at the end of the Connect and ConnectConfig calls.
func (*Tracer) TraceConnectStart ¶
func (t *Tracer) TraceConnectStart(ctx context.Context, data pgx.TraceConnectStartData) context.Context
TraceConnectStart is called at the beginning of Connect and ConnectConfig calls, as what is essentially a callback from the pgx/v5 library to us so we can trace the operation. The returned context is used for the rest of the call and will be passed to TraceConnectEnd.
func (*Tracer) TracePrepareEnd ¶
TracePrepareEnd implements pgx.PrepareTracer.
func (*Tracer) TracePrepareStart ¶
func (t *Tracer) TracePrepareStart(ctx context.Context, conn *pgx.Conn, data pgx.TracePrepareStartData) context.Context
TracePrepareStart is called at the beginning of Prepare calls. The returned context is used for the rest of the call and will be passed to TracePrepareEnd.
The Query and QueryRow will call prepare, so here we don't do any additional work (otherwise we'd duplicate segment data).
func (*Tracer) TraceQueryEnd ¶
TraceQueryEnd is called by pgx/v5 at the completion of Query, QueryRow, and Exec calls. This will terminate the datastore segment started when the database operation was started.
func (*Tracer) TraceQueryStart ¶
func (t *Tracer) TraceQueryStart(ctx context.Context, conn *pgx.Conn, data pgx.TraceQueryStartData) context.Context
TraceQueryStart is called by pgx/v5 at the beginning of Query, QueryRow, and Exec calls. The returned context is used for the rest of the call and will be passed to TraceQueryEnd. This starts a new datastore segment in the transaction stored in the passed context.
type TracerOption ¶
type TracerOption func(*Tracer)
func WithQueryParameters ¶
func WithQueryParameters(enabled bool) TracerOption
WithQueryParameters is an option which may be passed to a call to NewTracer. It controls whether or not to include the SQL query parameters in the telemetry data collected as part of instrumenting database operations.
By default this is enabled. To disable it, call NewTracer as NewTracer(WithQueryParameters(false)).
Note that query parameters may nevertheless be suppressed from the telemetry data due to agent configuration, agent feature set, or policy independint of whether it's enabled here.
Source Files
Directories