valkey

Documentation

Overview

Package valkey provides tracing functions for tracing the valkey-io/valkey-go package (https://github.com/valkey-io/valkey-go).

Example

To start tracing Valkey, simply create a new client using the library and continue using as you normally would.

tracer.Start()
defer tracer.Stop()

vk, err := valkeytrace.NewClient(valkey.ClientOption{
	InitAddress: []string{"localhost:6379"},
})
if err != nil {
	log.Fatal(err)
	return
}

if err := vk.Do(context.Background(), vk.B().Set().Key("key").Value("value").Build()).Error(); err != nil {
	log.Fatal(err)
	return
}

Index

• func NewClient(clientOption valkey.ClientOption, opts ...Option) (valkey.Client, error)
• type Option
  • func WithRawCommand(rawCommand bool) Option
  • func WithServiceName(name string) Option

Examples

• Package

Functions

func NewClient

func NewClient(clientOption valkey.ClientOption, opts ...Option) (valkey.Client, error)

NewClient returns a new valkey.Client enhanced with tracing.

Types

type Option

type Option func(*config)

Option represents an option that can be used to create or wrap a client.

func WithRawCommand

func WithRawCommand(rawCommand bool) Option

WithRawCommand can be used to set a tag `valkey.raw_command` in the created spans (disabled by default). Warning: please note the datadog-agent currently does not support obfuscation for this tag, so use this at your own risk.

func WithServiceName

func WithServiceName(name string) Option

WithServiceName sets the given service name for the client.