useragent

Documentation

Index

• Constants
• func CiCdProvider() string
• func ClearCache()
• func FromContext(ctx context.Context) string
• func InContext(ctx context.Context, key, value string) context.Context
• func Runtime() string
• func Sanitize(s string) string
• func WithProduct(name, version string)
• func WithUserAgentExtra(key, value string)

Constants

const (
	RuntimeKey = "runtime"
	CicdKey    = "cicd"
	AuthKey    = "auth"
)

Functions

func CiCdProvider

func CiCdProvider() string

func ClearCache

func ClearCache()

Clear cached user agent values like the DBR version or the CI/CD provider being used. This is useful for testing.

func FromContext

func FromContext(ctx context.Context) string

FromContext gets compliant user-agent string in a given context

func InContext

func InContext(ctx context.Context, key, value string) context.Context

InContext populates context with user agent dimension, usually to differentiate subsets of functionality and agreed with Databricks.

func Runtime

func Runtime() string

func Sanitize

func Sanitize(s string) string

func WithProduct

func WithProduct(name, version string)

WithProduct sets the product name and product version globally. It should be called by developers to differentiate their application from others.

func WithUserAgentExtra

func WithUserAgentExtra(key, value string)

WithUserAgentExtra sets per-process extra user agent data, which integration developers have agreed with Databricks.