m3x

package module
v0.0.0-...-ebf3c7b Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 8, 2019 License: Apache-2.0 Imports: 0 Imported by: 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

Documentation

Overview

Package m3x implements common utility functions and experimental components.

Directories

Path Synopsis
Package checked is a generated GoMock package.
Package checked is a generated GoMock package.
Package clock implements facilities for working with wall clock time.
Package clock implements facilities for working with wall clock time.
Package close provides utilities for closing resources.
Package close provides utilities for closing resources.
Package config provides utilities for loading configuration files.
Package config provides utilities for loading configuration files.
hostid
Package hostid provides a configuration struct for resolving a host ID from YAML.
Package hostid provides a configuration struct for resolving a host ID from YAML.
listenaddress
Package listenaddress provides a configuration struct for resolving a listen address from YAML.
Package listenaddress provides a configuration struct for resolving a listen address from YAML.
Package debug provides utilities for debugging.
Package debug provides utilities for debugging.
Package errors provides utilities for working with different types errors.
Package errors provides utilities for working with different types errors.
generated
generics
Package hash provides implementation of hash functions.
Package hash provides implementation of hash functions.
jump
Package jump implements the jump consistent hash algorithm as described in "A Fast, Minimal Memory, Consistent Hash Algorithm"[1].
Package jump implements the jump consistent hash algorithm as described in "A Fast, Minimal Memory, Consistent Hash Algorithm"[1].
Package ident is a generated GoMock package.
Package ident is a generated GoMock package.
Package instrument implements functions to make instrumenting code, including metrics and logging, easier.
Package instrument implements functions to make instrumenting code, including metrics and logging, easier.
Package log implements a logging package.
Package log implements a logging package.
Package net implements functions for running network servers.
Package net implements functions for running network servers.
Package pool is a generated GoMock package.
Package pool is a generated GoMock package.
Package pprof provides a function for registering a HTTP handler for pprof endpoints.
Package pprof provides a function for registering a HTTP handler for pprof endpoints.
Package process provides functions for inspecting processes.
Package process provides functions for inspecting processes.
Package resource describes require for object lifecycle management.
Package resource describes require for object lifecycle management.
Package retry provides utilities for retrying functions.
Package retry provides utilities for retrying functions.
Package server implements a network server.
Package server implements a network server.
Package sync implements synchronization facililites such as worker pools.
Package sync implements synchronization facililites such as worker pools.
Package tcp implements a tcp listener.
Package tcp implements a tcp listener.
Package test contains utility methods for testing.
Package test contains utility methods for testing.
Package time implement facilities for working with time.
Package time implement facilities for working with time.
Package unsafe contains operations that step around the type safety of Go programs.
Package unsafe contains operations that step around the type safety of Go programs.
Package watch provides utilities for watching resources for changes.
Package watch provides utilities for watching resources for changes.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL