-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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.
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
[FEATURE] adding otlp endpoint #7996
base: main
Are you sure you want to change the base?
Changes from all commits
4415626
58e4bc2
6b464fa
8a80246
5f71e26
593aca7
fdd473a
18a48b6
13761e2
6431b67
b163dab
543a28f
5aa4063
f9841ba
991c8e5
0dc5845
65dc21b
ab46f3b
8be010c
5b4600b
706e41e
b57f248
fc5e612
12dbf04
63ce67b
d2e6b60
a2bef89
493fe90
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -281,6 +281,8 @@ func runReceive( | |
|
||
AsyncForwardWorkerCount: conf.asyncForwardWorkerCount, | ||
ReplicationProtocol: receive.ReplicationProtocol(conf.replicationProtocol), | ||
OtlpDisableTargetInfo: conf.otlpDisableTargetInfo, | ||
OtlpResourceAttributes: conf.otlpResourceAttributes, | ||
}) | ||
|
||
grpcProbe := prober.NewGRPC() | ||
|
@@ -897,6 +899,8 @@ type receiveConfig struct { | |
|
||
headExpandedPostingsCacheSize uint64 | ||
compactedBlocksExpandedPostingsCacheSize uint64 | ||
otlpDisableTargetInfo bool | ||
otlpResourceAttributes []string | ||
} | ||
|
||
func (rc *receiveConfig) registerFlag(cmd extkingpin.FlagClause) { | ||
|
@@ -1052,6 +1056,9 @@ func (rc *receiveConfig) registerFlag(cmd extkingpin.FlagClause) { | |
cmd.Flag("receive.limits-config-reload-timer", "Minimum amount of time to pass for the limit configuration to be reloaded. Helps to avoid excessive reloads."). | ||
Default("1s").Hidden().DurationVar(&rc.limitsConfigReloadTimer) | ||
|
||
cmd.Flag("receive.otlp-disable-target-info", "Disable target information OTLP metrics ingested by Receive.").Default("false").BoolVar(&rc.otlpDisableTargetInfo) | ||
cmd.Flag("receive.otlp-resource-attributes", "(Repeatable) Resource attributes to include in OTLP metrics ingested by Receive.").Default("").StringsVar(&rc.otlpResourceAttributes) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. On second look, this might be a little confusing - this should indicate which resource attributes should be used as metric labels, correct? Maybe we could retain the original parameter name, something like |
||
|
||
rc.featureList = cmd.Flag("enable-feature", "Comma separated experimental feature names to enable. The current list of features is "+metricNamesFilter+".").Default("").Strings() | ||
} | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -116,6 +116,8 @@ type Options struct { | |
Limiter *Limiter | ||
AsyncForwardWorkerCount uint | ||
ReplicationProtocol ReplicationProtocol | ||
OtlpDisableTargetInfo bool | ||
OtlpResourceAttributes []string | ||
} | ||
|
||
// Handler serves a Prometheus remote write receiving HTTP endpoint. | ||
|
@@ -275,6 +277,18 @@ func NewHandler(logger log.Logger, o *Options) *Handler { | |
), | ||
) | ||
|
||
h.router.Post( | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @saswatamcode just FYI use this endpoint naming will require users to use the |
||
"/api/v1/otlp", | ||
instrf( | ||
"otlp", | ||
readyf( | ||
middleware.RequestID( | ||
http.HandlerFunc(h.receiveOTLPHTTP), | ||
), | ||
), | ||
), | ||
) | ||
|
||
statusAPI := statusapi.New(statusapi.Options{ | ||
GetStats: h.getStats, | ||
Registry: h.options.Registry, | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,178 @@ | ||
// Copyright (c) The Thanos Authors. | ||
// Licensed under the Apache License 2.0. | ||
|
||
package receive | ||
|
||
import ( | ||
"context" | ||
"net/http" | ||
"strconv" | ||
|
||
"github.com/go-kit/log" | ||
"github.com/go-kit/log/level" | ||
"github.com/pkg/errors" | ||
"github.com/prometheus/prometheus/storage/remote" | ||
"github.com/thanos-io/thanos/pkg/receive/otlptranslator" | ||
tprompb "github.com/thanos-io/thanos/pkg/store/storepb/prompb" | ||
"github.com/thanos-io/thanos/pkg/tenancy" | ||
"github.com/thanos-io/thanos/pkg/tracing" | ||
"go.opentelemetry.io/collector/pdata/pmetric" | ||
) | ||
|
||
func (h *Handler) receiveOTLPHTTP(w http.ResponseWriter, r *http.Request) { | ||
nicolastakashi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
var err error | ||
span, ctx := tracing.StartSpan(r.Context(), "receive_otlp_http") | ||
span.SetTag("receiver.mode", string(h.receiverMode)) | ||
defer span.Finish() | ||
|
||
tenant, err := tenancy.GetTenantFromHTTP(r, h.options.TenantHeader, h.options.DefaultTenantID, h.options.TenantField) | ||
matej-g marked this conversation as resolved.
Show resolved
Hide resolved
|
||
if err != nil { | ||
level.Error(h.logger).Log("msg", "error getting tenant from HTTP", "err", err) | ||
Check failure Code scanning / CodeQL Clear-text logging of sensitive information High Sensitive data returned by HTTP request headers Error loading related location Loading |
||
http.Error(w, err.Error(), http.StatusBadRequest) | ||
return | ||
} | ||
|
||
tLogger := log.With(h.logger, "tenant", tenant) | ||
span.SetTag("tenant", tenant) | ||
|
||
writeGate := h.Limiter.WriteGate() | ||
tracing.DoInSpan(r.Context(), "receive_write_gate_ismyturn", func(ctx context.Context) { | ||
err = writeGate.Start(r.Context()) | ||
}) | ||
|
||
defer writeGate.Done() | ||
if err != nil { | ||
level.Error(tLogger).Log("err", err, "msg", "internal server error") | ||
Check failure Code scanning / CodeQL Clear-text logging of sensitive information High Sensitive data returned by HTTP request headers Error loading related location Loading |
||
http.Error(w, err.Error(), http.StatusInternalServerError) | ||
return | ||
} | ||
|
||
under, err := h.Limiter.HeadSeriesLimiter().isUnderLimit(tenant) | ||
if err != nil { | ||
level.Error(tLogger).Log("msg", "error while limiting", "err", err.Error()) | ||
} | ||
|
||
// Fail request fully if tenant has exceeded set limit. | ||
if !under { | ||
http.Error(w, "tenant is above active series limit", http.StatusTooManyRequests) | ||
return | ||
} | ||
|
||
requestLimiter := h.Limiter.RequestLimiter() | ||
if r.ContentLength >= 0 { | ||
if !requestLimiter.AllowSizeBytes(tenant, r.ContentLength) { | ||
http.Error(w, "write request too large", http.StatusRequestEntityTooLarge) | ||
return | ||
} | ||
} | ||
|
||
req, err := remote.DecodeOTLPWriteRequest(r) | ||
nicolastakashi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
if err != nil { | ||
level.Error(h.logger).Log("msg", "Error decoding remote write request", "err", err.Error()) | ||
http.Error(w, err.Error(), http.StatusBadRequest) | ||
return | ||
} | ||
|
||
metrics, _, err := h.convertToPrometheusFormat(ctx, req.Metrics()) | ||
if err != nil { | ||
http.Error(w, err.Error(), http.StatusBadRequest) | ||
return | ||
} | ||
|
||
totalSamples := 0 | ||
for _, ts := range metrics { | ||
totalSamples += len(ts.Samples) | ||
} | ||
|
||
if !requestLimiter.AllowSeries(tenant, int64(len(metrics))) { | ||
http.Error(w, "too many timeseries", http.StatusRequestEntityTooLarge) | ||
return | ||
} | ||
|
||
if !requestLimiter.AllowSamples(tenant, int64(totalSamples)) { | ||
http.Error(w, "too many samples", http.StatusRequestEntityTooLarge) | ||
return | ||
} | ||
|
||
rep := uint64(0) | ||
// If the header is empty, we assume the request is not yet replicated. | ||
if replicaRaw := r.Header.Get(h.options.ReplicaHeader); replicaRaw != "" { | ||
if rep, err = strconv.ParseUint(replicaRaw, 10, 64); err != nil { | ||
http.Error(w, "could not parse replica header", http.StatusBadRequest) | ||
return | ||
} | ||
} | ||
|
||
//TODO: (nicolastakashi) Handle metadata in the future. | ||
wreq := tprompb.WriteRequest{ | ||
Timeseries: metrics, | ||
} | ||
|
||
// Exit early if the request contained no data. We don't support metadata yet. We also cannot fail here, because | ||
// this would mean lack of forward compatibility for remote write proto. | ||
if len(wreq.Timeseries) == 0 { | ||
// TODO(yeya24): Handle remote write metadata. | ||
if len(wreq.Metadata) > 0 { | ||
// TODO(bwplotka): Do we need this error message? | ||
level.Debug(tLogger).Log("msg", "only metadata from client; metadata ingestion not supported; skipping") | ||
return | ||
} | ||
level.Debug(tLogger).Log("msg", "empty remote write request; client bug or newer remote write protocol used?; skipping") | ||
return | ||
} | ||
|
||
// Apply relabeling configs. | ||
h.relabel(&wreq) | ||
if len(wreq.Timeseries) == 0 { | ||
level.Debug(tLogger).Log("msg", "remote write request dropped due to relabeling.") | ||
return | ||
} | ||
|
||
responseStatusCode := http.StatusOK | ||
tenantStats, err := h.handleRequest(ctx, rep, tenant, &wreq) | ||
if err != nil { | ||
level.Debug(tLogger).Log("msg", "failed to handle request", "err", err.Error()) | ||
switch errors.Cause(err) { | ||
case errNotReady: | ||
responseStatusCode = http.StatusServiceUnavailable | ||
case errUnavailable: | ||
responseStatusCode = http.StatusServiceUnavailable | ||
case errConflict: | ||
responseStatusCode = http.StatusConflict | ||
case errBadReplica: | ||
responseStatusCode = http.StatusBadRequest | ||
default: | ||
level.Error(tLogger).Log("err", err, "msg", "internal server error") | ||
Check failure Code scanning / CodeQL Clear-text logging of sensitive information High Sensitive data returned by HTTP request headers Error loading related location Loading |
||
responseStatusCode = http.StatusInternalServerError | ||
} | ||
http.Error(w, err.Error(), responseStatusCode) | ||
} | ||
|
||
for tenant, stats := range tenantStats { | ||
h.writeTimeseriesTotal.WithLabelValues(strconv.Itoa(responseStatusCode), tenant).Observe(float64(stats.timeseries)) | ||
h.writeSamplesTotal.WithLabelValues(strconv.Itoa(responseStatusCode), tenant).Observe(float64(stats.totalSamples)) | ||
} | ||
|
||
} | ||
|
||
func (h *Handler) convertToPrometheusFormat(ctx context.Context, pmetrics pmetric.Metrics) ([]tprompb.TimeSeries, []tprompb.MetricMetadata, error) { | ||
converter := otlptranslator.NewPrometheusConverter() | ||
settings := otlptranslator.Settings{ | ||
AddMetricSuffixes: true, | ||
DisableTargetInfo: h.options.OtlpDisableTargetInfo, | ||
PromoteResourceAttributes: h.options.OtlpResourceAttributes, | ||
} | ||
|
||
annots, err := converter.FromMetrics(ctx, pmetrics, settings) | ||
ws, _ := annots.AsStrings("", 0, 0) | ||
if len(ws) > 0 { | ||
level.Warn(h.logger).Log("msg", "Warnings translating OTLP metrics to Prometheus write request", "warnings", ws) | ||
} | ||
|
||
if err != nil { | ||
level.Error(h.logger).Log("msg", "Error translating OTLP metrics to Prometheus write request", "err", err) | ||
return nil, nil, err.Err() | ||
} | ||
|
||
return converter.TimeSeries(), converter.Metadata(), nil | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Two suggestions:
receive.otlp-enable-target-info
(since that is also the default)If enabled, converts the resource to the target info metric.