IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2024-11-27 03:11:01 -06:00
Code Issues Packages Projects Releases Wiki Activity

IDForwarding: Add basic metrics (#75798)

Browse Source 
* IDService: Add basic metrics

* IDService: Add more metrics
---------

Co-authored-by: Gabriel MABILLE <gamab@users.noreply.github.com>
This commit is contained in:
Karl Persson 2023-10-05 09:17:40 +02:00 committed by GitHub
parent 586c78a636
commit a2d4ce18ad
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 76 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
pkg/services/auth/idimpl/metrics.go Normal file
View File

@ -0,0 +1,56 @@
package idimpl
import (
"github.com/prometheus/client_golang/prometheus"
)
const (
metricsNamespace = "grafana"
metricsSubSystem = "idforwarding"
)
func newMetrics(reg prometheus.Registerer) *metrics {
m := &metrics{
tokenSigningCounter: prometheus.NewCounter(prometheus.CounterOpts{
Namespace: metricsNamespace,
Subsystem: metricsSubSystem,
Name: "idforwarding_token_signing_total",
Help: "Number of token signings",
}),
tokenSigningFromCacheCounter: prometheus.NewCounter(prometheus.CounterOpts{
Namespace: metricsNamespace,
Subsystem: metricsSubSystem,
Name: "idforwarding_token_signing_from_cache_total",
Help: "Number of signed tokens retrieved from cache",
}),
failedTokenSigningCounter: prometheus.NewCounter(prometheus.CounterOpts{
Namespace: metricsNamespace,
Subsystem: metricsSubSystem,
Name: "idforwarding_failed_token_signing_total",
Help: "Number of failed token signings",
}),
tokenSigningDurationHistogram: prometheus.NewHistogram(prometheus.HistogramOpts{
Namespace: metricsNamespace,
Subsystem: metricsSubSystem,
Name: "idforwarding_token_signing_duration_seconds",
Help: "Histogram of token signing duration",
Buckets: []float64{0.1, 0.25, 0.5, 1, 2, 5, 10},
}),
}
if reg != nil {
reg.MustRegister(m.tokenSigningCounter)
reg.MustRegister(m.tokenSigningFromCacheCounter)
reg.MustRegister(m.failedTokenSigningCounter)
reg.MustRegister(m.tokenSigningDurationHistogram)
}
return m
}
type metrics struct {
tokenSigningCounter prometheus.Counter
tokenSigningFromCacheCounter prometheus.Counter
failedTokenSigningCounter prometheus.Counter
tokenSigningDurationHistogram prometheus.Histogram
}

23
pkg/services/auth/idimpl/service.go
View File

@ -14,6 +14,7 @@ import (
"github.com/grafana/grafana/pkg/services/authn"
"github.com/grafana/grafana/pkg/services/featuremgmt"
"github.com/grafana/grafana/pkg/setting"
"github.com/prometheus/client_golang/prometheus"
)
const (
@ -26,9 +27,9 @@ var _ auth.IDService = (*Service)(nil)
func ProvideService(
cfg *setting.Cfg, signer auth.IDSigner, cache remotecache.CacheStorage,
features featuremgmt.FeatureToggles, authnService authn.Service,
features featuremgmt.FeatureToggles, authnService authn.Service, reg prometheus.Registerer,
) *Service {
s := &Service{cfg, log.New("id-service"), signer, cache}
s := &Service{cfg, log.New("id-service"), signer, cache, newMetrics(reg)}
if features.IsEnabled(featuremgmt.FlagIdForwarding) {
authnService.RegisterPostAuthHook(s.hook, 140)
@ -38,22 +39,29 @@ func ProvideService(
}
type Service struct {
cfg *setting.Cfg
logger log.Logger
signer auth.IDSigner
cache remotecache.CacheStorage
cfg *setting.Cfg
logger log.Logger
signer auth.IDSigner
cache remotecache.CacheStorage
metrics *metrics
}
func (s *Service) SignIdentity(ctx context.Context, id identity.Requester) (string, error) {
defer func(t time.Time) {
s.metrics.tokenSigningDurationHistogram.Observe(time.Since(t).Seconds())
}(time.Now())
namespace, identifier := id.GetNamespacedID()
cacheKey := prefixCacheKey(id.GetCacheKey())
cachedToken, err := s.cache.Get(ctx, cacheKey)
if err == nil {
s.metrics.tokenSigningFromCacheCounter.Inc()
s.logger.Debug("Cached token found", "namespace", namespace, "id", identifier)
return string(cachedToken), nil
}
s.metrics.tokenSigningCounter.Inc()
s.logger.Debug("Sign new id token", "namespace", namespace, "id", identifier)
now := time.Now()
@ -69,11 +77,12 @@ func (s *Service) SignIdentity(ctx context.Context, id identity.Requester) (stri
})
if err != nil {
s.metrics.failedTokenSigningCounter.Inc()
return "", err
}
if err := s.cache.Set(ctx, cacheKey, []byte(token), cacheTTL); err != nil {
s.logger.Error("failed to set cache", "error", err)
s.logger.Error("Failed to add id token to cache", "error", err)
}
return token, nil

7
pkg/services/auth/idimpl/service_test.go
View File

@ -3,11 +3,12 @@ package idimpl
import (
"testing"
"github.com/stretchr/testify/assert"
"github.com/grafana/grafana/pkg/services/authn"
"github.com/grafana/grafana/pkg/services/authn/authntest"
"github.com/grafana/grafana/pkg/services/featuremgmt"
"github.com/grafana/grafana/pkg/setting"
"github.com/stretchr/testify/assert"
)
func Test_ProvideService(t *testing.T) {
@ -21,7 +22,7 @@ func Test_ProvideService(t *testing.T) {
},
}
_ = ProvideService(setting.NewCfg(), nil, nil, features, authnService)
_ = ProvideService(setting.NewCfg(), nil, nil, features, authnService, nil)
assert.True(t, hookRegistered)
})
@ -35,7 +36,7 @@ func Test_ProvideService(t *testing.T) {
},
}
_ = ProvideService(setting.NewCfg(), nil, nil, features, authnService)
_ = ProvideService(setting.NewCfg(), nil, nil, features, authnService, nil)
assert.False(t, hookRegistered)
})
}