mirror of
https://github.com/prometheus/prometheus.git
synced 2024-12-24 05:04:05 -08:00
a0f08a8365
* Approach bundling metadata along with samples and exemplars Signed-off-by: Paschalis Tsilias <paschalist0@gmail.com> * Add first test; rebase with main Signed-off-by: Paschalis Tsilias <paschalist0@gmail.com> * Alternative approach: bundle metadata in TimeSeries protobuf Signed-off-by: Paschalis Tsilias <paschalist0@gmail.com> * update go mod to match main branch Signed-off-by: Callum Styan <callumstyan@gmail.com> * fix after rebase Signed-off-by: Callum Styan <callumstyan@gmail.com> * we're not going to modify the 1.X format anymore Signed-off-by: Callum Styan <callumstyan@gmail.com> * Modify AppendMetadata based on the fact that we be putting metadata into timeseries Signed-off-by: Callum Styan <callumstyan@gmail.com> * Rename enums for remote write versions to something that makes more sense + remove the added `sendMetadata` flag. Signed-off-by: Callum Styan <callumstyan@gmail.com> * rename flag that enables writing of metadata records to the WAL Signed-off-by: Callum Styan <callumstyan@gmail.com> * additional clean up Signed-off-by: Callum Styan <callumstyan@gmail.com> * lint Signed-off-by: Callum Styan <callumstyan@gmail.com> * fix usage of require.Len Signed-off-by: Callum Styan <callumstyan@gmail.com> * some clean up from review comments Signed-off-by: Callum Styan <callumstyan@gmail.com> * more review fixes Signed-off-by: Callum Styan <callumstyan@gmail.com> --------- Signed-off-by: Paschalis Tsilias <paschalist0@gmail.com> Signed-off-by: Callum Styan <callumstyan@gmail.com> Co-authored-by: Paschalis Tsilias <paschalist0@gmail.com>
165 lines
4.1 KiB
Go
165 lines
4.1 KiB
Go
// Copyright 2020 The Prometheus Authors
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package remote
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"time"
|
|
|
|
"github.com/go-kit/log"
|
|
"github.com/go-kit/log/level"
|
|
"github.com/prometheus/common/model"
|
|
|
|
"github.com/prometheus/prometheus/scrape"
|
|
)
|
|
|
|
// MetadataAppender is an interface used by the Metadata Watcher to send metadata, It is read from the scrape manager, on to somewhere else.
|
|
type MetadataAppender interface {
|
|
AppendWatcherMetadata(context.Context, []scrape.MetricMetadata)
|
|
}
|
|
|
|
// Watchable represents from where we fetch active targets for metadata.
|
|
type Watchable interface {
|
|
TargetsActive() map[string][]*scrape.Target
|
|
}
|
|
|
|
type noopScrapeManager struct{}
|
|
|
|
func (noop *noopScrapeManager) Get() (*scrape.Manager, error) {
|
|
return nil, errors.New("Scrape manager not ready")
|
|
}
|
|
|
|
// MetadataWatcher watches the Scrape Manager for a given WriteMetadataTo.
|
|
type MetadataWatcher struct {
|
|
name string
|
|
logger log.Logger
|
|
|
|
managerGetter ReadyScrapeManager
|
|
manager Watchable
|
|
writer MetadataAppender
|
|
|
|
interval model.Duration
|
|
deadline time.Duration
|
|
|
|
done chan struct{}
|
|
|
|
softShutdownCtx context.Context
|
|
softShutdownCancel context.CancelFunc
|
|
hardShutdownCancel context.CancelFunc
|
|
hardShutdownCtx context.Context
|
|
}
|
|
|
|
// NewMetadataWatcher builds a new MetadataWatcher.
|
|
func NewMetadataWatcher(l log.Logger, mg ReadyScrapeManager, name string, w MetadataAppender, interval model.Duration, deadline time.Duration) *MetadataWatcher {
|
|
if l == nil {
|
|
l = log.NewNopLogger()
|
|
}
|
|
|
|
if mg == nil {
|
|
mg = &noopScrapeManager{}
|
|
}
|
|
|
|
return &MetadataWatcher{
|
|
name: name,
|
|
logger: l,
|
|
|
|
managerGetter: mg,
|
|
writer: w,
|
|
|
|
interval: interval,
|
|
deadline: deadline,
|
|
|
|
done: make(chan struct{}),
|
|
}
|
|
}
|
|
|
|
// Start the MetadataWatcher.
|
|
func (mw *MetadataWatcher) Start() {
|
|
level.Info(mw.logger).Log("msg", "Starting scraped metadata watcher")
|
|
mw.hardShutdownCtx, mw.hardShutdownCancel = context.WithCancel(context.Background())
|
|
mw.softShutdownCtx, mw.softShutdownCancel = context.WithCancel(mw.hardShutdownCtx)
|
|
go mw.loop()
|
|
}
|
|
|
|
// Stop the MetadataWatcher.
|
|
func (mw *MetadataWatcher) Stop() {
|
|
level.Info(mw.logger).Log("msg", "Stopping metadata watcher...")
|
|
defer level.Info(mw.logger).Log("msg", "Scraped metadata watcher stopped")
|
|
|
|
mw.softShutdownCancel()
|
|
select {
|
|
case <-mw.done:
|
|
return
|
|
case <-time.After(mw.deadline):
|
|
level.Error(mw.logger).Log("msg", "Failed to flush metadata")
|
|
}
|
|
|
|
mw.hardShutdownCancel()
|
|
<-mw.done
|
|
}
|
|
|
|
func (mw *MetadataWatcher) loop() {
|
|
ticker := time.NewTicker(time.Duration(mw.interval))
|
|
defer ticker.Stop()
|
|
defer close(mw.done)
|
|
|
|
for {
|
|
select {
|
|
case <-mw.softShutdownCtx.Done():
|
|
return
|
|
case <-ticker.C:
|
|
mw.collect()
|
|
}
|
|
}
|
|
}
|
|
|
|
func (mw *MetadataWatcher) collect() {
|
|
if !mw.ready() {
|
|
return
|
|
}
|
|
|
|
// We create a set of the metadata to help deduplicating based on the attributes of a
|
|
// scrape.MetricMetadata. In this case, a combination of metric name, help, type, and unit.
|
|
metadataSet := map[scrape.MetricMetadata]struct{}{}
|
|
metadata := []scrape.MetricMetadata{}
|
|
for _, tset := range mw.manager.TargetsActive() {
|
|
for _, target := range tset {
|
|
for _, entry := range target.ListMetadata() {
|
|
if _, ok := metadataSet[entry]; !ok {
|
|
metadata = append(metadata, entry)
|
|
metadataSet[entry] = struct{}{}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Blocks until the metadata is sent to the remote write endpoint or hardShutdownContext is expired.
|
|
mw.writer.AppendWatcherMetadata(mw.hardShutdownCtx, metadata)
|
|
}
|
|
|
|
func (mw *MetadataWatcher) ready() bool {
|
|
if mw.manager != nil {
|
|
return true
|
|
}
|
|
|
|
m, err := mw.managerGetter.Get()
|
|
if err != nil {
|
|
return false
|
|
}
|
|
|
|
mw.manager = m
|
|
return true
|
|
}
|