Retracted: These v1 versions were published incorrectly. Retracting to prevent go mod
from automatically selecting them.
README
¶
go
| branch | travis-ci | coveralls | docs | report card |
|---|---|---|---|---|
| master |  |
 |
 |
General purpose libraries / APIs for use in mlab code.
General guidance
Packages in this repo should be:
- Useful across multiple other packages
- Non-trivial, either in lines of code or in semantic complexity. Small simple things should likely just be defined where they are used.
- Fairly carefully designed. Probably should review design with other engineers before putting in too much effort.
- Well tested and well documented. Test and documentation standards should be even higher than for most code repositories.
Note that packages here are intended to be used in other repositories. This means that it will be somewhat disruptive to change APIs in these packages, as API changing PRs will break other repos, and require additional PRs to fix those repositories.
package tags
Please mark packages in development as alpha or beta. Use of these packages should be discouraged in other repositories, until they are stable.
Once a packages API has stabilized, mark the package as stable.
You can still add new APIs to stable packages, but mark these new APIs as alpha or beta until they are regarded as stable and suitable for general use.
packages
bqext
Utilities for interacting with BigQuery
bytecount
Allows commandline flags to express quantities of Bytes like --size=20MB by
creating a new type bytecount that can be used as a flag.Value. stable
cloudtest
Utilities for testing google cloud service abstractions.
flagx
Extensions for the flag package. stable
httpx
Extensions of the http package. stable
iox
Extensions of the io package.
memoryless
Tools to run a function as a memoryless poisson process. Helps prevent spurious patterns. stable
osx
Extensions of the os package. stable
prometheusx
Helpful utilities for working with Prometheus. alpha
rtx
Extensions of the runtime package. stable
TODO: decide whether to rename this to runtimex.
siteinfo
Client to fetch siteinfo's output formats. alpha
storagex
Extensions of the cloud.google.com/go/storage package. alpha
Directories
¶
| Path | Synopsis |
|---|---|
|
Package bqext includes generally useful abstractions for simplifying interactions with bigquery.
|
Package bqext includes generally useful abstractions for simplifying interactions with bigquery. |
|
Package bqx provides utilities and extensions for working with bigquery.
|
Package bqx provides utilities and extensions for working with bigquery. |
|
Package bytecount provides a single datatype ByteCount, designed to track counts of bytes, as well as some helper constants.
|
Package bytecount provides a single datatype ByteCount, designed to track counts of bytes, as well as some helper constants. |
|
cloud
|
|
|
bqfake
Package bqfake provides tools to construct fake bigquery datasets, tables, query responses, etc.
|
Package bqfake provides tools to construct fake bigquery datasets, tables, query responses, etc. |
|
bqx
Package bqx includes generally useful abstractions for simplifying interactions with bigquery.
|
Package bqx includes generally useful abstractions for simplifying interactions with bigquery. |
|
Package cloudtest provides utilities for testing, e.g.
|
Package cloudtest provides utilities for testing, e.g. |
|
bqfake
Package bqfake provides tools to construct fake bigquery datasets, tables, query responses, etc.
|
Package bqfake provides tools to construct fake bigquery datasets, tables, query responses, etc. |
|
dsfake
Package dsfake implements a fake dsiface.Client If you make changes to existing code, please test whether it breaks existing clients, e.g.
|
Package dsfake implements a fake dsiface.Client If you make changes to existing code, please test whether it breaks existing clients, e.g. |
|
Package x_dataset extends bqiface.Dataset with useful abstractions for simplifying interactions with bigquery.
|
Package x_dataset extends bqiface.Dataset with useful abstractions for simplifying interactions with bigquery. |
|
Package flagx extends to capabilities of flags to also be able to read from environment variables.
|
Package flagx extends to capabilities of flags to also be able to read from environment variables. |
|
Package host parses v1 and v2 hostnames into their constituent parts.
|
Package host parses v1 and v2 hostnames into their constituent parts. |
|
Package httpx provides generic functions which extend the capabilities of the http package.
|
Package httpx provides generic functions which extend the capabilities of the http package. |
|
Package logx provides very useful utilities for logging.
|
Package logx provides very useful utilities for logging. |
|
Package memoryless helps repeated calls to a function be distributed across time in a memoryless fashion.
|
Package memoryless helps repeated calls to a function be distributed across time in a memoryless fashion. |
|
Package osx provides functionx which are extensions of the functionality provided in os.
|
Package osx provides functionx which are extensions of the functionality provided in os. |
|
Package prometheusx provides a canonical way to expose Prometheus metrics.
|
Package prometheusx provides a canonical way to expose Prometheus metrics. |
|
promtest
Package promtest provides a utility function for linting Prometheus metrics.
|
Package promtest provides a utility function for linting Prometheus metrics. |
|
Package rtx provides free functions that would be handy to have as part of the go standard runtime.
|
Package rtx provides free functions that would be handy to have as part of the go standard runtime. |
|
Package storagex extends cloud.google.com/go/storage.
|
Package storagex extends cloud.google.com/go/storage. |
|
Package uniformnames allows experiments and utilities to check whether names conform to the requirements for experiment and datatype names in M-Lab.
|
Package uniformnames allows experiments and utilities to check whether names conform to the requirements for experiment and datatype names in M-Lab. |
|
Package warnonerror contains custom versions of common functions/methods that always log a warning in case of error.
|
Package warnonerror contains custom versions of common functions/methods that always log a warning in case of error. |