Documentation

Overview

Package otelmongo instruments go.mongodb.org/mongo-driver/mongo.

This package is compatable with v0.2.0 of go.mongodb.org/mongo-driver/mongo.

`NewMonitor` will return an event.CommandMonitor which is used to trace requests.

This code was originally based on the following: - https://github.com/DataDog/dd-trace-go/tree/02f0449efa3cb382d499fadc873957385dcb2192/contrib/go.mongodb.org/mongo-driver/mongo - https://github.com/DataDog/dd-trace-go/tree/v1.23.3/ddtrace/ext

Example

package main import ( "context" "go.mongodb.org/mongo-driver/bson" "go.mongodb.org/mongo-driver/mongo" "go.mongodb.org/mongo-driver/mongo/options" "go.opentelemetry.io/contrib/instrumentation/go.mongodb.org/mongo-driver/mongo/otelmongo" ) func main() { // connect to MongoDB opts := options.Client() opts.Monitor = otelmongo.NewMonitor("test-service") opts.ApplyURI("mongodb://localhost:27017") client, err := mongo.Connect(context.Background(), opts) if err != nil { panic(err) } db := client.Database("example") inventory := db.Collection("inventory") _, err = inventory.InsertOne(context.Background(), bson.D{ {Key: "item", Value: "canvas"}, {Key: "qty", Value: 100}, {Key: "attributes", Value: bson.A{"cotton"}}, {Key: "size", Value: bson.D{ {Key: "h", Value: 28}, {Key: "w", Value: 35.5}, {Key: "uom", Value: "cm"}, }}, }) if err != nil { panic(err) } }

Index

• Constants
• func DBApplication(dbApplication string) attribute.KeyValue
• func DBInstance(dbInstance string) attribute.KeyValue
• func DBName(dbName string) attribute.KeyValue
• func DBOperation(operation string) attribute.KeyValue
• func DBStatement(dbStatement string) attribute.KeyValue
• func DBSystem(dbType string) attribute.KeyValue
• func DBUser(dbUser string) attribute.KeyValue
• func Error(err bool) attribute.KeyValue
• func ErrorMsg(errorMsg string) attribute.KeyValue
• func NewMonitor(serviceName string, opts ...Option) *event.CommandMonitor
• func PeerHostname(peerHostname string) attribute.KeyValue
• func PeerPort(peerport string) attribute.KeyValue
• func ServiceName(serviceName string) attribute.KeyValue
• func TargetHost(targetHost string) attribute.KeyValue
• func TargetPort(targetPort string) attribute.KeyValue
• type Option
  • func WithCommandAttributeDisabled(disabled bool) Option
  • func WithTracerProvider(provider trace.TracerProvider) Option

Examples

• Package

Constants

const (
	DBApplicationKey = attribute.Key("db.application")
	DBNameKey        = attribute.Key("db.name")
	DBSystemKey      = attribute.Key("db.system")
	DBInstanceKey    = attribute.Key("db.instance")
	DBUserKey        = attribute.Key("db.user")
	DBStatementKey   = attribute.Key("db.statement")
)

const (
	// PeerHostname records the host name of the peer.
	PeerHostnameKey = attribute.Key("peer.hostname")
	// PeerPort records the port number of the peer.
	PeerPortKey = attribute.Key("peer.port")
)

const (
	TargetHostKey  = attribute.Key("out.host")
	TargetPortKey  = attribute.Key("out.port")
	ServiceNameKey = attribute.Key("service.name")
	DBOperationKey = attribute.Key("db.operation")
	ErrorKey       = attribute.Key("error")
	ErrorMsgKey    = attribute.Key("error.msg")
)

Variables

This section is empty.

Functions

func DBApplication

func DBApplication(dbApplication string) attribute.KeyValue

DBApplication indicates the application using the database.

func DBInstance

func DBInstance(dbInstance string) attribute.KeyValue

DBInstance indicates the instance name of Database.

func DBName

func DBName(dbName string) attribute.KeyValue

DBName indicates the database name.

func DBOperation

func DBOperation(operation string) attribute.KeyValue

DBOperation defines the name of the operation.

func DBStatement

func DBStatement(dbStatement string) attribute.KeyValue

DBStatement records a database statement for the given database type.

func DBSystem

func DBSystem(dbType string) attribute.KeyValue

DBSystem indicates the system of Database.

func DBUser

func DBUser(dbUser string) attribute.KeyValue

DBUser indicates the user name of Database, e.g. "readonly_user" or "reporting_user".

func Error

func Error(err bool) attribute.KeyValue

Error specifies whether an error occurred.

func ErrorMsg

func ErrorMsg(errorMsg string) attribute.KeyValue

ErrorMsg specifies the error message.

func NewMonitor

func NewMonitor(serviceName string, opts ...Option) *event.CommandMonitor

NewMonitor creates a new mongodb event CommandMonitor.

func PeerHostname

func PeerHostname(peerHostname string) attribute.KeyValue

PeerHostname records the host name of the peer.

func PeerPort

func PeerPort(peerport string) attribute.KeyValue

PeerPort records the port number of the peer.

func ServiceName

func ServiceName(serviceName string) attribute.KeyValue

ServiceName defines the Service name for this Span.

func TargetHost

func TargetHost(targetHost string) attribute.KeyValue

TargetHost sets the target host address.

func TargetPort

func TargetPort(targetPort string) attribute.KeyValue

TargetPort sets the target host port.

Types

type Option

type Option func(*config)

Option specifies instrumentation configuration options.

func WithCommandAttributeDisabled

func WithCommandAttributeDisabled(disabled bool) Option

WithCommandAttributeDisabled specifies if the MongoDB command is added as an attribute to Spans or not. The MongoDB command will be added as an attribute to Spans by default if this option is not provided.

func WithTracerProvider

func WithTracerProvider(provider trace.TracerProvider) Option

WithTracerProvider specifies a tracer provider to use for creating a tracer. If none is specified, the global provider is used.