Skip to content

Fix data race in autodiscovery kube services provider #36624

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
merged 3 commits into from
May 6, 2025
Merged

Fix data race in autodiscovery kube services provider #36624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
600997e
Fix data race in kubernetes service autodiscovery provider
xlucas May 2, 2025
d41593f
Add release note
xlucas May 5, 2025
28e6ae8
Fix unit tests
xlucas May 5, 2025
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
14 changes: 8 additions & 6 deletions comp/core/autodiscovery/providers/kube_services.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import (
"fmt"
"strings"

"go.uber.org/atomic"
v1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/labels"
listersv1 "k8s.io/client-go/listers/core/v1"
Expand All @@ -35,7 +36,7 @@ const (
// KubeServiceConfigProvider implements the ConfigProvider interface for the apiserver.
type KubeServiceConfigProvider struct {
lister listersv1.ServiceLister
upToDate bool
upToDate *atomic.Bool
configErrors map[string]ErrorMsgSet
telemetryStore *telemetry.Store
}
Expand All @@ -58,6 +59,7 @@ func NewKubeServiceConfigProvider(_ *pkgconfigsetup.ConfigurationProviders, tele
lister: servicesInformer.Lister(),
configErrors: make(map[string]ErrorMsgSet),
telemetryStore: telemetryStore,
upToDate: atomic.NewBool(false),
}

if _, err := servicesInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
Expand Down Expand Up @@ -91,7 +93,7 @@ func (k *KubeServiceConfigProvider) Collect(ctx context.Context) ([]integration.
if err != nil {
return nil, err
}
k.upToDate = true
k.upToDate.Store(true)

return k.parseServiceAnnotations(services, pkgconfigsetup.Datadog())
}
Expand All @@ -100,13 +102,13 @@ func (k *KubeServiceConfigProvider) Collect(ctx context.Context) ([]integration.
//
//nolint:revive // TODO(CINT) Fix revive linter
func (k *KubeServiceConfigProvider) IsUpToDate(ctx context.Context) (bool, error) {
return k.upToDate, nil
return k.upToDate.Load(), nil
}

func (k *KubeServiceConfigProvider) invalidate(obj interface{}) {
if obj != nil {
log.Trace("Invalidating configs on new/deleted service")
k.upToDate = false
k.upToDate.Store(false)
}
}

Expand All @@ -122,7 +124,7 @@ func (k *KubeServiceConfigProvider) invalidateIfChanged(old, obj interface{}) {
castedOld, ok := old.(*v1.Service)
if !ok {
log.Errorf("Expected a *v1.Service type, got: %T", old)
k.upToDate = false
k.upToDate.Store(false)
return
}
// Quick exit if resversion did not change
Expand All @@ -132,7 +134,7 @@ func (k *KubeServiceConfigProvider) invalidateIfChanged(old, obj interface{}) {
// Compare annotations
if valuesDiffer(castedObj.Annotations, castedOld.Annotations, kubeServiceAnnotationPrefix) {
log.Trace("Invalidating configs on service change")
k.upToDate = false
k.upToDate.Store(false)
return
}
}
Expand Down
5 changes: 4 additions & 1 deletion comp/core/autodiscovery/providers/kube_services_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"go.uber.org/atomic"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
Expand Down Expand Up @@ -247,6 +248,7 @@ func TestParseKubeServiceAnnotations(t *testing.T) {

provider := KubeServiceConfigProvider{
telemetryStore: telemetryStore,
upToDate: atomic.NewBool(false),
}
cfgs, _ := provider.parseServiceAnnotations([]*v1.Service{tc.service}, cfg)
assert.EqualValues(t, tc.expectedOut, cfgs)
Expand Down Expand Up @@ -337,7 +339,7 @@ func TestInvalidateIfChanged(t *testing.T) {
} {
t.Run("", func(t *testing.T) {
ctx := context.Background()
provider := &KubeServiceConfigProvider{upToDate: true}
provider := &KubeServiceConfigProvider{upToDate: atomic.NewBool(true)}
provider.invalidateIfChanged(tc.old, tc.obj)

upToDate, err := provider.IsUpToDate(ctx)
Expand Down Expand Up @@ -475,6 +477,7 @@ func TestGetConfigErrors_KubeServices(t *testing.T) {
lister: lister,
configErrors: test.currentErrors,
telemetryStore: telemetryStore,
upToDate: atomic.NewBool(false),
}

configs, err := provider.Collect(context.TODO())
Expand Down
11 changes: 11 additions & 0 deletions releasenotes-dca/notes/ad-data-race-kube-services-provider-8cbf74f32595c448.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Each section from every release note are combined when the
# CHANGELOG-DCA.rst is rendered. So the text needs to be worded so that
# it does not depend on any information only available in another
# section. This may mean repeating some details, but each section
# must be readable independently of the other.
#
# Each section note must be formatted as reStructuredText.
---
fixes:
- |
Fix data race in autodiscovery kube services provider.
Loading