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
|
// -
// ========================LICENSE_START=================================
// Copyright (C) 2024: Deutsche Telekom
//
// 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.
// SPDX-License-Identifier: Apache-2.0
// ========================LICENSE_END===================================
// The publisher package is responsible for managing periodic heartbeat messages for the
// Open Policy Agent (OPA) Policy Decision Point (PDP) and publishing the PDP's status to relevant channels.
// It provides functions to initialize, manage, and stop timers for sending heartbeat messages,
// ensuring the PDP communicates its health and state periodically.
package publisher
import (
"fmt"
"policy-opa-pdp/consts"
"policy-opa-pdp/pkg/log"
"policy-opa-pdp/pkg/model"
"policy-opa-pdp/pkg/pdpattributes"
"policy-opa-pdp/pkg/pdpstate"
"time"
"github.com/google/uuid"
)
var (
ticker *time.Ticker
stopChan chan bool
currentInterval int64
)
// Initializes a timer that sends periodic heartbeat messages to indicate the health and state of the PDP.
func StartHeartbeatIntervalTimer(intervalMs int64, s PdpStatusSender) {
if intervalMs <= 0 {
log.Errorf("Invalid interval provided: %d. Interval must be greater than zero.", intervalMs)
ticker = nil
return
}
if ticker != nil && intervalMs == currentInterval {
log.Debug("Ticker is already running")
return
}
if ticker != nil {
ticker.Stop()
}
// StopTicker()
currentInterval = intervalMs
ticker = time.NewTicker(time.Duration(intervalMs) * time.Millisecond)
log.Debugf("New Ticker %d", currentInterval)
stopChan = make(chan bool)
go func() {
for {
select {
case <-ticker.C:
sendPDPHeartBeat(s)
case <-stopChan:
ticker.Stop()
return
}
}
}()
}
// Creates and sends a heartbeat message with the PDP's current state, health, and attributes
func sendPDPHeartBeat(s PdpStatusSender) error {
pdpStatus := model.PdpStatus{
MessageType: model.PDP_STATUS,
PdpType: consts.PdpType,
State: pdpstate.GetState(),
Healthy: model.Healthy,
Name: pdpattributes.PdpName,
Description: "Pdp heartbeat",
PdpGroup: consts.PdpGroup,
PdpSubgroup: &pdpattributes.PdpSubgroup,
}
pdpStatus.RequestID = uuid.New().String()
pdpStatus.TimestampMs = fmt.Sprintf("%d", time.Now().UnixMilli())
err := s.SendPdpStatus(pdpStatus)
log.Debugf("Sending Heartbeat ...")
if err != nil {
log.Warnf("Error producing message: %v\n", err)
return err
} else {
return nil
}
}
// Stops the running ticker and terminates the goroutine managing heartbeat messages.
func StopTicker() {
if ticker != nil && stopChan != nil {
stopChan <- true
close(stopChan)
ticker = nil
} else {
log.Debugf("Ticker is not Running")
}
}
|
