README
¶
webpa-common
Table of Contents
Code of Conduct
This project and everyone participating in it are governed by the XMiDT Code Of Conduct. By participating, you agree to this Code.
Environment Requirements
- Go with version >= 1.12 https://golang.org/dl/
Testing the Library
To run the tests, git clone the repository, then from within the repo directory run:
go test ./... -race -coverprofile=coverage.txt
Contributing
Refer to CONTRIBUTING.md.
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 hash provides a simple API for managing service hashes.
|
Package hash provides a simple API for managing service hashes. |
|
Package health provides a simple heartbeat strategy for WebPA/XMiDT services.
|
Package health provides a simple heartbeat strategy for WebPA/XMiDT services. |
|
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 Deprecated: secure is no longer planned to be used by future WebPA/XMiDT services.
|
Package secure contains the security types common to WebPA applications Deprecated: secure is no longer planned to be used by future WebPA/XMiDT services. |
|
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 Deprecated: server is no longer planned to be used by future WebPA/XMiDT services.
|
Package server provides the standard approach to executing servers for WebPA Deprecated: server is no longer planned to be used by future WebPA/XMiDT services. |
|
Package service provides basic integration with go.serversets Deprecated: service is no longer planned to be used by future WebPA/XMiDT services.
|
Package service provides basic integration with go.serversets Deprecated: service is no longer planned to be used by future WebPA/XMiDT services. |
|
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 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. |
|
Package xviper provides customizations on use of viper for configuration loading.
|
Package xviper provides customizations on use of viper for configuration loading. |
Click to show internal directories.
Click to hide internal directories.