1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
// Unless explicitly stated otherwise all files in this repository are licensed
// under the Apache License Version 2.0.
// This product includes software developed at Datadog (https://www.datadoghq.com/).
// Copyright 2024 Datadog, Inc.
package integrations
import (
"os"
"os/signal"
"regexp"
"strings"
"sync"
"syscall"
"ci-visibility-test-github/main/civisibility/constants"
"ci-visibility-test-github/main/civisibility/utils"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/mocktracer"
"gopkg.in/DataDog/dd-trace-go.v1/ddtrace/tracer"
)
// ciVisibilityCloseAction defines an action to be executed when CI visibility is closing.
type ciVisibilityCloseAction func()
var (
// ciVisibilityInitializationOnce ensures we initialize the CI visibility tracer only once.
ciVisibilityInitializationOnce sync.Once
// closeActions holds CI visibility close actions.
closeActions []ciVisibilityCloseAction
// closeActionsMutex synchronizes access to closeActions.
closeActionsMutex sync.Mutex
// mTracer contains the mock tracer instance for testing purposes
mTracer mocktracer.Tracer
)
// EnsureCiVisibilityInitialization initializes the CI visibility tracer if it hasn't been initialized already.
func EnsureCiVisibilityInitialization() {
internalCiVisibilityInitialization(func(opts []tracer.StartOption) {
// Initialize the tracer.
tracer.Start(opts...)
})
}
// InitializeCIVisibilityMock initialize the mocktracer for CI Visibility usage
func InitializeCIVisibilityMock() mocktracer.Tracer {
internalCiVisibilityInitialization(func([]tracer.StartOption) {
// Initialize the mocktracer
mTracer = mocktracer.Start()
})
return mTracer
}
func internalCiVisibilityInitialization(tracerInitializer func([]tracer.StartOption)) {
ciVisibilityInitializationOnce.Do(func() {
// Since calling this method indicates we are in CI Visibility mode, set the environment variable.
_ = os.Setenv(constants.CIVisibilityEnabledEnvironmentVariable, "1")
// Avoid sampling rate warning (in CI Visibility mode we send all data)
_ = os.Setenv("DD_TRACE_SAMPLE_RATE", "1")
// Preload the CodeOwner file
_ = utils.GetCodeOwners()
// Preload all CI, Git, and CodeOwners tags.
ciTags := utils.GetCITags()
// Check if DD_SERVICE has been set; otherwise default to the repo name (from the spec).
var opts []tracer.StartOption
if v := os.Getenv("DD_SERVICE"); v == "" {
if repoURL, ok := ciTags[constants.GitRepositoryURL]; ok {
// regex to sanitize the repository url to be used as a service name
repoRegex := regexp.MustCompile(`(?m)/([a-zA-Z0-9\\\-_.]*)$`)
matches := repoRegex.FindStringSubmatch(repoURL)
if len(matches) > 1 {
repoURL = strings.TrimSuffix(matches[1], ".git")
}
opts = append(opts, tracer.WithService(repoURL))
}
}
// Initialize the tracer
tracerInitializer(opts)
// Handle SIGINT and SIGTERM signals to ensure we close all open spans and flush the tracer before exiting
signals := make(chan os.Signal, 1)
signal.Notify(signals, syscall.SIGINT, syscall.SIGTERM)
go func() {
<-signals
ExitCiVisibility()
os.Exit(1)
}()
})
}
// PushCiVisibilityCloseAction adds a close action to be executed when CI visibility exits.
func PushCiVisibilityCloseAction(action ciVisibilityCloseAction) {
closeActionsMutex.Lock()
defer closeActionsMutex.Unlock()
closeActions = append([]ciVisibilityCloseAction{action}, closeActions...)
}
// ExitCiVisibility executes all registered close actions and stops the tracer.
func ExitCiVisibility() {
closeActionsMutex.Lock()
defer closeActionsMutex.Unlock()
defer func() {
closeActions = []ciVisibilityCloseAction{}
tracer.Flush()
tracer.Stop()
}()
for _, v := range closeActions {
v()
}
}
|
