Categorygithub.com/m3db/m3x
modulepackage
0.0.0-20190408051622-ebf3c7b94afd
Repository: https://github.com/m3db/m3x.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
0
Dependents
0
Files
0

# README

Migration Warning

This repository has been migrated to github.com/m3db/m3. It's contents can be found at github.com/m3db/m3/src/x. Follow along there for updates. This repository is marked archived, and will no longer receive any updates.

M3X GoDoc Build Status Coverage Status

Common utility code shared by all M3DB components.

This project is released under the Apache License, Version 2.0.

Development

Setup

  1. Clone the repo into your $GOPATH
  2. Run git submodule update --init --recursive
  3. Run glide install -v - Install Glide first if you don't have it
  4. Run make test and make sure everything passes
  5. Write new code and tests

# Packages

Package checked implements reference counted resources.
Package clock implements facilities for working with wall clock time.
Package close provides utilities for closing resources.
Package config provides utilities for loading configuration files.
No description provided by the author
Package debug provides utilities for debugging.
Package errors provides utilities for working with different types errors.
No description provided by the author
No description provided by the author
Package hash provides implementation of hash functions.
Package ident provides utilities for working with identifiers.
Package instrument implements functions to make instrumenting code, including metrics and logging, easier.
Package log implements a logging package.
Package net implements functions for running network servers.
No description provided by the author
Package pool provides implementations for object pooling.
Package pprof provides a function for registering a HTTP handler for pprof endpoints.
Package process provides functions for inspecting processes.
Package resource describes require for object lifecycle management.
Package retry provides utilities for retrying functions.
No description provided by the author
Package server implements a network server.
Package sync implements synchronization facililites such as worker pools.
Package tcp implements a tcp listener.
Package test contains utility methods for testing.
Package time implement facilities for working with time.
Package unsafe contains operations that step around the type safety of Go programs.
Package watch provides utilities for watching resources for changes.