public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Chore: Add tracing to team service (#86999)

Browse Source 
* add tracing to team service

* another test fix

* pass in context for team creation and membership checking
This commit is contained in:
Ieva
2024-04-29 11:32:03 +01:00
committed by GitHub
parent fbaa847a3c
commit cee713e34c
13 changed files with 107 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pkg/services/team/teamimpl/store_test.go
+10 -9
View File
@@ -10,6 +10,7 @@ import (
"github.com/stretchr/testify/require"
"github.com/grafana/grafana/pkg/infra/db"
"github.com/grafana/grafana/pkg/infra/tracing"
ac "github.com/grafana/grafana/pkg/services/accesscontrol"
"github.com/grafana/grafana/pkg/services/auth/identity"
"github.com/grafana/grafana/pkg/services/dashboards/dashboardaccess"
@@ -35,7 +36,7 @@ func TestIntegrationTeamCommandsAndQueries(t *testing.T) {
}
t.Run("Testing Team commands and queries", func(t *testing.T) {
sqlStore, cfg := db.InitTestDBWithCfg(t)
teamSvc, err := ProvideService(sqlStore, cfg)
teamSvc, err := ProvideService(sqlStore, cfg, tracing.InitializeTracerForTest())
require.NoError(t, err)
testUser := &user.SignedInUser{
OrgID: 1,
@@ -73,9 +74,9 @@ func TestIntegrationTeamCommandsAndQueries(t *testing.T) {
require.NoError(t, err)
userIds = append(userIds, usr.ID)
}
team1, err = teamSvc.CreateTeam("group1 name", "test1@test.com", testOrgID)
team1, err = teamSvc.CreateTeam(context.Background(), "group1 name", "test1@test.com", testOrgID)
require.NoError(t, err)
team2, err = teamSvc.CreateTeam("group2 name", "test2@test.com", testOrgID)
team2, err = teamSvc.CreateTeam(context.Background(), "group2 name", "test2@test.com", testOrgID)
require.NoError(t, err)
}
setup()
@@ -524,12 +525,12 @@ func TestIntegrationSQLStore_SearchTeams(t *testing.T) {
}
store, cfg := db.InitTestDBWithCfg(t, db.InitTestDBOpt{})
teamSvc, err := ProvideService(store, cfg)
teamSvc, err := ProvideService(store, cfg, tracing.InitializeTracerForTest())
require.NoError(t, err)
// Seed 10 teams
for i := 1; i <= 10; i++ {
_, err := teamSvc.CreateTeam(fmt.Sprintf("team-%d", i), fmt.Sprintf("team-%d@example.org", i), 1)
_, err := teamSvc.CreateTeam(context.Background(), fmt.Sprintf("team-%d", i), fmt.Sprintf("team-%d@example.org", i), 1)
require.NoError(t, err)
}
@@ -561,11 +562,11 @@ func TestIntegrationSQLStore_GetTeamMembers_ACFilter(t *testing.T) {
// Seed 2 teams with 2 members
setup := func(store db.DB, cfg *setting.Cfg) {
teamSvc, err := ProvideService(store, cfg)
teamSvc, err := ProvideService(store, cfg, tracing.InitializeTracerForTest())
require.NoError(t, err)
team1, errCreateTeam := teamSvc.CreateTeam("group1 name", "test1@example.org", testOrgID)
team1, errCreateTeam := teamSvc.CreateTeam(context.Background(), "group1 name", "test1@example.org", testOrgID)
require.NoError(t, errCreateTeam)
team2, errCreateTeam := teamSvc.CreateTeam("group2 name", "test2@example.org", testOrgID)
team2, errCreateTeam := teamSvc.CreateTeam(context.Background(), "group2 name", "test2@example.org", testOrgID)
require.NoError(t, errCreateTeam)
quotaService := quotaimpl.ProvideService(store, cfg)
orgSvc, err := orgimpl.ProvideService(store, cfg, quotaService)
@@ -604,7 +605,7 @@ func TestIntegrationSQLStore_GetTeamMembers_ACFilter(t *testing.T) {
store, cfg := db.InitTestDBWithCfg(t, db.InitTestDBOpt{})
setup(store, cfg)
teamSvc, err := ProvideService(store, cfg)
teamSvc, err := ProvideService(store, cfg, tracing.InitializeTracerForTest())
require.NoError(t, err)
type getTeamMembersTestCase struct {
pkg/services/team/teamimpl/team.go
+69 -5
View File
@@ -3,65 +3,129 @@ package teamimpl
import (
"context"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/trace"
"github.com/grafana/grafana/pkg/infra/db"
"github.com/grafana/grafana/pkg/infra/tracing"
"github.com/grafana/grafana/pkg/services/team"
"github.com/grafana/grafana/pkg/setting"
)
type Service struct {
store store
store store
tracer tracing.Tracer
}
func ProvideService(db db.DB, cfg *setting.Cfg) (team.Service, error) {
func ProvideService(db db.DB, cfg *setting.Cfg, tracer tracing.Tracer) (team.Service, error) {
store := &xormStore{db: db, cfg: cfg, deletes: []string{}}
if err := store.uidMigration(); err != nil {
return nil, err
}
return &Service{store: &xormStore{db: db, cfg: cfg, deletes: []string{}}}, nil
return &Service{
store: &xormStore{db: db, cfg: cfg, deletes: []string{}},
tracer: tracer,
}, nil
}
func (s *Service) CreateTeam(name, email string, orgID int64) (team.Team, error) {
func (s *Service) CreateTeam(ctx context.Context, name, email string, orgID int64) (team.Team, error) {
_, span := s.tracer.Start(ctx, "team.CreateTeam", trace.WithAttributes(
attribute.Int64("orgID", orgID),
attribute.String("name", name),
))
defer span.End()
return s.store.Create(name, email, orgID)
}
func (s *Service) UpdateTeam(ctx context.Context, cmd *team.UpdateTeamCommand) error {
ctx, span := s.tracer.Start(ctx, "team.UpdateTeam", trace.WithAttributes(
attribute.Int64("orgID", cmd.OrgID),
attribute.Int64("teamID", cmd.ID),
))
defer span.End()
return s.store.Update(ctx, cmd)
}
func (s *Service) DeleteTeam(ctx context.Context, cmd *team.DeleteTeamCommand) error {
ctx, span := s.tracer.Start(ctx, "team.DeleteTeam", trace.WithAttributes(
attribute.Int64("orgID", cmd.OrgID),
attribute.Int64("teamID", cmd.ID),
))
defer span.End()
return s.store.Delete(ctx, cmd)
}
func (s *Service) SearchTeams(ctx context.Context, query *team.SearchTeamsQuery) (team.SearchTeamQueryResult, error) {
ctx, span := s.tracer.Start(ctx, "team.SearchTeams", trace.WithAttributes(
attribute.Int64("orgID", query.OrgID),
attribute.String("query", query.Query),
))
defer span.End()
return s.store.Search(ctx, query)
}
func (s *Service) GetTeamByID(ctx context.Context, query *team.GetTeamByIDQuery) (*team.TeamDTO, error) {
ctx, span := s.tracer.Start(ctx, "team.GetTeamByID", trace.WithAttributes(
attribute.Int64("orgID", query.OrgID),
attribute.Int64("teamID", query.ID),
))
defer span.End()
return s.store.GetByID(ctx, query)
}
func (s *Service) GetTeamsByUser(ctx context.Context, query *team.GetTeamsByUserQuery) ([]*team.TeamDTO, error) {
ctx, span := s.tracer.Start(ctx, "team.GetTeamsByUser", trace.WithAttributes(
attribute.Int64("orgID", query.OrgID),
attribute.Int64("userID", query.UserID),
))
defer span.End()
return s.store.GetByUser(ctx, query)
}
func (s *Service) GetTeamIDsByUser(ctx context.Context, query *team.GetTeamIDsByUserQuery) ([]int64, error) {
ctx, span := s.tracer.Start(ctx, "team.GetTeamIDsByUser", trace.WithAttributes(
attribute.Int64("orgID", query.OrgID),
attribute.Int64("userID", query.UserID),
))
defer span.End()
return s.store.GetIDsByUser(ctx, query)
}
func (s *Service) IsTeamMember(orgId int64, teamId int64, userId int64) (bool, error) {
func (s *Service) IsTeamMember(ctx context.Context, orgId int64, teamId int64, userId int64) (bool, error) {
_, span := s.tracer.Start(ctx, "team.IsTeamMember", trace.WithAttributes(
attribute.Int64("orgID", orgId),
attribute.Int64("teamID", teamId),
attribute.Int64("userID", userId),
))
defer span.End()
return s.store.IsMember(orgId, teamId, userId)
}
func (s *Service) RemoveUsersMemberships(ctx context.Context, userID int64) error {
ctx, span := s.tracer.Start(ctx, "team.RemoveUsersMemberships", trace.WithAttributes(
attribute.Int64("userID", userID),
))
defer span.End()
return s.store.RemoveUsersMemberships(ctx, userID)
}
func (s *Service) GetUserTeamMemberships(ctx context.Context, orgID, userID int64, external bool) ([]*team.TeamMemberDTO, error) {
ctx, span := s.tracer.Start(ctx, "team.GetUserTeamMemberships", trace.WithAttributes(
attribute.Int64("orgID", orgID),
attribute.Int64("userID", userID),
))
defer span.End()
return s.store.GetMemberships(ctx, orgID, userID, external)
}
func (s *Service) GetTeamMembers(ctx context.Context, query *team.GetTeamMembersQuery) ([]*team.TeamMemberDTO, error) {
ctx, span := s.tracer.Start(ctx, "team.GetTeamMembers", trace.WithAttributes(
attribute.Int64("orgID", query.OrgID),
attribute.Int64("teamID", query.TeamID),
attribute.String("teamUID", query.TeamUID),
))
defer span.End()
return s.store.GetMembers(ctx, query)
}