clients

Documentation

Overview

FIXME: golangci-lint nolint:revive

Index

• func AddBasicCredentialsHeader(_ context.Context, req *http.Request)
• func AddOAuth2IdentityHeader(ctx context.Context, req *http.Request, ...) error
• func AddServiceMockIdentityHeader(_ context.Context, req *http.Request) error
• func ConfigureClientWithTLS(client *http.Client) *http.Client
• func GetOutgoingHeaders(ctx context.Context) map[string]string
• type DoerErr
  • func NewDoerErr(err error) *DoerErr
  • func (e *DoerErr) Error() string
  • func (e *DoerErr) Unwrap() error
• type HTTPRequestDoer
  • func NewPlatformClient(ctx context.Context, proxy string) HTTPRequestDoer
• type LoggingDoer
  • func (d *LoggingDoer) Do(req *http.Request) (*http.Response, error)
• type MetricsDoer
  • func (d *MetricsDoer) Do(req *http.Request) (*http.Response, error)

Functions

func AddBasicCredentialsHeader

func AddBasicCredentialsHeader(_ context.Context, req *http.Request)

func AddOAuth2IdentityHeader

func AddOAuth2IdentityHeader(ctx context.Context, req *http.Request, issuerURL, clientID, clientSecret string) error

func AddServiceMockIdentityHeader

func AddServiceMockIdentityHeader(_ context.Context, req *http.Request) error

func ConfigureClientWithTLS

func ConfigureClientWithTLS(client *http.Client) *http.Client

ConfigureClientWithTLS return https client in case there is TLS CA path, otherwise return the original unmodified client and logs an error

func GetOutgoingHeaders

func GetOutgoingHeaders(ctx context.Context) map[string]string

GetOutgoingHeaders returns Red Hat Insights headers from our request to use it in other request that will be used when communicating in Red Hat Insights services

Types

type DoerErr

type DoerErr struct {
	Err error
}

DoerErr is a simple wrapped error without any message. Additional message would stack for each request as multiple doers are called leading to:

"error in doer1: error in doer2: error in doer3: something happened"

func NewDoerErr

func NewDoerErr(err error) *DoerErr

func (*DoerErr) Error

func (e *DoerErr) Error() string

func (*DoerErr) Unwrap

func (e *DoerErr) Unwrap() error

type HTTPRequestDoer

type HTTPRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPRequestDoer is an interface for HTTP request doer. This interface is missing in the standard library and is used to abstract HTTP client creation.

func NewPlatformClient

func NewPlatformClient(ctx context.Context, proxy string) HTTPRequestDoer

NewPlatformClient returns new HTTP client (doer) with optional proxy support and additional logging or tracing. Tracing is only available in local setup (when LOCAL environment variable is set to true).

type LoggingDoer

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

LoggingDoer is a simple HTTP doer that logs request and response data. It is only used in TRACE level mode.

func (*LoggingDoer) Do

func (d *LoggingDoer) Do(req *http.Request) (*http.Response, error)

type MetricsDoer

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

func (*MetricsDoer) Do

func (d *MetricsDoer) Do(req *http.Request) (*http.Response, error)