README
¶
webpa-common
Environment Setup Instructions
Assumptions:
- Go with version >= 1.10 https://golang.org/dl/
- Latest version of Glide https://github.com/Masterminds/glide
1) Set up a new workspace (Optional, skip to step 2 if you want to edit webpa-common in your existing workspace)
newWorkSpace=~/xmidt #this can be any path you want
export GOPATH=$newWorkSpace
2) Create necessary path
mkdir -p $GOPATH/github.com/xmidt-org
3) Clone repo
cd $GOPATH/github.com/xmidt-org
git clone git@github.com:Comcast/webpa-common.git
4) Get Dependencies
cd webpa-common
glide install --strip-vendor
5) Try running the tests!
./test.sh
Directories
¶
| Path | Synopsis |
|---|---|
|
Package capacitor provides a configurable delay for a series of function calls.
|
Package capacitor provides a configurable delay for a series of function calls. |
|
Package clock implements a standard clock interface that can be used in place of the time package.
|
Package clock implements a standard clock interface that can be used in place of the time package. |
|
clocktest
Package clocktest provides a testable clock implementation
|
Package clocktest provides a testable clock implementation |
|
Package concurrent provides common functionality for dealing with concurrency that extends or enhances the core golang packages.
|
Package concurrent provides common functionality for dealing with concurrency that extends or enhances the core golang packages. |
|
Package conlimiter provides a simple connection limiter for incoming TCP connections Package conlimiter provides a simple connection limiter for incoming TCP connections.
|
Package conlimiter provides a simple connection limiter for incoming TCP connections Package conlimiter provides a simple connection limiter for incoming TCP connections. |
|
Package hash provides a simple API for managing service hashes.
|
Package hash provides a simple API for managing service hashes. |
|
Package httppool provides a simple, configurable worker pool for dispatching HTTP transactions to servers.
|
Package httppool provides a simple, configurable worker pool for dispatching HTTP transactions to servers. |
|
health
Package health has integrations with webpa-common/health for monitoring httppool Dispatchers.
|
Package health has integrations with webpa-common/health for monitoring httppool Dispatchers. |
|
Package logging provides basic configurability for the go-kit/log packages.
|
Package logging provides basic configurability for the go-kit/log packages. |
|
Package middleware provides common middleware and decorators for WebPA and XMiDT servers
|
Package middleware provides common middleware and decorators for WebPA and XMiDT servers |
|
Package resource provides common resource-handling functionality.
|
Package resource provides common resource-handling functionality. |
|
Package secure contains the security types common to WebPA applications
|
Package secure contains the security types common to WebPA applications |
|
key
Package key provides a simple API for loading public and private keys from resources.
|
Package key provides a simple API for loading public and private keys from resources. |
|
Package semaphore provides a simple channel-based semaphore that optionally honors context semantics.
|
Package semaphore provides a simple channel-based semaphore that optionally honors context semantics. |
|
Package server provides the standard approach to executing servers for WebPA
|
Package server provides the standard approach to executing servers for WebPA |
|
Package service provides basic integration with go.serversets
|
Package service provides basic integration with go.serversets |
|
Package store implements some additional atomic value storage on top of sync/atomic.
|
Package store implements some additional atomic value storage on top of sync/atomic. |
|
Package tracing provides very basic distributed tracing.
|
Package tracing provides very basic distributed tracing. |
|
tracinghttp
Package tracinghttp provides marshaling support for tracing data into HTTP requests and responses
|
Package tracinghttp provides marshaling support for tracing data into HTTP requests and responses |
|
transport
|
|
|
Package types contains useful custom types that are common across the WebPA application.
|
Package types contains useful custom types that are common across the WebPA application. |
|
Package xhttp provides extended functionality for net/http and go-kit's transport/http packages
|
Package xhttp provides extended functionality for net/http and go-kit's transport/http packages |
|
Package xmetrics provides configurability for Prometheus-based metrics.
|
Package xmetrics provides configurability for Prometheus-based metrics. |
Click to show internal directories.
Click to hide internal directories.