-
Notifications
You must be signed in to change notification settings - Fork 13
/
statusupdate.go
212 lines (182 loc) · 6.46 KB
/
statusupdate.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
package agent
import (
"context"
"sync"
"time"
"github.com/Axway/agent-sdk/pkg/jobs"
"github.com/Axway/agent-sdk/pkg/util/errors"
hc "github.com/Axway/agent-sdk/pkg/util/healthcheck"
"github.com/Axway/agent-sdk/pkg/util/log"
"github.com/google/uuid"
)
const (
periodic = "periodic status change"
immediate = "immediate status change"
)
// This type is used for values added to context
type ctxKey int
// The key used for the logger in the context
const (
ctxLogger ctxKey = iota
)
var previousStatus string // The global previous status to be used by both update jobs
var previousStatusDetail string
var updateStatusMutex *sync.Mutex
func init() {
updateStatusMutex = &sync.Mutex{}
}
type agentStatusUpdate struct {
jobs.Job
previousActivityTime time.Time
currentActivityTime time.Time
immediateStatusChange bool
typeOfStatusUpdate string
logger log.FieldLogger
}
var periodicStatusUpdate *agentStatusUpdate
var immediateStatusUpdate *agentStatusUpdate
func (su *agentStatusUpdate) Ready() bool {
ctx := context.WithValue(context.Background(), ctxLogger, su.logger)
// Do not start until status will be running
status, _ := su.getCombinedStatus(ctx)
if status != AgentRunning && su.immediateStatusChange {
return false
}
su.logger.Trace("Periodic status update is ready")
su.currentActivityTime = time.Now()
su.previousActivityTime = su.currentActivityTime
return true
}
func (su *agentStatusUpdate) Status() error {
return nil
}
func (su *agentStatusUpdate) Execute() error {
id, _ := uuid.NewUUID()
log := su.logger.WithField("status-update-id", id)
ctx := context.WithValue(context.Background(), ctxLogger, log)
// only one status update should execute at a time
log.Tracef("get status update lock %s", su.typeOfStatusUpdate)
updateStatusMutex.Lock()
defer func() {
log.Tracef("return status update lock %s", su.typeOfStatusUpdate)
updateStatusMutex.Unlock()
}()
// get the status from the health check and jobs
status, statusDetail := su.getCombinedStatus(ctx)
log.Tracef("Type of agent status update being checked : %s ", su.typeOfStatusUpdate)
if su.typeOfStatusUpdate == periodic {
// always update on the periodic status update, even if the status has not changed
log.
WithField("previous-status", previousStatus).
WithField("previous-status-detail", previousStatusDetail).
WithField("new-status", status).
WithField("new-status-detail", statusDetail).
Debugf("%s -- Last activity updated", su.typeOfStatusUpdate)
UpdateStatusWithContext(ctx, status, previousStatus, statusDetail)
su.previousActivityTime = su.currentActivityTime
} else if previousStatus != status || previousStatusDetail != statusDetail {
// if the status has changed then report that on the immediate check
log.
WithField("previous-status", previousStatus).
WithField("previous-status-detail", previousStatusDetail).
WithField("new-status", status).
WithField("new-status-detail", statusDetail).
Debug("status is changing")
UpdateStatusWithContext(ctx, status, previousStatus, statusDetail)
su.previousActivityTime = su.currentActivityTime
}
previousStatus = status
previousStatusDetail = statusDetail
return nil
}
// StartAgentStatusUpdate - starts 2 separate jobs that runs the periodic status updates and immediate status updates
func StartAgentStatusUpdate() {
logger := log.NewFieldLogger().
WithPackage("sdk.agent").
WithComponent("agentStatusUpdate")
if err := runStatusUpdateCheck(); err != nil {
logger.WithError(err).Error("not starting status update jobs")
return
}
startPeriodicStatusUpdate(logger)
startImmediateStatusUpdate(logger)
}
// startPeriodicStatusUpdate - start periodic status updates based on report activity frequency config
func startPeriodicStatusUpdate(logger log.FieldLogger) {
interval := agent.cfg.GetReportActivityFrequency()
periodicStatusUpdate = &agentStatusUpdate{
typeOfStatusUpdate: periodic,
logger: logger.WithField("status-check", periodic),
}
_, err := jobs.RegisterIntervalJobWithName(periodicStatusUpdate, interval, "Status Update")
if err != nil {
logger.Error(errors.ErrStartingAgentStatusUpdate.FormatError(periodic))
}
}
// startImmediateStatusUpdate - start job that will 'immediately' update status. NOTE : By 'immediately', this means currently 10 seconds.
// The time interval for this job is hard coded.
func startImmediateStatusUpdate(logger log.FieldLogger) {
interval := 10 * time.Second
immediateStatusUpdate = &agentStatusUpdate{
immediateStatusChange: true,
typeOfStatusUpdate: immediate,
logger: logger.WithField("status-check", immediate),
}
_, err := jobs.RegisterDetachedIntervalJobWithName(immediateStatusUpdate, interval, "Immediate Status Update")
if err != nil {
logger.Error(errors.ErrStartingAgentStatusUpdate.FormatError(immediate))
}
}
func (su *agentStatusUpdate) getCombinedStatus(ctx context.Context) (string, string) {
log := ctx.Value(ctxLogger).(log.FieldLogger)
status := su.getJobPoolStatus(ctx)
statusDetail := ""
if status != AgentRunning {
statusDetail = "agent job pool not running"
}
hcStatus, hcStatusDetail := su.getHealthcheckStatus(ctx)
if hcStatus != AgentRunning {
log.
WithField("pool-status", status).
WithField("healthcheck-status", hcStatus).
WithField("healthcheck-status-detail", hcStatusDetail).
Info("agent not in running status")
status = hcStatus
statusDetail = hcStatusDetail
}
return status, statusDetail
}
// getJobPoolStatus
func (su *agentStatusUpdate) getJobPoolStatus(ctx context.Context) string {
log := ctx.Value(ctxLogger).(log.FieldLogger)
status := jobs.GetStatus()
log.
WithField("status", status).
Trace("global job pool status")
// update the status only if not running
if status == jobs.PoolStatusStopped.String() {
return AgentUnhealthy
}
return AgentRunning
}
// getHealthcheckStatus
func (su *agentStatusUpdate) getHealthcheckStatus(ctx context.Context) (string, string) {
log := ctx.Value(ctxLogger).(log.FieldLogger)
hcStatus, hcStatusDetail := hc.GetGlobalStatus()
log.
WithField("status", hcStatus).
WithField("detail", hcStatusDetail).
Trace("global healthcheck status")
// update the status only if not running
if hcStatus == string(hc.FAIL) {
return AgentUnhealthy, hcStatusDetail
}
return AgentRunning, ""
}
// runStatusUpdateCheck - returns an error if agent name is blank
func runStatusUpdateCheck() error {
if agent.cfg.GetAgentName() == "" {
return errors.ErrStartingAgentStatusUpdate.FormatError(periodic)
}
return nil
}