otelutils

Documentation

Index

• Constants
• Variables
• func GetTracerProvider(serviceName string) rawtrace.TracerProvider
• func NewSpan(ctx context.Context, serviceName string, spanName string) (context.Context, rawtrace.Span)
• func RegisterTracerProvider(serviceName string, config *Config) error
• func WrapK8sCache(c cache.Cache) cache.Cache
• func WrapK8sClient(c client.Client) client.Client
• type Config
  • func GetConfig() *Config
  • func (cfg Config) GetPFlagSet(prefix string) *pflag.FlagSet
• type ExporterType
• type FileConfig
• type JaegerConfig
• type K8sCacheWrapper
  • func (c *K8sCacheWrapper) Get(ctx context.Context, key client.ObjectKey, obj client.Object, ...) error
  • func (c *K8sCacheWrapper) List(ctx context.Context, list client.ObjectList, opts ...client.ListOption) error
• type K8sClientWrapper
  • func (c *K8sClientWrapper) Create(ctx context.Context, obj client.Object, opts ...client.CreateOption) error
  • func (c *K8sClientWrapper) Delete(ctx context.Context, obj client.Object, opts ...client.DeleteOption) error
  • func (c *K8sClientWrapper) DeleteAllOf(ctx context.Context, obj client.Object, opts ...client.DeleteAllOfOption) error
  • func (c *K8sClientWrapper) Get(ctx context.Context, key client.ObjectKey, obj client.Object, ...) error
  • func (c *K8sClientWrapper) List(ctx context.Context, list client.ObjectList, opts ...client.ListOption) error
  • func (c *K8sClientWrapper) Patch(ctx context.Context, obj client.Object, patch client.Patch, ...) error
  • func (c *K8sClientWrapper) Status() client.StatusWriter
  • func (c *K8sClientWrapper) Update(ctx context.Context, obj client.Object, opts ...client.UpdateOption) error
• type K8sStatusWriterWrapper
  • func (s *K8sStatusWriterWrapper) Patch(ctx context.Context, obj client.Object, patch client.Patch, ...) error
  • func (s *K8sStatusWriterWrapper) Update(ctx context.Context, obj client.Object, opts ...client.SubResourceUpdateOption) error

Constants

const (
	AdminClientTracer       = "admin-client"
	AdminGormTracer         = "admin-gorm"
	AdminServerTracer       = "admin-server"
	BlobstoreClientTracer   = "blobstore-client"
	DataCatalogClientTracer = "datacatalog-client"
	DataCatalogGormTracer   = "datacatalog-gorm"
	DataCatalogServerTracer = "datacatalog-server"
	NebulaPropellerTracer   = "nebulapropeller"
	K8sClientTracer         = "k8s-client"
)

Variables

var (
	ConfigSection = config.MustRegisterSection(configSectionKey, defaultConfig)
)

Functions

func GetTracerProvider

func GetTracerProvider(serviceName string) rawtrace.TracerProvider

func NewSpan

func NewSpan(ctx context.Context, serviceName string, spanName string) (context.Context, rawtrace.Span)

func RegisterTracerProvider

func RegisterTracerProvider(serviceName string, config *Config) error

func WrapK8sCache

func WrapK8sCache(c cache.Cache) cache.Cache

func WrapK8sClient

func WrapK8sClient(c client.Client) client.Client

Types

type Config

type Config struct {
	ExporterType ExporterType `json:"type" pflag:",Sets the type of exporter to configure [noop/file/jaeger]."`
	FileConfig   FileConfig   `json:"file" pflag:",Configuration for exporting telemetry traces to a file"`
	JaegerConfig JaegerConfig `json:"jaeger" pflag:",Configuration for exporting telemetry traces to a jaeger"`
}

func GetConfig

func GetConfig() *Config

func (Config) GetPFlagSet

func (cfg Config) GetPFlagSet(prefix string) *pflag.FlagSet

GetPFlagSet will return strongly types pflags for all fields in Config and its nested types. The format of the flags is json-name.json-sub-name... etc.

type ExporterType

type ExporterType = string

const (
	NoopExporter   ExporterType = "noop"
	FileExporter   ExporterType = "file"
	JaegerExporter ExporterType = "jaeger"
)

type FileConfig

type FileConfig struct {
	Filename string `json:"filename" pflag:",Filename to store exported telemetry traces"`
}

type JaegerConfig

type JaegerConfig struct {
	Endpoint string `json:"endpoint" pflag:",Endpoint for the jaeger telemtry trace ingestor"`
}

type K8sCacheWrapper

type K8sCacheWrapper struct {
	cache.Cache
}

func (*K8sCacheWrapper) Get

func (c *K8sCacheWrapper) Get(ctx context.Context, key client.ObjectKey, obj client.Object, opts ...client.GetOption) error

func (*K8sCacheWrapper) List

func (c *K8sCacheWrapper) List(ctx context.Context, list client.ObjectList, opts ...client.ListOption) error

type K8sClientWrapper

type K8sClientWrapper struct {
	client.Client
	// contains filtered or unexported fields
}

func (*K8sClientWrapper) Create

func (c *K8sClientWrapper) Create(ctx context.Context, obj client.Object, opts ...client.CreateOption) error

func (*K8sClientWrapper) Delete

func (c *K8sClientWrapper) Delete(ctx context.Context, obj client.Object, opts ...client.DeleteOption) error

func (*K8sClientWrapper) DeleteAllOf

func (c *K8sClientWrapper) DeleteAllOf(ctx context.Context, obj client.Object, opts ...client.DeleteAllOfOption) error

func (*K8sClientWrapper) Get

func (c *K8sClientWrapper) Get(ctx context.Context, key client.ObjectKey, obj client.Object, opts ...client.GetOption) error

func (*K8sClientWrapper) List

func (c *K8sClientWrapper) List(ctx context.Context, list client.ObjectList, opts ...client.ListOption) error

func (*K8sClientWrapper) Patch

func (c *K8sClientWrapper) Patch(ctx context.Context, obj client.Object, patch client.Patch, opts ...client.PatchOption) error

func (*K8sClientWrapper) Status

func (c *K8sClientWrapper) Status() client.StatusWriter

func (*K8sClientWrapper) Update

func (c *K8sClientWrapper) Update(ctx context.Context, obj client.Object, opts ...client.UpdateOption) error

type K8sStatusWriterWrapper

type K8sStatusWriterWrapper struct {
	client.StatusWriter
}

func (*K8sStatusWriterWrapper) Patch

func (s *K8sStatusWriterWrapper) Patch(ctx context.Context, obj client.Object, patch client.Patch, opts ...client.SubResourcePatchOption) error

func (*K8sStatusWriterWrapper) Update

func (s *K8sStatusWriterWrapper) Update(ctx context.Context, obj client.Object, opts ...client.SubResourceUpdateOption) error