package
module
Version:
v0.1.0
Opens a new window with list of versions in this module.
Published: Apr 20, 2015
License: BSD-3-Clause
Opens a new window with license information.
Imports: 14
Opens a new window with list of imports.
Imported by: 0
Opens a new window with list of known importers.
README
¶
catena
n. A closely linked series.
Catena is a storage engine for time series data.
Documentation
Extensive documentation is not available yet, but there are a few resources you can use to learn more:
- Original blog post introduction Catena: http://misfra.me/state-of-the-state-part-iii
- Time series storage slide deck: https://speakerdeck.com/preetamjinka/time-series-storage
Disclaimer
Catena is just a prototype at the moment. It's not ready for you to use.
License
BSD (see LICENSE)
Documentation
¶
Package catena provides a time series storage engine.
DB is a handle to a catena database.
NewDB creates a new DB located in baseDir. If baseDir
does not exist it will be created. An error is returned
if baseDir is not empty.
OpenDB opens a DB located in baseDir.
Close closes the DB and releases any internal state.
Close will block if there are active iterators.
InsertRows inserts the given rows into the database.
Metrics returns a slice of metrics that are present within the
given time range for the given source.
NewIterator creates a new Iterator for the given source and metric.
Sources returns a slice of sources that are present within the
given time range.
An Iterator is a cursor over an array of points
for a source and metric.
Close closes the iterator. Iterators MUST be closed to unblock
the compactor!
Next advances i to the next available point.
Reset moves i to the first available timestamp.
Seek moves the iterator to the first timestamp greater than
or equal to timestamp.
type Point struct {
Timestamp int64 `json:"timestamp"`
Value float64 `json:"value"`
}
A Point is a single observation of a time series metric. It
has a timestamp and a value.
type Row struct {
Source string `json:"source"`
Metric string `json:"metric"`
Point
}
A Row is a Point with Source and Metric fields.
Source Files
¶
Directories
¶
|
|
|
|
|
|
Package wal provides a write-ahead log.
|
Package wal provides a write-ahead log. |
Click to show internal directories.
Click to hide internal directories.