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.

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

Open
wants to merge 28 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
4415626
[FEATURE] adding otlp endpoint
nicolastakashi Dec 16, 2024
58e4bc2
[FEATURE] adding otlp endpoint
nicolastakashi Dec 16, 2024
6b464fa
[FEATURE] adding otlp endpoint
nicolastakashi Dec 16, 2024
8a80246
Merge branch 'main' into chore/adding-otlp-endpoint
nicolastakashi Dec 17, 2024
5f71e26
[FIX] e2e tests for otlp receiver
nicolastakashi Dec 18, 2024
593aca7
Merge branch 'main' into chore/adding-otlp-endpoint
nicolastakashi Dec 18, 2024
fdd473a
[CHORE] adding otlp flags
nicolastakashi Dec 18, 2024
18a48b6
[DOC] updating docs
nicolastakashi Dec 18, 2024
13761e2
[CHORE] copying otlptranslator
nicolastakashi Dec 18, 2024
6431b67
[CHORE] copying otlptranslator tests
nicolastakashi Dec 18, 2024
b163dab
[CHORE] copying otlptranslator tests
nicolastakashi Dec 18, 2024
543a28f
[CHORE] copying otlptranslator tests
nicolastakashi Dec 18, 2024
5aa4063
[FIX] lint issues
nicolastakashi Dec 18, 2024
f9841ba
[FIX] lint issues
nicolastakashi Dec 18, 2024
991c8e5
[FIX] lint issues
nicolastakashi Dec 18, 2024
0dc5845
[CHORE] using multi errors
nicolastakashi Dec 19, 2024
65dc21b
[CHORE] using multi errors
nicolastakashi Dec 19, 2024
ab46f3b
[FIX] span naming convention
nicolastakashi Dec 19, 2024
8be010c
[TEST] adding handler otlp unit test
nicolastakashi Dec 19, 2024
5b4600b
[TEST] upgrade collector version
nicolastakashi Dec 19, 2024
706e41e
[FIX] golang lint
nicolastakashi Dec 19, 2024
b57f248
Merge branch 'main' into chore/adding-otlp-endpoint
nicolastakashi Dec 19, 2024
fc5e612
[CHORE] adding allow size bytes limit gate
nicolastakashi Dec 20, 2024
12dbf04
[FIX] unit test otlp endpoint
nicolastakashi Dec 20, 2024
63ce67b
Apply suggestions from code review
nicolastakashi Dec 20, 2024
d2e6b60
[FIX] unit test otlp endpoint
nicolastakashi Dec 20, 2024
a2bef89
[DOC] updating docs
nicolastakashi Dec 20, 2024
493fe90
Merge branch 'main' into chore/adding-otlp-endpoint
nicolastakashi Dec 20, 2024
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
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ require (
github.com/onsi/gomega v1.34.0
github.com/prometheus-community/prom-label-proxy v0.8.1-0.20240127162815-c1195f9aabc0
github.com/seiflotfy/cuckoofilter v0.0.0-20240715131351-a2f2c23f1771
go.opentelemetry.io/collector/pdata v1.14.1
go.opentelemetry.io/contrib/propagators/autoprop v0.54.0
go4.org/intern v0.0.0-20230525184215-6c62f75575cb
golang.org/x/exp v0.0.0-20240613232115-7f521ea00fb8
Expand Down Expand Up @@ -154,7 +155,6 @@ require (
github.com/pbnjay/memory v0.0.0-20210728143218-7b4eea64cf58 // indirect
github.com/sercand/kuberesolver/v4 v4.0.0 // indirect
github.com/zhangyunhao116/umap v0.0.0-20221211160557-cb7705fafa39 // indirect
go.opentelemetry.io/collector/pdata v1.14.1 // indirect
go.opentelemetry.io/collector/semconv v0.108.1 // indirect
go.opentelemetry.io/contrib/instrumentation/google.golang.org/grpc/otelgrpc v0.49.0 // indirect
go.opentelemetry.io/contrib/propagators/ot v1.29.0 // indirect
Expand Down
12 changes: 12 additions & 0 deletions pkg/receive/handler.go
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,18 @@ func NewHandler(logger log.Logger, o *Options) *Handler {
),
)

h.router.Post(
Copy link
Contributor Author

Choose a reason for hiding this comment

The 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 metrics_endpoint instead of endpoint property, maybe worth document it or writing a blog post later about Thanos and OTLP wdyt?

"/v1/metrics",
nicolastakashi marked this conversation as resolved.
Show resolved Hide resolved
instrf(
"otlp",
readyf(
middleware.RequestID(
http.HandlerFunc(h.receiveOTLPHTTP),
),
),
),
)

statusAPI := statusapi.New(statusapi.Options{
GetStats: h.getStats,
Registry: h.options.Registry,
Expand Down
214 changes: 214 additions & 0 deletions pkg/receive/handler_otlp.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,214 @@
// 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/prompb"
"github.com/prometheus/prometheus/storage/remote"
"github.com/prometheus/prometheus/storage/remote/otlptranslator/prometheusremotewrite"
"github.com/thanos-io/thanos/pkg/store/labelpb"
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(), "receiveOTLPHTTP")
nicolastakashi marked this conversation as resolved.
Show resolved Hide resolved
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
flows to a logging call.
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
flows to a logging call.
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()
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
}

promTimeSeries, err := h.convertToPrometheusFormat(ctx, req.Metrics())
if err != nil {
http.Error(w, err.Error(), http.StatusBadRequest)
return
}

prwMetrics := make([]tprompb.TimeSeries, 0, len(promTimeSeries))
totalSamples := 0
var tpromTs tprompb.TimeSeries

for _, ts := range promTimeSeries {
tpromTs = tprompb.TimeSeries{
Labels: makeLabels(ts.Labels),
Samples: makeSamples(ts.Samples),
Exemplars: makeExemplars(ts.Exemplars),
}
totalSamples += len(ts.Samples)
prwMetrics = append(prwMetrics, tpromTs)
}

if !requestLimiter.AllowSeries(tenant, int64(len(prwMetrics))) {
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
}
}

