goutils

Dec 2, 2023

Changes in this version

+ type MessageBus interface

+ CreateTopic func(ctxt context.Context, topicName string, topicLogTags log.Fields) (MessageTopic, error)

+ DeleteTopic func(ctxt context.Context, topicName string) error

+ GetTopic func(ctxt context.Context, topicName string) (MessageTopic, error)

+ func GetNewMessageBusInstance(parentCtxt context.Context, logTags log.Fields) (MessageBus, error)

+ type MessageTopic interface

+ CreateSubscription func(ctxt context.Context, subscriber string, bufferLen int) (chan interface{}, error)

+ DeleteSubscription func(ctxt context.Context, subscriber string) error

+ Publish func(ctxt context.Context, message interface{}, blockFor time.Duration) error

Sep 7, 2023

Changes in this version

+ func DefineHTTPClient(parentCtxt context.Context, retryConfig HTTPClientRetryConfig, ...) (*resty.Client, error)

+ type HTTPClientAuthConfig struct

+ ClientID string

+ ClientSecret string

+ IssuerURL string

+ LogTags log.Fields

+ TargetAudience string

+ type HTTPClientRetryConfig struct

+ InitWaitTime time.Duration

+ MaxAttempts int

+ MaxWaitTime time.Duration

Jul 26, 2023

Changes in this version

+ type HTTPRequestMetricHelper interface

+ RecordRequest func(method string, status int, latency time.Duration, respSize int64)

+ type MetricsCollector interface

+ ExposeCollectionEndpoint func(router *mux.Router, metricsPath string, maxSupportedRequest int)

+ InstallApplicationMetrics func()

+ InstallCustomCounterVecMetrics func(ctxt context.Context, metricsName string, metricsHelpMessage string, ...) (*prometheus.CounterVec, error)

+ InstallCustomGaugeVecMetrics func(ctxt context.Context, metricsName string, metricsHelpMessage string, ...) (*prometheus.GaugeVec, error)

+ InstallHTTPMetrics func() HTTPRequestMetricHelper

+ InstallPubSubMetrics func() PubSubMetricHelper

+ func GetNewMetricsCollector(logTags log.Fields, customLogModifiers []LogMetadataModifier) (MetricsCollector, error)

+ type PubSubMetricHelper interface

+ RecordPublish func(topic string, successful bool, payloadLen int64)

+ RecordReceive func(topic string, successful bool, payloadLen int64)

type RestAPIHandler

+ MetricsHelper HTTPRequestMetricHelper

Jul 25, 2023

Changes in this version

+ type RRInboundRequestHandler func(ctxt context.Context, request interface{}, origMsg ReqRespMessage) (interface{}, error)

+ type RRMessageParser func(rawMsg []byte) (interface{}, error)

+ type RequestResponseDriver struct

+ Client RequestResponseClient

+ PayloadParser RRMessageParser

+ func (d *RequestResponseDriver) InstallHandler(requestType reflect.Type, handler RRInboundRequestHandler)

+ func (d *RequestResponseDriver) MakeRequest(ctxt context.Context, requestInstanceName string, targetID string, ...) ([]interface{}, error)

+ func (d *RequestResponseDriver) ProcessInboundRequest(ctxt context.Context, msg ReqRespMessage) error

Jul 11, 2023

Changes in this version

+ type HTTPRequestLogLevel string

+ const HTTPLogLevelDEBUG

+ const HTTPLogLevelINFO

+ const HTTPLogLevelWARN

type RestAPIHandler

+ LogLevel HTTPRequestLogLevel

Jul 3, 2023

Changes in this version

+ type ClientCredOAuthTokenManagerParam struct

+ ClientID string

+ ClientSecret string

+ CustomLogModifiers []LogMetadataModifier

+ IDPIssuerURL string

+ LogTags log.Fields

+ TargetAudience string

+ type HTTPRequestRetryParam struct

+ InitialWaitTime time.Duration

+ MaxRetires int

+ MaxWaitTime time.Duration

+ type OAuthTokenManager interface

+ GetToken func(ctxt context.Context, timestamp time.Time) (string, error)

+ Stop func(ctxt context.Context) error

+ func GetNewClientCredOAuthTokenManager(parentCtxt context.Context, httpClient resty.Client, ...) (OAuthTokenManager, error)

Jun 17, 2023

Changes in this version

+ func CreateBasicGCPPubSubClient(ctxt context.Context, projectID string) (*pubsub.Client, error)

+ func TimeBoundedWaitGroupWait(wgCtxt context.Context, wg *sync.WaitGroup, timeout time.Duration) error

+ type PubSubClient interface

+ Close func(ctxt context.Context) error

+ CreateSubscription func(ctxt context.Context, targetTopic, subscription string, ...) error

+ CreateTopic func(ctxt context.Context, topic string, config *pubsub.TopicConfig) error

+ DeleteSubscription func(ctxt context.Context, subscription string) error

+ DeleteTopic func(ctxt context.Context, topic string) error

+ GetSubscription func(ctxt context.Context, subscription string) (pubsub.SubscriptionConfig, error)

+ GetTopic func(ctxt context.Context, topic string) (pubsub.TopicConfig, error)

+ Publish func(ctxt context.Context, topic string, message []byte, metadata map[string]string, ...) (*pubsub.PublishResult, error)

