README
¶
pkg/ is a collection of utility packages used by the InfluxDB project without being specific to its internals.
Utility packages are kept separate from the InfluxDB core codebase to keep it as small and concise as possible. If some utilities grow larger and their APIs stabilize, they may be moved to their own repository under the InfluxDB organization, to facilitate re-use by other projects. However that is not the priority.
Because utility packages are small and neatly separated from the rest of the codebase, they are a good place to start for aspiring maintainers and contributors. Get in touch if you want to help maintain them!
Directories
¶
| Path | Synopsis |
|---|---|
|
Package deep provides a deep equality check for use in tests.
|
Package deep provides a deep equality check for use in tests. |
|
encoding
|
|
|
simple8b
Package simple8b implements the 64bit integer encoding algoritm as published by Ann and Moffat in "Index compression using 64-bit words", Softw.
|
Package simple8b implements the 64bit integer encoding algoritm as published by Ann and Moffat in "Index compression using 64-bit words", Softw. |
|
Package escape contains utilities for escaping parts of InfluxQL and InfluxDB line protocol.
|
Package escape contains utilities for escaping parts of InfluxQL and InfluxDB line protocol. |
|
hll
Package hll contains a HyperLogLog++ with a LogLog-Beta bias correction implementation that is adapted (mostly copied) from an implementation provided by Clark DuVall github.com/clarkduvall/hyperloglog.
|
Package hll contains a HyperLogLog++ with a LogLog-Beta bias correction implementation that is adapted (mostly copied) from an implementation provided by Clark DuVall github.com/clarkduvall/hyperloglog. |
|
Package limiter provides concurrency limiters.
|
Package limiter provides concurrency limiters. |
|
Package metrics provides various measurements that are safe for concurrent access.
|
Package metrics provides various measurements that are safe for concurrent access. |
|
Package mmap provides a way to memory-map a file.
|
Package mmap provides a way to memory-map a file. |
|
Package pool provides pool structures to help reduce garbage collector pressure.
|
Package pool provides pool structures to help reduce garbage collector pressure. |
|
Package slices contains functions to operate on slices treated as sets.
|
Package slices contains functions to operate on slices treated as sets. |
|
testing
|
|
|
assert
Package assert provides helper functions that can be used with the standard Go testing package.
|
Package assert provides helper functions that can be used with the standard Go testing package. |
|
Package tracing provides a way for capturing hierarchical traces.
|
Package tracing provides a way for capturing hierarchical traces. |
|
wire
Package wire is used to serialize a trace.
|
Package wire is used to serialize a trace. |
Click to show internal directories.
Click to hide internal directories.