wreq := tprompb.WriteRequest{
Timeseries: prwMetrics,
// TODO Handle metadata, requires thanos receiver support ingesting metadata
//Metadata: otlptranslator.OtelMetricsToMetadata(),
}

// 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
flows to a logging call.
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) ([]prompb.TimeSeries, error) {
promConverter := prometheusremotewrite.NewPrometheusConverter()
settings := prometheusremotewrite.Settings{
AddMetricSuffixes: true,
DisableTargetInfo: true, // this must to be configured
PromoteResourceAttributes: []string{"service.name", "service.namespace"}, // this must to be configured
}

annots, err := promConverter.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, err
}

return promConverter.TimeSeries(), nil
nicolastakashi marked this conversation as resolved.
Show resolved Hide resolved
}

func makeLabels(in []prompb.Label) []labelpb.ZLabel {
nicolastakashi marked this conversation as resolved.
Show resolved Hide resolved
out := make([]labelpb.ZLabel, 0, len(in))
for _, l := range in {
out = append(out, labelpb.ZLabel{Name: l.Name, Value: l.Value})
}
return out
}

func makeSamples(in []prompb.Sample) []tprompb.Sample {
out := make([]tprompb.Sample, 0, len(in))
for _, s := range in {
out = append(out, tprompb.Sample{
Value: s.Value,
Timestamp: s.Timestamp,
})
}
return out
}

func makeExemplars(in []prompb.Exemplar) []tprompb.Exemplar {
out := make([]tprompb.Exemplar, 0, len(in))
for _, e := range in {
out = append(out, tprompb.Exemplar{
Labels: makeLabels(e.Labels),
Value: e.Value,
Timestamp: e.Timestamp,
})
}
return out
}
78 changes: 78 additions & 0 deletions test/e2e/e2ethanos/services.go
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,11 @@ func DefaultPrometheusImage() string {
return "quay.io/prometheus/prometheus:v2.41.0"
}

