Skip to content

feat: support Tempo Query V2 and search tag values endpoint in trace RBAC #916

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

Merged
pavolloffay merged 3 commits into from
Jul 24, 2026
+342 −10
Merged

feat: support Tempo Query V2 and search tag values endpoint in trace RBAC #916

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7efb62f
feat: support Tempo Query V2 and search tag values endpoint in trace …
andreasgerstmayr Jul 10, 2026
e245460
Merge remote-tracking branch 'upstream/main' into tempo-query-v2
andreasgerstmayr Jul 22, 2026
b1e85f6
add warning in default case
andreasgerstmayr Jul 23, 2026
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
39 changes: 31 additions & 8 deletions api/traces/v1/trace_rbac.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,15 @@ const (
serviceAttributeKey = "service.name"
)

var allowedTempoAPIs = []*regexp.Regexp{
regexp.MustCompile(`^/api/traces/\w+$`),
regexp.MustCompile(`^/api/search$`),
}
var (
routeQueryV1 = regexp.MustCompile(`^/api/traces/\w+$`)
routeQueryV2 = regexp.MustCompile(`^/api/v2/traces/\w+$`)
routeSearch = regexp.MustCompile(`^/api/search$`)
routeSearchTagValues = regexp.MustCompile(`^/api/v2/search/tag/(resource\.service\.name|resource\.k8s\.namespace\.name)/values$`)

allowedTempoAPIs = []*regexp.Regexp{routeQueryV1, routeQueryV2, routeSearch, routeSearchTagValues}
filteredAPIs = []*regexp.Regexp{routeQueryV1, routeQueryV2, routeSearch}
)

func matchesAnyRegex(s string, patterns []*regexp.Regexp) bool {
for _, re := range patterns {
Expand Down Expand Up @@ -77,7 +82,7 @@ func WithTraceQLNamespaceSelectAndForbidOtherAPIs(enabled bool) func(http.Handle

func responseRBACModifier(log log.Logger) func(response *http.Response) error {
return func(response *http.Response) error {
if strings.HasPrefix(response.Request.URL.Path, "/api/traces/") || strings.HasPrefix(response.Request.URL.Path, "/api/search") {
if matchesAnyRegex(response.Request.URL.Path, filteredAPIs) {
allowedNamespaces := map[string]bool{}
namespaces := apilogsv1.AllowedNamespaces(response.Request.Context())
for _, ns := range namespaces {
Expand All @@ -92,7 +97,8 @@ func responseRBACModifier(log log.Logger) func(response *http.Response) error {
}

responseBuffer := &bytes.Buffer{}
if strings.HasPrefix(response.Request.URL.Path, "/api/traces/") {
switch {

@pavolloffay pavolloffay Jul 23, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shall we add a default case with some logging?

@andreasgerstmayr andreasgerstmayr Jul 23, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added

case routeQueryV1.MatchString(response.Request.URL.Path):
trace := &tempopb.Trace{}
err = tempopb.UnmarshalFromJSONV1(b, trace)
if err != nil {
Expand All @@ -105,9 +111,26 @@ func responseRBACModifier(log log.Logger) func(response *http.Response) error {
return err
}
responseBuffer = bytes.NewBuffer(traceResponseBody)
} else {

case routeQueryV2.MatchString(response.Request.URL.Path):
traceByIDResponse := &tempopb.TraceByIDResponse{}
unmarshaller := jsonpb.Unmarshaler{}
err = unmarshaller.Unmarshal(bytes.NewReader(b), traceByIDResponse)
if err != nil {
return err
}
traceByIDResponse.Trace = traceRBAC(allowedNamespaces, traceByIDResponse.Trace)

marshaller := jsonpb.Marshaler{}
err = marshaller.Marshal(responseBuffer, traceByIDResponse)
if err != nil {
return err
}

case routeSearch.MatchString(response.Request.URL.Path):
searchResponse := &tempopb.SearchResponse{}
err = jsonpb.UnmarshalString(string(b), searchResponse)
unmarshaller := jsonpb.Unmarshaler{}
err = unmarshaller.Unmarshal(bytes.NewReader(b), searchResponse)
if err != nil {
return err
}
Expand Down
287 changes: 286 additions & 1 deletion api/traces/v1/trace_rbac_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,25 @@
package v1

import (
"context"
"fmt"
"io"
"net/http"
"net/http/httptest"
"net/url"
"strings"
"testing"

"github.com/go-kit/log"
"github.com/grafana/tempo/pkg/tempopb"
commonv1 "github.com/grafana/tempo/pkg/tempopb/common/v1"
resourcev1 "github.com/grafana/tempo/pkg/tempopb/resource/v1"
tracev1 "github.com/grafana/tempo/pkg/tempopb/trace/v1"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"

apilogsv1 "github.com/observatorium/api/api/logs/v1"
"github.com/observatorium/api/authorization"
)

func TestForbidOtherAPIs(t *testing.T) {
Expand All @@ -28,10 +38,14 @@ func TestForbidOtherAPIs(t *testing.T) {
{"search tags blocked", "/tempo/api/search/tags", http.StatusForbidden},
{"search tag values blocked", "/tempo/api/search/tag/name/values", http.StatusForbidden},
{"v2 search tags blocked", "/tempo/api/v2/search/tags", http.StatusForbidden},
{"v2 search tag values for service.name", "/tempo/api/v2/search/tag/resource.service.name/values", http.StatusOK},
{"v2 search tag values for k8s.namespace.name", "/tempo/api/v2/search/tag/resource.k8s.namespace.name/values", http.StatusOK},
{"v2 search tag values for other resource attributes blocked", "/tempo/api/v2/search/tag/resource.other/values", http.StatusForbidden},
{"v2 search tag values for span attribtues blocked", "/tempo/api/v2/search/tag/span.http.method/values", http.StatusForbidden},
{"metrics blocked", "/tempo/api/metrics/query_range", http.StatusForbidden},
{"echo blocked", "/tempo/api/echo", http.StatusForbidden},
{"overrides blocked", "/tempo/api/overrides", http.StatusForbidden},
{"v2 traces blocked", "/tempo/api/v2/traces/abc123", http.StatusForbidden},
{"v2 trace by ID", "/tempo/api/v2/traces/abc123", http.StatusOK},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
Expand Down Expand Up @@ -528,3 +542,274 @@ func TestRBACSearchResult(t *testing.T) {
})
}
}

func contextWithAllowedNamespaces(t *testing.T, namespaces []string) context.Context {
t.Helper()
data := fmt.Sprintf(`{"matchers":[{"name":"namespace","value":"%s","type":1}]}`, url.QueryEscape(strings.Join(namespaces, "|")))

var captured context.Context
handler := apilogsv1.WithEnforceAuthorizationLabels()(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
captured = r.Context()
}))

req := httptest.NewRequest(http.MethodGet, "/", nil)
req = req.WithContext(authorization.WithData(req.Context(), data))
handler.ServeHTTP(httptest.NewRecorder(), req)
require.NotNil(t, captured)
return captured
}

func makeResponse(ctx context.Context, statusCode int, path string, body string, header http.Header) *http.Response {
if header == nil {
header = http.Header{}
}
return &http.Response{
StatusCode: statusCode,
Header: header,
Body: io.NopCloser(strings.NewReader(body)),
Request: (&http.Request{URL: &url.URL{Path: path}}).WithContext(ctx),
}
}

func TestResponseRBACModifier(t *testing.T) {
modifier := responseRBACModifier(log.NewNopLogger())
ctx := contextWithAllowedNamespaces(t, []string{"allowed-ns"})

t.Run("v1 trace endpoint", func(t *testing.T) {
resp := makeResponse(ctx, http.StatusOK, "/api/traces/abc123", `{
"batches": [
{
"resource": {
"attributes": [
{"key": "k8s.namespace.name", "value": {"stringValue": "allowed-ns"}}
]
},
"scopeSpans": [
{"scope": {}, "spans": [
{"attributes": [{"key": "span1", "value": {"stringValue": "val"}}]}
]}
]
},
{
"resource": {
"attributes": [
{"key": "k8s.namespace.name", "value": {"stringValue": "blocked-ns"}},
{"key": "service.name", "value": {"stringValue": "blocked-svc"}}
]
},
"scopeSpans": [
{"scope": {}, "spans": [
{"attributes": [{"key": "span2", "value": {"stringValue": "val"}}]}
]}
]
}
]
}`, nil)

require.NoError(t, modifier(resp))

body, _ := io.ReadAll(resp.Body)
assert.JSONEq(t, `{
"batches": [
{
"resource": {
"attributes": [
{"key": "k8s.namespace.name", "value": {"stringValue": "allowed-ns"}}
]
},
"scopeSpans": [
{"scope": {}, "spans": [
{"attributes": [{"key": "span1", "value": {"stringValue": "val"}}]}
]}
]
},
{
"resource": {
"attributes": [
{"key": "k8s.namespace.name", "value": {"stringValue": "blocked-ns"}},
{"key": "service.name", "value": {"stringValue": "blocked-svc"}}
]
},
"scopeSpans": [
{"scope": {"attributes": []}, "spans": [
{"attributes": [], "events": []}
]}
]
}
]
}`, string(body))
})

t.Run("v2 trace endpoint", func(t *testing.T) {
resp := makeResponse(ctx, http.StatusOK, "/api/v2/traces/abc123", `{
"trace": {
"resourceSpans": [
{
"resource": {
"attributes": [
{"key": "k8s.namespace.name", "value": {"stringValue": "allowed-ns"}}
]
},
"scopeSpans": [
{"scope": {}, "spans": [
{"attributes": [{"key": "span1", "value": {"stringValue": "val"}}]}
]}
]
},
{
"resource": {
"attributes": [
{"key": "k8s.namespace.name", "value": {"stringValue": "blocked-ns"}},
{"key": "service.name", "value": {"stringValue": "blocked-svc"}}
]
},
"scopeSpans": [
{"scope": {}, "spans": [
{"attributes": [{"key": "span2", "value": {"stringValue": "val"}}]}
]}
]
}
]
}
}`, nil)

require.NoError(t, modifier(resp))

body, _ := io.ReadAll(resp.Body)
assert.JSONEq(t, `{
"trace": {
"resourceSpans": [
{
"resource": {
"attributes": [
{"key": "k8s.namespace.name", "value": {"stringValue": "allowed-ns"}}
]
},
"scopeSpans": [
{"scope": {}, "spans": [
{"attributes": [{"key": "span1", "value": {"stringValue": "val"}}]}
]}
]
},
{
"resource": {
"attributes": [
{"key": "k8s.namespace.name", "value": {"stringValue": "blocked-ns"}},
{"key": "service.name", "value": {"stringValue": "blocked-svc"}}
]
},
"scopeSpans": [
{"scope": {}, "spans": [{}]}
]
}
]
}
}`, string(body))
})

t.Run("search endpoint", func(t *testing.T) {
resp := makeResponse(ctx, http.StatusOK, "/api/search", `{
"traces": [
{
"spanSets": [
{
"spans": [
{"attributes": [
{"key": "k8s.namespace.name", "value": {"stringValue": "allowed-ns"}},
{"key": "extra", "value": {"stringValue": "val"}}
]},
{"attributes": [
{"key": "k8s.namespace.name", "value": {"stringValue": "blocked-ns"}},
{"key": "extra", "value": {"stringValue": "val"}}
]}
]
}
]
}
]
}`, nil)

require.NoError(t, modifier(resp))

body, _ := io.ReadAll(resp.Body)
assert.JSONEq(t, `{
"traces": [
{
"spanSets": [
{
"spans": [
{"attributes": [
{"key": "k8s.namespace.name", "value": {"stringValue": "allowed-ns"}},
{"key": "extra", "value": {"stringValue": "val"}}
]},
{"attributes": [
{"key": "k8s.namespace.name", "value": {"stringValue": "blocked-ns"}}
]}
]
}
]
}
]
}`, string(body))
})

t.Run("search tag values endpoint is not modified", func(t *testing.T) {
resp := makeResponse(ctx, http.StatusOK, "/api/v2/search/tag/resource.service.name/values", `{
"tagValues": [
{"type": "string", "value": "frontend"},
{"type": "string", "value": "backend"}
]
}`, nil)

require.NoError(t, modifier(resp))

body, _ := io.ReadAll(resp.Body)
assert.JSONEq(t, `{
"tagValues": [
{"type": "string", "value": "frontend"},
{"type": "string", "value": "backend"}
]
}`, string(body))
})

t.Run("non-matching path is not modified", func(t *testing.T) {
resp := makeResponse(ctx, http.StatusOK, "/api/echo", "unmodified body", nil)

require.NoError(t, modifier(resp))

body, _ := io.ReadAll(resp.Body)
assert.Equal(t, "unmodified body", string(body))
})

t.Run("non-200 response is not modified", func(t *testing.T) {
resp := makeResponse(ctx, http.StatusNotFound, "/api/traces/abc123", "error body", nil)

require.NoError(t, modifier(resp))

body, _ := io.ReadAll(resp.Body)
assert.Equal(t, "error body", string(body))
})

t.Run("Content-Length and Content-Encoding headers are updated", func(t *testing.T) {
resp := makeResponse(ctx, http.StatusOK, "/api/traces/abc123", `{
"batches": [
{
"resource": {
"attributes": [
{"key": "k8s.namespace.name", "value": {"stringValue": "allowed-ns"}}
]
},
"scopeSpans": [
{"scope": {}, "spans": [{}]}
]
}
]
}`, http.Header{"Content-Encoding": []string{"gzip"}})

require.NoError(t, modifier(resp))

body, _ := io.ReadAll(resp.Body)
assert.Equal(t, []string{fmt.Sprint(len(body))}, resp.Header["Content-Length"])
assert.Empty(t, resp.Header["Content-Encoding"])
})
}