-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
log.go
223 lines (187 loc) · 5.59 KB
/
log.go
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
/*
Copyright 2021 The Skaffold Authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package logger
import (
"context"
"io"
"sync"
"sync/atomic"
"time"
"github.com/ahmetb/dlog"
"k8s.io/apimachinery/pkg/util/wait"
"github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/docker"
"github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/docker/tracker"
"github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/graph"
logstream "github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/log/stream"
"github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/output"
"github.com/GoogleContainerTools/skaffold/v2/pkg/skaffold/output/log"
)
type Logger struct {
wg sync.WaitGroup
out io.Writer
tracker *tracker.ContainerTracker
colorPicker output.ColorPicker
client docker.LocalDaemon
hadLogsOutput sync.Map
muted int32
shouldInterruptLogs bool
// Cancel function to trigger the interruption of the threads emitting container logs.
threadLogsCancel context.CancelFunc
}
type AtomicBool struct{ flag int32 }
func (b *AtomicBool) Set(value bool) {
var i int32 = 0
if value {
i = 1
}
atomic.StoreInt32(&(b.flag), i)
}
func (b *AtomicBool) Get() bool {
return atomic.LoadInt32(&(b.flag)) != 0
}
func NewLogger(ctx context.Context, tracker *tracker.ContainerTracker, cfg docker.Config, shouldInterruptLogs bool) (*Logger, error) {
cli, err := docker.NewAPIClient(ctx, cfg)
if err != nil {
return nil, err
}
return &Logger{
tracker: tracker,
client: cli,
colorPicker: output.NewColorPicker(),
shouldInterruptLogs: shouldInterruptLogs,
threadLogsCancel: func() {},
}, nil
}
func (l *Logger) RegisterArtifacts(artifacts []graph.Artifact) {
for _, artifact := range artifacts {
l.colorPicker.AddImage(artifact.Tag)
}
}
func (l *Logger) Start(ctx context.Context, out io.Writer) error {
if l == nil {
return nil
}
l.out = out
cancel := func() {}
threadsCtx := ctx
if l.shouldInterruptLogs {
threadsCtx, cancel = context.WithCancel(ctx)
}
l.threadLogsCancel = cancel
go func() {
for {
select {
case <-ctx.Done():
return
case id := <-l.tracker.Notifier():
l.hadLogsOutput.Store(id, false)
go l.streamLogsFromContainer(threadsCtx, id)
}
}
}()
return nil
}
const (
// RetryDelay is the time to wait in between polling the status of the cloud build
RetryDelay = 1 * time.Second
// BackoffFactor is the exponent for exponential backoff during build status polling
BackoffFactor = 1.5
// BackoffSteps is the number of times we increase the backoff time during exponential backoff
BackoffSteps = 10
// RetryTimeout is the max amount of time to retry getting the status of the build before erroring
RetryTimeout = 3 * time.Minute
)
func NewStatusBackoff() *wait.Backoff {
return &wait.Backoff{
Duration: RetryDelay,
Factor: float64(BackoffFactor),
Steps: BackoffSteps,
Cap: 60 * time.Second,
}
}
func (l *Logger) streamLogsFromContainer(ctx context.Context, id string) {
tr, tw := io.Pipe()
l.wg.Add(1)
defer l.wg.Done()
go func() {
var err error
backoff := NewStatusBackoff()
if waitErr := wait.PollWithContext(ctx, backoff.Duration, RetryTimeout, func(ctx context.Context) (bool, error) {
time.Sleep(backoff.Step())
if err = l.client.ContainerLogs(ctx, tw, id); err != nil {
// Only if the error was not a ctx cancel event we want to keep doing the poll.
if ctx.Err() == nil {
return false, nil
}
}
l.hadLogsOutput.Store(id, true)
return true, nil
}); waitErr != nil {
// Don't print errors if the user interrupted the logs
// or if the logs were interrupted because of a configuration change
// TODO(nkubala)[07/23/21]: if container is lost, emit API event and attempt to reattach
// https://github.com/GoogleContainerTools/skaffold/issues/6281
if ctx.Err() != context.Canceled {
log.Entry(ctx).Warn(err)
}
}
_ = tw.Close()
}()
dr := dlog.NewReader(tr) // https://ahmet.im/blog/docker-logs-api-binary-format-explained/
formatter := NewDockerLogFormatter(l.colorPicker, l.tracker, l.IsMuted, id)
if err := logstream.StreamRequest(ctx, l.out, formatter, dr); err != nil {
log.Entry(ctx).Errorf("streaming request: %s", err)
}
}
func (l *Logger) Stop() {
if l == nil {
return
}
l.threadLogsCancel()
l.wg.Wait()
// If the logs shouldn't be interrupted, we assume we want to drain them.
if !l.shouldInterruptLogs {
l.hadLogsOutput.Range(func(key, value interface{}) bool {
if !value.(bool) {
l.streamLogsFromContainer(context.TODO(), key.(string))
}
return true
})
}
l.tracker.Reset()
}
// Mute mutes the logs.
func (l *Logger) Mute() {
if l == nil {
// Logs are not activated.
return
}
atomic.StoreInt32(&l.muted, 1)
}
// Unmute unmutes the logs.
func (l *Logger) Unmute() {
if l == nil {
// Logs are not activated.
return
}
atomic.StoreInt32(&l.muted, 0)
}
func (l *Logger) IsMuted() bool {
if l == nil {
return true
}
return atomic.LoadInt32(&l.muted) == 1
}
func (l *Logger) SetSince(time.Time) {
// we always create a new container on Deploy, so this is a noop.
}