// DefaultOtelImage sets default Otel image used in e2e service.
func DefaultOtelImage() string {
return "otel/opentelemetry-collector-contrib:0.98.0"
nicolastakashi marked this conversation as resolved.
Show resolved Hide resolved
}

// DefaultAlertmanagerImage sets default Alertmanager image used in e2e service.
func DefaultAlertmanagerImage() string {
return "quay.io/prometheus/alertmanager:v0.20.0"
Expand Down Expand Up @@ -130,6 +135,30 @@ func NewPrometheus(e e2e.Environment, name, promConfig, webConfig, promImage str
})), "http")
}

func NewOtel(e e2e.Environment, name, otelConfig, otelImage string) *e2eobs.Observable {
f := e.Runnable(name).WithPorts(map[string]int{"http": 9090}).Future()
if err := os.MkdirAll(f.Dir(), 0750); err != nil {
return &e2eobs.Observable{Runnable: e2e.NewFailedRunnable(name, errors.Wrap(err, "create otel dir"))}
}

if err := os.WriteFile(filepath.Join(f.Dir(), "otel.yaml"), []byte(otelConfig), 0600); err != nil {
return &e2eobs.Observable{Runnable: e2e.NewFailedRunnable(name, errors.Wrap(err, "creating otel config"))}
}

//probe := e2e.NewHTTPReadinessProbe("http", "/-/ready", 200, 200)
args := e2e.BuildArgs(map[string]string{
"--config": filepath.Join(f.InternalDir(), "otel.yaml"),
//"--log.level": infoLogLevel,
//"--web.listen-address": ":9090",
})

return e2eobs.AsObservable(f.Init(wrapWithDefaults(e2e.StartOptions{
Image: otelImage,
Command: e2e.NewCommandWithoutEntrypoint("/otelcol-contrib", args...),
//Readiness: probe,
})), "http")
}

func NewPrometheusWithSidecar(e e2e.Environment, name, promConfig, webConfig, promImage, minTime string, enableFeatures ...string) (*e2eobs.Observable, *e2eobs.Observable) {
return NewPrometheusWithSidecarCustomImage(e, name, promConfig, webConfig, promImage, minTime, DefaultImage(), enableFeatures...)
}
Expand Down Expand Up @@ -523,6 +552,8 @@ func (q *QuerierBuilder) collectArgs() ([]string, error) {
return args, nil
}

func OTLPEndpoint(addr string) string { return fmt.Sprintf("http://%s", addr) }

func RemoteWriteEndpoint(addr string) string { return fmt.Sprintf("http://%s/api/v1/receive", addr) }

func RemoteWriteEndpoints(addrs ...string) string {
Expand Down Expand Up @@ -1250,6 +1281,53 @@ rule_files:
return config
}

// DefaultOtelConfig returns Otel config that sets Otel to:
// * expose 2 external labels, source and replica.
// * optionally scrape self. This will produce up == 0 metric which we can assert on.
// * optionally remote write endpoint to write into.
func DefaultOtelConfig(remoteWriteEndpoint string) string {
config := fmt.Sprintf(`
receivers:
otlp:
protocols:
grpc:
endpoint: 0.0.0.0:4317
http:
endpoint: 0.0.0.0:4318
prometheus:
config:
scrape_configs:
- job_name: otel-collector
scrape_interval: 5s
static_configs:
- targets: [localhost:8888]
exporters:
otlphttp/thanos:
endpoint: "%s"
tls:
insecure: true
debug:
verbosity: detailed
extensions:
health_check:
pprof:
service:
telemetry:
logs:
level: "debug"
extensions: [pprof, health_check]
pipelines:
metrics:
receivers:
- prometheus
- otlp
exporters:
- otlphttp/thanos
`, remoteWriteEndpoint)

return config
}

func NewRedis(e e2e.Environment, name string) e2e.Runnable {
return e.Runnable(fmt.Sprintf("redis-%s", name)).WithPorts(map[string]int{"redis": 6379}).Init(
e2e.StartOptions{
Expand Down
Loading
Loading