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

filters/auth: add tracing tag for jwtMetrics #3085

Merged
merged 1 commit into from
May 29, 2024
Merged

filters/auth: add tracing tag for jwtMetrics #3085

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
22 changes: 15 additions & 7 deletions filters/auth/jwt_metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"strings"

"github.com/ghodss/yaml"
"github.com/opentracing/opentracing-go"
"github.com/zalando/skipper/filters"
"github.com/zalando/skipper/filters/annotate"
"github.com/zalando/skipper/jwt"
Expand Down Expand Up @@ -75,33 +76,40 @@ func (f *jwtMetricsFilter) Response(ctx filters.FilterContext) {

request := ctx.Request()

metrics := ctx.Metrics()
metricsPrefix := fmt.Sprintf("%s.%s.%d.", request.Method, escapeMetricKeySegment(request.Host), response.StatusCode)
count := func(metric string) {
prefix := fmt.Sprintf("%s.%s.%d.", request.Method, escapeMetricKeySegment(request.Host), response.StatusCode)

ctx.Metrics().IncCounter(prefix + metric)

if span := opentracing.SpanFromContext(ctx.Request().Context()); span != nil {
span.SetTag("jwt", metric)
}
}

ahead := request.Header.Get("Authorization")
if ahead == "" {
metrics.IncCounter(metricsPrefix + "missing-token")
count("missing-token")
return
}

tv := strings.TrimPrefix(ahead, "Bearer ")
if tv == ahead {
metrics.IncCounter(metricsPrefix + "invalid-token-type")
count("invalid-token-type")
return
}

if len(f.Issuers) > 0 {
token, err := jwt.Parse(tv)
if err != nil {
metrics.IncCounter(metricsPrefix + "invalid-token")
count("invalid-token")
return
}

// https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.1
if issuer, ok := token.Claims["iss"].(string); !ok {
metrics.IncCounter(metricsPrefix + "missing-issuer")
count("missing-issuer")
} else if !slices.Contains(f.Issuers, issuer) {
metrics.IncCounter(metricsPrefix + "invalid-issuer")
count("invalid-issuer")
}
}
}
Expand Down
36 changes: 31 additions & 5 deletions filters/auth/jwt_metrics_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ import (
"net/http/httptest"
"net/url"
"testing"
"time"

"github.com/opentracing/opentracing-go/mocktracer"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/zalando/skipper/eskip"
Expand All @@ -31,11 +33,12 @@ func TestJwtMetrics(t *testing.T) {
defer testAuthServer.Close()

for _, tc := range []struct {
name string
filters string
request *http.Request
status int
expected map[string]int64
name string
filters string
request *http.Request
status int
expected map[string]int64
expectedTag string
}{
{
name: "ignores 401 response",
Expand Down Expand Up @@ -66,6 +69,7 @@ func TestJwtMetrics(t *testing.T) {
expected: map[string]int64{
"jwtMetrics.custom.GET.foo_test.200.missing-token": 1,
},
expectedTag: "missing-token",
},
{
name: "invalid-token-type",
Expand All @@ -77,6 +81,7 @@ func TestJwtMetrics(t *testing.T) {
expected: map[string]int64{
"jwtMetrics.custom.GET.foo_test.200.invalid-token-type": 1,
},
expectedTag: "invalid-token-type",
},
{
name: "invalid-token",
Expand All @@ -88,6 +93,7 @@ func TestJwtMetrics(t *testing.T) {
expected: map[string]int64{
"jwtMetrics.custom.GET.foo_test.200.invalid-token": 1,
},
expectedTag: "invalid-token",
},
{
name: "missing-issuer",
Expand All @@ -101,6 +107,7 @@ func TestJwtMetrics(t *testing.T) {
expected: map[string]int64{
"jwtMetrics.custom.GET.foo_test.200.missing-issuer": 1,
},
expectedTag: "missing-issuer",
},
{
name: "invalid-issuer",
Expand All @@ -114,6 +121,7 @@ func TestJwtMetrics(t *testing.T) {
expected: map[string]int64{
"jwtMetrics.custom.GET.foo_test.200.invalid-issuer": 1,
},
expectedTag: "invalid-issuer",
},
{
name: "no invalid-issuer for empty issuers",
Expand Down Expand Up @@ -156,6 +164,7 @@ func TestJwtMetrics(t *testing.T) {
expected: map[string]int64{
"jwtMetrics.custom.GET.foo_test.200.missing-token": 1,
},
expectedTag: "missing-token",
},
{
name: "no metrics when opted-out by annotation",
Expand Down Expand Up @@ -188,6 +197,7 @@ func TestJwtMetrics(t *testing.T) {
expected: map[string]int64{
"jwtMetrics.custom.GET.foo_test.200.missing-token": 1,
},
expectedTag: "missing-token",
},
{
name: "no metrics when opted-out by state bag",
Expand Down Expand Up @@ -220,11 +230,13 @@ func TestJwtMetrics(t *testing.T) {
expected: map[string]int64{
"jwtMetrics.custom.GET.foo_test.200.invalid-token": 1,
},
expectedTag: "invalid-token",
},
} {
t.Run(tc.name, func(t *testing.T) {
m := &metricstest.MockMetrics{}
defer m.Close()
tracer := mocktracer.New()

fr := builtin.MakeRegistry()
fr.Register(auth.NewJwtMetrics())
Expand All @@ -236,6 +248,10 @@ func TestJwtMetrics(t *testing.T) {
Routes: eskip.MustParse(fmt.Sprintf(`* -> %s -> status(%d) -> <shunt>`, tc.filters, tc.status)),
ProxyParams: proxy.Params{
Metrics: m,
OpenTracing: &proxy.OpenTracingParams{
Tracer: tracer,
DisableFilterSpans: true,
},
},
}.Create()
defer p.Close()
Expand All @@ -249,6 +265,16 @@ func TestJwtMetrics(t *testing.T) {
resp.Body.Close()
require.Equal(t, tc.status, resp.StatusCode)

// wait for the span to be finished
require.Eventually(t, func() bool { return len(tracer.FinishedSpans()) == 1 }, time.Second, 100*time.Millisecond)

span := tracer.FinishedSpans()[0]
if tc.expectedTag == "" {
assert.Nil(t, span.Tag("jwt"))
} else {
assert.Equal(t, tc.expectedTag, span.Tag("jwt"))
}

m.WithCounters(func(counters map[string]int64) {
// add incoming counter to simplify comparison
tc.expected["incoming.HTTP/1.1"] = 1
Expand Down
Loading