service

Documentation

Overview

Package service provides an HTTP client with features for logging, metrics, and resilience.It supports various functionalities like health checks, circuit-breaker and various authentication.

Package service is a generated GoMock package.

Index

• Constants
• Variables
• func NewCircuitBreaker(config CircuitBreakerConfig, h HTTP) *circuitBreaker
• type APIKeyConfig
  • func (a *APIKeyConfig) AddOption(h HTTP) HTTP
• type BasicAuthConfig
  • func (a *BasicAuthConfig) AddOption(h HTTP) HTTP
• type CircuitBreakerConfig
  • func (cb *CircuitBreakerConfig) AddOption(h HTTP) HTTP
• type DefaultHeaders
  • func (a *DefaultHeaders) AddOption(h HTTP) HTTP
• type ErrorLog
  • func (el *ErrorLog) PrettyPrint(writer io.Writer)
• type HTTP
  • func NewHTTPService(serviceAddress string, logger Logger, metrics Metrics, options ...Options) HTTP
• type Health
• type HealthConfig
  • func (h *HealthConfig) AddOption(svc HTTP) HTTP
• type Log
  • func (l *Log) PrettyPrint(writer io.Writer)
• type Logger
• type Metrics
• type MockMetrics
  • func NewMockMetrics(ctrl *gomock.Controller) *MockMetrics
  • func (m *MockMetrics) EXPECT() *MockMetricsMockRecorder
  • func (m *MockMetrics) RecordHistogram(ctx context.Context, name string, value float64, labels ...string)
• type MockMetricsMockRecorder
  • func (mr *MockMetricsMockRecorder) RecordHistogram(ctx, name, value any, labels ...any) *gomock.Call
• type OAuthConfig
  • func (h *OAuthConfig) AddOption(svc HTTP) HTTP
• type Options
• type Response
  • func (r *Response) GetHeader(key string) string

Constants

const (
	ClosedState = iota
	OpenState
)

circuitBreaker states.

Variables

var (
	// ErrCircuitOpen indicates that the circuit breaker is open.
	ErrCircuitOpen                        = errors.New("unable to connect to server at host")
	ErrUnexpectedCircuitBreakerResultType = errors.New("unexpected result type from circuit breaker")
)

Functions

func NewCircuitBreaker

func NewCircuitBreaker(config CircuitBreakerConfig, h HTTP) *circuitBreaker

NewCircuitBreaker creates a new circuitBreaker instance based on the provided config.

Types

type APIKeyConfig

type APIKeyConfig struct {
	APIKey string
}

func (*APIKeyConfig) AddOption

func (a *APIKeyConfig) AddOption(h HTTP) HTTP

type BasicAuthConfig

type BasicAuthConfig struct {
	UserName string
	Password string
}

func (*BasicAuthConfig) AddOption

func (a *BasicAuthConfig) AddOption(h HTTP) HTTP

type CircuitBreakerConfig

type CircuitBreakerConfig struct {
	Threshold int           // Threshold represents the max no of retry before switching the circuit breaker state.
	Interval  time.Duration // Interval represents the time interval duration between hitting the HealthURL
}

CircuitBreakerConfig holds the configuration for the circuitBreaker.

func (*CircuitBreakerConfig) AddOption

func (cb *CircuitBreakerConfig) AddOption(h HTTP) HTTP

type DefaultHeaders

type DefaultHeaders struct {
	Headers map[string]string
}

func (*DefaultHeaders) AddOption

func (a *DefaultHeaders) AddOption(h HTTP) HTTP

type ErrorLog

type ErrorLog struct {
	*Log
	ErrorMessage string `json:"errorMessage"`
}

func (*ErrorLog) PrettyPrint

func (el *ErrorLog) PrettyPrint(writer io.Writer)

type HTTP

type HTTP interface {

	// HealthCheck to get the service health and report it to the current application
	HealthCheck(ctx context.Context) *Health
	// contains filtered or unexported methods
}

func NewHTTPService

func NewHTTPService(serviceAddress string, logger Logger, metrics Metrics, options ...Options) HTTP

NewHTTPService function creates a new instance of the httpService struct, which implements the HTTP interface. It initializes the http.Client, url, Tracer, and Logger fields of the httpService struct with the provided values.

type Health

type Health struct {
	Status  string                 `json:"status"`
	Details map[string]interface{} `json:"details"`
}

type HealthConfig

type HealthConfig struct {
	HealthEndpoint string
}

func (*HealthConfig) AddOption

func (h *HealthConfig) AddOption(svc HTTP) HTTP

type Log

type Log struct {
	Timestamp     time.Time `json:"timestamp"`
	ResponseTime  int64     `json:"latency"`
	CorrelationID string    `json:"correlationId"`
	ResponseCode  int       `json:"responseCode"`
	HTTPMethod    string    `json:"httpMethod"`
	URI           string    `json:"uri"`
}

func (*Log) PrettyPrint

func (l *Log) PrettyPrint(writer io.Writer)

type Logger

type Logger interface {
	Log(args ...interface{})
}

type Metrics

type Metrics interface {
	RecordHistogram(ctx context.Context, name string, value float64, labels ...string)
}

type MockMetrics

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

MockMetrics is a mock of Metrics interface.

func NewMockMetrics

func NewMockMetrics(ctrl *gomock.Controller) *MockMetrics

NewMockMetrics creates a new mock instance.

func (*MockMetrics) EXPECT

func (m *MockMetrics) EXPECT() *MockMetricsMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockMetrics) RecordHistogram

func (m *MockMetrics) RecordHistogram(ctx context.Context, name string, value float64, labels ...string)

RecordHistogram mocks base method.

type MockMetricsMockRecorder

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

MockMetricsMockRecorder is the mock recorder for MockMetrics.

func (*MockMetricsMockRecorder) RecordHistogram

func (mr *MockMetricsMockRecorder) RecordHistogram(ctx, name, value any, labels ...any) *gomock.Call

RecordHistogram indicates an expected call of RecordHistogram.

type OAuthConfig

type OAuthConfig struct {
	// ClientID is the application's ID.
	ClientID string

	// ClientSecret is the application's secret.
	ClientSecret string

	// TokenURL is the resource server's token endpoint
	// URL. This is a constant specific to each server.
	TokenURL string

	// Scope specifies optional requested permissions.
	Scopes []string

	// EndpointParams specifies additional parameters for requests to the token endpoint.
	EndpointParams url.Values
}

OAuthConfig describes a 2-legged OAuth2 flow, with both the client application information and the server's endpoint URLs.

func (*OAuthConfig) AddOption

func (h *OAuthConfig) AddOption(svc HTTP) HTTP

type Options

type Options interface {
	AddOption(h HTTP) HTTP
}

type Response

type Response struct {
	Body       []byte
	StatusCode int
	// contains filtered or unexported fields
}

func (*Response) GetHeader

func (r *Response) GetHeader(key string) string