From 0919468a64e27b0965b847411f64cd00c0aa0880 Mon Sep 17 00:00:00 2001 From: Ben Wells Date: Mon, 5 Oct 2020 08:51:41 +0100 Subject: [PATCH] Clarify 'implements ChunkStore' doc comments (#3270) Signed-off-by: Ben Wells --- chunk_store.go | 5 +++-- series_store.go | 4 ++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/chunk_store.go b/chunk_store.go index 8746a21dcfa8..2352938a8007 100644 --- a/chunk_store.go +++ b/chunk_store.go @@ -77,6 +77,7 @@ func (cfg *StoreConfig) RegisterFlags(f *flag.FlagSet) { f.Var(&cfg.MaxLookBackPeriod, "store.max-look-back-period", "Limit how long back data can be queried") } +// Validate validates the store config. func (cfg *StoreConfig) Validate() error { if err := cfg.ChunkCacheConfig.Validate(); err != nil { return err @@ -138,7 +139,7 @@ func newStore(cfg StoreConfig, schema StoreSchema, index IndexClient, chunks Cli }, nil } -// Put implements ChunkStore +// Put implements Store func (c *store) Put(ctx context.Context, chunks []Chunk) error { for _, chunk := range chunks { if err := c.PutOne(ctx, chunk.From, chunk.Through, chunk); err != nil { @@ -148,7 +149,7 @@ func (c *store) Put(ctx context.Context, chunks []Chunk) error { return nil } -// PutOne implements ChunkStore +// PutOne implements Store func (c *store) PutOne(ctx context.Context, from, through model.Time, chunk Chunk) error { log, ctx := spanlogger.New(ctx, "ChunkStore.PutOne") defer log.Finish() diff --git a/series_store.go b/series_store.go index 18ceab0915ce..9fb5b94128b4 100644 --- a/series_store.go +++ b/series_store.go @@ -408,7 +408,7 @@ func (c *seriesStore) lookupLabelNamesBySeries(ctx context.Context, from, throug return result.Strings(), nil } -// Put implements ChunkStore +// Put implements Store func (c *seriesStore) Put(ctx context.Context, chunks []Chunk) error { for _, chunk := range chunks { if err := c.PutOne(ctx, chunk.From, chunk.Through, chunk); err != nil { @@ -418,7 +418,7 @@ func (c *seriesStore) Put(ctx context.Context, chunks []Chunk) error { return nil } -// PutOne implements ChunkStore +// PutOne implements Store func (c *seriesStore) PutOne(ctx context.Context, from, through model.Time, chunk Chunk) error { log, ctx := spanlogger.New(ctx, "SeriesStore.PutOne") defer log.Finish()