+ Subscribe func(ctxt context.Context, subscription string, handler PubSubMessageHandler) error

+ UpdateLocalSubscriptionCache func(ctxt context.Context) error

+ UpdateLocalTopicCache func(ctxt context.Context) error

+ UpdateSubscription func(ctxt context.Context, subscription string, ...) error

+ UpdateTopic func(ctxt context.Context, topic string, newConfig pubsub.TopicConfigToUpdate) error

+ func GetNewPubSubClientInstance(client *pubsub.Client, logTags log.Fields) (PubSubClient, error)

+ type PubSubMessageHandler func(ctxt context.Context, pubTimestamp time.Time, msg []byte, ...) error

+ type PubSubRequestResponseClientParam struct

+ CustomLogModifiers []LogMetadataModifier

+ LogTags log.Fields

+ MsgRetentionTTL time.Duration

+ Name string

+ PSClient PubSubClient

+ SupportWorkerCount int

+ TargetID string

+ TimeoutEnforceInt time.Duration

+ type ReqRespMessage struct

+ IsRequest bool

+ Metadata map[string]string

+ Payload []byte

+ RequestID string

+ SenderID string

+ TargetID string

+ Timestamp time.Time

+ type ReqRespMessageHandler func(ctxt context.Context, msg ReqRespMessage) error

+ type ReqRespTimeoutHandler func(ctxt context.Context) error

+ type RequestCallParam struct

+ Blocking bool

+ ExpectedResponsesCount int

+ RespHandler ReqRespMessageHandler

+ Timeout time.Duration

+ TimeoutHandler ReqRespTimeoutHandler

+ type RequestResponseClient interface

+ Request func(ctxt context.Context, targetID string, message []byte, ...) (string, error)

+ Respond func(ctxt context.Context, originalReq ReqRespMessage, message []byte, ...) error

+ SetInboundRequestHandler func(ctxt context.Context, handler ReqRespMessageHandler) error

+ Stop func(ctxt context.Context) error

+ func GetNewPubSubRequestResponseClientInstance(parentCtxt context.Context, params PubSubRequestResponseClientParam) (RequestResponseClient, error)

May 7, 2022

Changes in this version

type RestAPIHandler

+ func (h RestAPIHandler) ReadRequestIDFromContext(ctxt context.Context) string

May 6, 2022

Changes in this version

+ func ModifyLogMetadataByRestRequestParam(ctxt context.Context, theTags log.Fields)

+ type Component struct

+ LogTagModifiers []LogMetadataModifier

+ LogTags log.Fields

+ func (c Component) GetLogTagsForContext(ctxt context.Context) log.Fields

+ func (c Component) NewLogTagsForContext() log.Fields

+ type ErrorDetail struct

+ Code int

+ Detail string

+ Msg string

+ type IntervalTimer interface

+ Start func(interval time.Duration, handler TimeoutHandler, oneShort bool) error

+ Stop func() error

+ func GetIntervalTimerInstance(rootCtxt context.Context, wg *sync.WaitGroup, logTags log.Fields) (IntervalTimer, error)

+ type LogMetadataModifier func(context.Context, log.Fields)

+ type RestAPIBaseResponse struct

+ Error *ErrorDetail

+ RequestID string

+ Success bool

+ type RestAPIHandler struct

+ CallRequestIDHeaderField *string

+ DoNotLogHeaders map[string]bool

+ func (h RestAPIHandler) GetStdRESTErrorMsg(ctxt context.Context, respCode int, errMsg string, errDetail string) RestAPIBaseResponse

+ func (h RestAPIHandler) GetStdRESTSuccessMsg(ctxt context.Context) RestAPIBaseResponse

+ func (h RestAPIHandler) LoggingMiddleware(next http.HandlerFunc) http.HandlerFunc

+ func (h RestAPIHandler) WriteRESTResponse(w http.ResponseWriter, respCode int, resp interface{}, ...) error

+ type RestRequestParam struct

+ Host string

+ ID string

+ Method string

+ Proto string

+ ProtoMajor int

+ ProtoMinor int

+ Referer string

+ RemoteAddr string

+ RequestHeaders http.Header

+ Timestamp time.Time

+ URI string

+ type RestRequestParamKey struct

+ type Sequencer interface

+ NextValue func() float64

+ func GetExponentialSeq(initial float64, growthRate float64) (Sequencer, error)

+ type TaskProcessor interface

+ AddToTaskExecutionMap func(parameterType reflect.Type, handler TaskProcessorSupportHandler) error

+ SetTaskExecutionMap func(newMap map[reflect.Type]TaskProcessorSupportHandler) error

+ StartEventLoop func(wg *sync.WaitGroup) error

+ StopEventLoop func() error

+ Submit func(ctx context.Context, newTaskParam interface{}) error

+ func GetNewTaskDemuxProcessorInstance(ctxt context.Context, instanceName string, taskBufferLen int, workerNum int, ...) (TaskProcessor, error)

+ func GetNewTaskProcessorInstance(ctxt context.Context, instanceName string, taskBufferLen int, ...) (TaskProcessor, error)

+ type TaskProcessorSupportHandler func(taskParam interface{}) error

+ type TimeoutHandler func() error