elephantine

package module

v0.1.0 Latest Latest Go to latest Published: May 2, 2023 License: MIT Imports: 20 Imported by: 11

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ttab/elephantine

Links

Open Source Insights

README ¶

Elephantine

Shared functionality for Elephant systems. It's most likely not something anyone outside of Elephant would be interested in.

Documentation ¶

Index ¶

Constants
func IsHTTPErrorWithStatus(err error, status int) bool
func ListenAndServeContext(ctx context.Context, server *http.Server) error
func RHandleFunc(fn func(http.ResponseWriter, *http.Request, httprouter.Params) error) httprouter.Handle
func ResolveParameter(c *cli.Context, src ParameterSource, name string) (string, error)
func SetUpLogger(logLevel string, w io.Writer) *slog.Logger
func UnmarshalFile(path string, o interface{}) error
func UnmarshalHTTPResource(resURL string, o interface{}) error
type HTTPError
- func HTTPErrorFromResponse(res *http.Response) *HTTPError
- func HTTPErrorf(statusCode int, format string, a ...any) *HTTPError
- func NewHTTPError(statusCode int, message string) *HTTPError
- func (e *HTTPError) Error() string
type HealthServer
- func NewHealthServer(addr string) *HealthServer
- func (s *HealthServer) AddReadyFunction(name string, fn ReadyFunc)
- func (s *HealthServer) Close() error
- func (s *HealthServer) ListenAndServe(ctx context.Context) error
type LazySSM
- func NewLazySSM() *LazySSM
- func (l *LazySSM) GetParameterValue(ctx context.Context, name string) (string, error)
type ParameterSource
- func GetParameterSource(name string) (ParameterSource, error)
type ReadyFunc
type ReadyResult

Constants ¶

View Source

const (
	LogKeyLogLevel     = "log_level"
	LogKeyError        = "err"
	LogKeyCountMetric  = "count_metric"
	LogKeyDocumentUUID = "document_uuid"
	LogKeyTransaction  = "transaction"
	LogKeyOCSource     = "oc_source"
	LogKeyOCVersion    = "oc_version"
	LogKeyOCEvent      = "oc_event"
	LogKeyChannel      = "channel"
	LogKeyMessage      = "message"
	LogKeyDelay        = "delay"
	LogKeyBucket       = "bucket"
	LogKeyObjectKey    = "object_key"
	LogKeyComponent    = "component"
	LogKeyCount        = "count"
	LogKeyEventID      = "event_id"
	LogKeyEventType    = "event_type"
	LogKeyJobLock      = "job_lock"
	LogKeyJobLockID    = "job_lock_id"
	LogKeyState        = "state"
	LogKeyIndex        = "index"
)

Log attribute keys used throughout the application.

Variables ¶

This section is empty.

Functions ¶

func IsHTTPErrorWithStatus ¶

func IsHTTPErrorWithStatus(err error, status int) bool

func ListenAndServeContext ¶

func ListenAndServeContext(ctx context.Context, server *http.Server) error

func RHandleFunc ¶

func RHandleFunc(
	fn func(http.ResponseWriter, *http.Request, httprouter.Params) error,
) httprouter.Handle

func ResolveParameter ¶

func ResolveParameter(
	c *cli.Context, src ParameterSource, name string,
) (string, error)

func SetUpLogger ¶

func SetUpLogger(logLevel string, w io.Writer) *slog.Logger

SetUpLogger creates a default JSON logger and sets it as the global logger.

func UnmarshalFile ¶

func UnmarshalFile(path string, o interface{}) error

func UnmarshalHTTPResource ¶

func UnmarshalHTTPResource(resURL string, o interface{}) error

Types ¶

type HTTPError ¶

type HTTPError struct {
	Status     string
	StatusCode int
	Header     http.Header
	Body       io.Reader
}

func HTTPErrorFromResponse ¶

func HTTPErrorFromResponse(res *http.Response) *HTTPError

func HTTPErrorf ¶

func HTTPErrorf(statusCode int, format string, a ...any) *HTTPError

func NewHTTPError ¶

func NewHTTPError(statusCode int, message string) *HTTPError

func (*HTTPError) Error ¶

func (e *HTTPError) Error() string

type HealthServer ¶

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

HealthServer exposes health endpoints, metrics, and PPROF endpoints.

func NewHealthServer ¶

func NewHealthServer(addr string) *HealthServer

func (*HealthServer) AddReadyFunction ¶

func (s *HealthServer) AddReadyFunction(name string, fn ReadyFunc)

func (*HealthServer) Close ¶

func (s *HealthServer) Close() error

func (*HealthServer) ListenAndServe ¶

func (s *HealthServer) ListenAndServe(ctx context.Context) error

type LazySSM ¶

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

func NewLazySSM ¶

func NewLazySSM() *LazySSM

func (*LazySSM) GetParameterValue ¶

func (l *LazySSM) GetParameterValue(ctx context.Context, name string) (string, error)

type ParameterSource ¶

type ParameterSource interface {
	GetParameterValue(ctx context.Context, name string) (string, error)
}

func GetParameterSource ¶

func GetParameterSource(name string) (ParameterSource, error)

type ReadyFunc ¶

type ReadyFunc func(ctx context.Context) error

type ReadyResult ¶

type ReadyResult struct {
	Ok    bool   `json:"ok"`
	Error string `json:"error,omitempty"`
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
pg
postgres

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL