clientutil

Documentation

Overview

Package clientutil contains the Datadog API client util functions.

Index

• Variables
• func CreateAPIClient(buildInfo component.BuildInfo, endpoint string, hcs confighttp.ClientConfig) *datadog.APIClient
• func CreateZorkianClient(apiKey string, endpoint string) *zorkian.Client
• func GetRequestContext(ctx context.Context, apiKey string) context.Context
• func NewHTTPClient(hcs confighttp.ClientConfig) *http.Client
• func SetDDHeaders(reqHeader http.Header, buildInfo component.BuildInfo, apiKey string)
• func SetExtraHeaders(h http.Header, extras map[string]string)
• func UserAgent(buildInfo component.BuildInfo) string
• func ValidateAPIKey(ctx context.Context, apiKey string, logger *zap.Logger, ...) error
• func ValidateAPIKeyZorkian(logger *zap.Logger, client *zorkian.Client) error
• func WrapError(err error, resp *http.Response) error
• type Retrier
  • func NewRetrier(logger *zap.Logger, settings configretry.BackOffConfig, ...) *Retrier
  • func (r *Retrier) DoWithRetries(ctx context.Context, fn func(context.Context) error) (int64, error)

Variables

var (
	// JSONHeaders headers for JSON requests.
	JSONHeaders = map[string]string{
		"Content-Type":     "application/json",
		"Content-Encoding": "gzip",
	}
	// ProtobufHeaders headers for protobuf requests.
	ProtobufHeaders = map[string]string{
		"Content-Type":     "application/x-protobuf",
		"Content-Encoding": "identity",
	}
)

var ErrInvalidAPI = errors.New("API Key validation failed")

var GZipSubmitMetricsOptionalParameters = datadogV2.NewSubmitMetricsOptionalParameters().WithContentEncoding(datadogV2.METRICCONTENTENCODING_GZIP)

GZipSubmitMetricsOptionalParameters is used to enable gzip compression for metric payloads submitted by native datadog client

Functions

func CreateAPIClient

func CreateAPIClient(buildInfo component.BuildInfo, endpoint string, hcs confighttp.ClientConfig) *datadog.APIClient

CreateAPIClient creates a new Datadog API client

func CreateZorkianClient

func CreateZorkianClient(apiKey string, endpoint string) *zorkian.Client

CreateZorkianClient creates a new Zorkian Datadog client Deprecated: CreateZorkianClient returns a Zorkian Datadog client and Zorkian is deprecated. Use CreateAPIClient instead.

func GetRequestContext

func GetRequestContext(ctx context.Context, apiKey string) context.Context

GetRequestContext creates a new context with API key for DatadogV2 requests

func NewHTTPClient

func NewHTTPClient(hcs confighttp.ClientConfig) *http.Client

NewHTTPClient returns a http.Client configured with a subset of the confighttp.ClientConfig options.

func SetDDHeaders

func SetDDHeaders(reqHeader http.Header, buildInfo component.BuildInfo, apiKey string)

SetDDHeaders sets the Datadog-specific headers

func SetExtraHeaders

func SetExtraHeaders(h http.Header, extras map[string]string)

SetExtraHeaders appends a header map to HTTP headers.

func UserAgent

func UserAgent(buildInfo component.BuildInfo) string

func ValidateAPIKey

func ValidateAPIKey(ctx context.Context, apiKey string, logger *zap.Logger, apiClient *datadog.APIClient) error

ValidateAPIKey checks if the API key (not the APP key) is valid

func ValidateAPIKeyZorkian

func ValidateAPIKeyZorkian(logger *zap.Logger, client *zorkian.Client) error

ValidateAPIKeyZorkian checks that the provided client was given a correct API key. Deprecated: ValidateAPIKeyZorkian uses the deprecated Zorkian client. Use ValidateAPIKey instead.

func WrapError

func WrapError(err error, resp *http.Response) error

WrapError wraps an error to a permanent consumer error that won't be retried if the http response code is non-retriable.

Types

type Retrier

type Retrier struct {
	// contains filtered or unexported fields
}

func NewRetrier

func NewRetrier(logger *zap.Logger, settings configretry.BackOffConfig, scrubber scrub.Scrubber) *Retrier

func (*Retrier) DoWithRetries

func (r *Retrier) DoWithRetries(ctx context.Context, fn func(context.Context) error) (int64, error)

DoWithRetries does a function with retries. This is a condensed version of the code on the exporterhelper, which we reuse here since we want custom retry logic.