Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add livedebugging support for prometheus.remote_write #2308

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add livedebugging support for prometheus.remote_write #2308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Main (unreleased)

- Live Debugging button should appear in UI only for supported components (@ravishankar15)
- Add three new stdlib functions to_base64, from_URLbase64 and to_URLbase64 (@ravishankar15)
- Add livedebugging support for `prometheus.remote_write` (@ravishankar15)
- Add `ignore_older_than` option for local.file_match (@ravishankar15)
- Add livedebugging support for `discover.relabel` (@ravishankar15)

Expand Down
1 change: 1 addition & 0 deletions docs/sources/troubleshoot/debug.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,7 @@ Supported components:
* `loki.secretfilter`
* `otelcol.processor.*`
* `otelcol.receiver.*`
* `prometheus.remote_write`
* `prometheus.relabel`
{{< /admonition >}}
* `discovery.relabel`
Expand Down
43 changes: 38 additions & 5 deletions internal/component/prometheus/remotewrite/remote_write.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ import (
"github.com/grafana/alloy/internal/featuregate"
"github.com/grafana/alloy/internal/runtime/logging/level"
"github.com/grafana/alloy/internal/service/labelstore"
"github.com/grafana/alloy/internal/service/livedebugging"
"github.com/grafana/alloy/internal/static/metrics/wal"
"github.com/grafana/alloy/internal/useragent"
"github.com/prometheus/prometheus/model/exemplar"
Expand Down Expand Up @@ -62,6 +63,8 @@ type Component struct {
cfg Arguments

receiver *prometheus.Interceptor

debugDataPublisher livedebugging.DebugDataPublisher
}

// New creates a new prometheus.remote_write component.
Expand Down Expand Up @@ -92,13 +95,20 @@ func New(o component.Options, c Arguments) (*Component, error) {
}
ls := service.(labelstore.LabelStore)

debugDataPublisher, err := o.GetServiceData(livedebugging.ServiceName)
if err != nil {
return nil, err
}

res := &Component{
log: o.Logger,
opts: o,
walStore: walStorage,
remoteStore: remoteStore,
storage: storage.NewFanout(o.Logger, walStorage, remoteStore),
log: o.Logger,
opts: o,
walStore: walStorage,
remoteStore: remoteStore,
storage: storage.NewFanout(o.Logger, walStorage, remoteStore),
debugDataPublisher: debugDataPublisher.(livedebugging.DebugDataPublisher),
}
componenentID := livedebugging.ComponentID(res.opts.ID)
res.receiver = prometheus.NewInterceptor(
res.storage,
ls,
Expand All @@ -119,6 +129,9 @@ func New(o component.Options, c Arguments) (*Component, error) {
if localID == 0 {
ls.GetOrAddLink(res.opts.ID, uint64(newRef), l)
}
if res.debugDataPublisher.IsActive(componenentID) {
res.debugDataPublisher.Publish(componenentID, fmt.Sprintf("ts=%d, labels=%s, value=%f", t, l, v))
}
return globalRef, nextErr
}),
prometheus.WithHistogramHook(func(globalRef storage.SeriesRef, l labels.Labels, t int64, h *histogram.Histogram, fh *histogram.FloatHistogram, next storage.Appender) (storage.SeriesRef, error) {
Expand All @@ -131,6 +144,17 @@ func New(o component.Options, c Arguments) (*Component, error) {
if localID == 0 {
ls.GetOrAddLink(res.opts.ID, uint64(newRef), l)
}
if res.debugDataPublisher.IsActive(componenentID) {
var data string
if h != nil {
data = fmt.Sprintf("ts=%d, labels=%s, histogram=%s", t, l, h.String())
} else if fh != nil {
data = fmt.Sprintf("ts=%d, labels=%s, float_histogram=%s", t, l, fh.String())
} else {
data = fmt.Sprintf("ts=%d, labels=%s, no_value", t, l)
}
res.debugDataPublisher.Publish(componenentID, data)
}
return globalRef, nextErr
}),
prometheus.WithMetadataHook(func(globalRef storage.SeriesRef, l labels.Labels, m metadata.Metadata, next storage.Appender) (storage.SeriesRef, error) {
Expand All @@ -143,6 +167,9 @@ func New(o component.Options, c Arguments) (*Component, error) {
if localID == 0 {
ls.GetOrAddLink(res.opts.ID, uint64(newRef), l)
}
if res.debugDataPublisher.IsActive(componenentID) {
res.debugDataPublisher.Publish(componenentID, fmt.Sprintf("labels=%s, type=%s, unit=%s, help=%s", l, m.Type, m.Unit, m.Help))
}
return globalRef, nextErr
}),
prometheus.WithExemplarHook(func(globalRef storage.SeriesRef, l labels.Labels, e exemplar.Exemplar, next storage.Appender) (storage.SeriesRef, error) {
Expand All @@ -155,6 +182,9 @@ func New(o component.Options, c Arguments) (*Component, error) {
if localID == 0 {
ls.GetOrAddLink(res.opts.ID, uint64(newRef), l)
}
if res.debugDataPublisher.IsActive(componenentID) {
res.debugDataPublisher.Publish(componenentID, fmt.Sprintf("ts=%d, labels=%s, exemplar_labels=%s, value=%f", e.Ts, l, e.Labels, e.Value))
}
return globalRef, nextErr
}),
)
Expand All @@ -172,6 +202,7 @@ func New(o component.Options, c Arguments) (*Component, error) {
func startTime() (int64, error) { return 0, nil }

var _ component.Component = (*Component)(nil)
var _ component.LiveDebugging = (*Component)(nil)

// Run implements Component.
func (c *Component) Run(ctx context.Context) error {
Expand Down Expand Up @@ -275,3 +306,5 @@ func (c *Component) Update(newConfig component.Arguments) error {
c.cfg = cfg
return nil
}

func (c *Component) LiveDebugging(_ int) {}
Loading