-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
ibmmq_scaler.go
232 lines (201 loc) · 7.04 KB
/
ibmmq_scaler.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
224
225
226
227
228
229
230
231
232
package scalers
import (
"bytes"
"context"
"crypto/tls"
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
"net/url"
"strconv"
"time"
v2beta2 "k8s.io/api/autoscaling/v2beta2"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/metrics/pkg/apis/external_metrics"
kedautil "github.com/kedacore/keda/v2/pkg/util"
)
// Default variables and settings
const (
ibmMqQueueDepthMetricName = "currentQueueDepth"
defaultTargetQueueDepth = 20
defaultTLSDisabled = false
)
// IBMMQScaler assigns struct data pointer to metadata variable
type IBMMQScaler struct {
metadata *IBMMQMetadata
defaultHTTPTimeout time.Duration
}
// IBMMQMetadata Metadata used by KEDA to query IBM MQ queue depth and scale
type IBMMQMetadata struct {
host string
queueManager string
queueName string
username string
password string
targetQueueDepth int
tlsDisabled bool
}
// CommandResponse Full structured response from MQ admin REST query
type CommandResponse struct {
CommandResponse []Response `json:"commandResponse"`
}
// Response The body of the response returned from the MQ admin query
type Response struct {
Parameters Parameters `json:"parameters"`
}
// Parameters Contains the current depth of the IBM MQ Queue
type Parameters struct {
Curdepth int `json:"curdepth"`
}
// NewIBMMQScaler creates a new IBM MQ scaler
func NewIBMMQScaler(config *ScalerConfig) (Scaler, error) {
meta, err := parseIBMMQMetadata(config)
if err != nil {
return nil, fmt.Errorf("error parsing IBM MQ metadata: %s", err)
}
return &IBMMQScaler{
metadata: meta,
defaultHTTPTimeout: config.GlobalHTTPTimeout,
}, nil
}
// Close closes and returns nil
func (s *IBMMQScaler) Close() error {
return nil
}
// parseIBMMQMetadata checks the existence of and validates the MQ connection data provided
func parseIBMMQMetadata(config *ScalerConfig) (*IBMMQMetadata, error) {
meta := IBMMQMetadata{}
if val, ok := config.TriggerMetadata["host"]; ok {
_, err := url.ParseRequestURI(val)
if err != nil {
return nil, fmt.Errorf("invalid URL: %s", err)
}
meta.host = val
} else {
return nil, fmt.Errorf("no host URI given")
}
if val, ok := config.TriggerMetadata["queueManager"]; ok {
meta.queueManager = val
} else {
return nil, fmt.Errorf("no queue manager given")
}
if val, ok := config.TriggerMetadata["queueName"]; ok {
meta.queueName = val
} else {
return nil, fmt.Errorf("no queue name given")
}
if val, ok := config.TriggerMetadata["queueDepth"]; ok && val != "" {
queueDepth, err := strconv.Atoi(val)
if err != nil {
return nil, fmt.Errorf("invalid targetQueueDepth - must be an integer")
}
meta.targetQueueDepth = queueDepth
} else {
fmt.Println("No target depth defined - setting default")
meta.targetQueueDepth = defaultTargetQueueDepth
}
if val, ok := config.TriggerMetadata["tls"]; ok {
tlsDisabled, err := strconv.ParseBool(val)
if err != nil {
return nil, fmt.Errorf("invalid tls setting: %s", err)
}
meta.tlsDisabled = tlsDisabled
} else {
fmt.Println("No tls setting defined - setting default")
meta.tlsDisabled = defaultTLSDisabled
}
val, ok := config.AuthParams["username"]
switch {
case ok && val != "":
meta.username = val
case config.TriggerMetadata["usernameFromEnv"] != "":
meta.username = config.ResolvedEnv[config.TriggerMetadata["usernameFromEnv"]]
default:
return nil, fmt.Errorf("no username given")
}
value, booleanValue := config.AuthParams["password"] // booleanValue reports whether the type assertion succeeded or not
switch {
case booleanValue && value != "":
meta.password = val
case config.TriggerMetadata["passwordFromEnv"] != "":
meta.password = config.ResolvedEnv[config.TriggerMetadata["passwordFromEnv"]]
default:
return nil, fmt.Errorf("no password given")
}
return &meta, nil
}
// IsActive returns true if there are messages to be processed/if we need to scale from zero
func (s *IBMMQScaler) IsActive(ctx context.Context) (bool, error) {
queueDepth, err := s.getQueueDepthViaHTTP()
if err != nil {
return false, fmt.Errorf("error inspecting IBM MQ queue depth: %s", err)
}
return queueDepth > 0, nil
}
// getQueueDepthViaHTTP returns the depth of the MQ Queue from the Admin endpoint
func (s *IBMMQScaler) getQueueDepthViaHTTP() (int, error) {
queue := s.metadata.queueName
url := s.metadata.host
var requestJSON = []byte(`{"type": "runCommandJSON", "command": "display", "qualifier": "qlocal", "name": "` + queue + `", "responseParameters" : ["CURDEPTH"]}`)
req, err := http.NewRequest("POST", url, bytes.NewBuffer(requestJSON))
if err != nil {
return 0, fmt.Errorf("failed to request queue depth: %s", err)
}
req.Header.Set("ibm-mq-rest-csrf-token", "value")
req.Header.Set("Content-Type", "application/json")
req.SetBasicAuth(s.metadata.username, s.metadata.password)
tr := &http.Transport{
TLSClientConfig: &tls.Config{InsecureSkipVerify: s.metadata.tlsDisabled},
}
client := kedautil.CreateHTTPClient(s.defaultHTTPTimeout)
client.Transport = tr
resp, err := client.Do(req)
if err != nil {
return 0, fmt.Errorf("failed to contact MQ via REST: %s", err)
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
return 0, fmt.Errorf("failed to ready body of request: %s", err)
}
var response CommandResponse
err = json.Unmarshal(body, &response)
if err != nil {
return 0, fmt.Errorf("failed to parse JSON: %s", err)
}
if response.CommandResponse == nil || len(response.CommandResponse) == 0 {
return 0, fmt.Errorf("failed to parse response from REST call: %s", err)
}
return response.CommandResponse[0].Parameters.Curdepth, nil
}
// GetMetricSpecForScaling returns the MetricSpec for the Horizontal Pod Autoscaler
func (s *IBMMQScaler) GetMetricSpecForScaling() []v2beta2.MetricSpec {
targetQueueLengthQty := resource.NewQuantity(int64(s.metadata.targetQueueDepth), resource.DecimalSI)
externalMetric := &v2beta2.ExternalMetricSource{
Metric: v2beta2.MetricIdentifier{
Name: kedautil.NormalizeString(fmt.Sprintf("%s-%s-%s", "IBMMQ", s.metadata.queueManager, s.metadata.queueName)),
},
Target: v2beta2.MetricTarget{
Type: v2beta2.AverageValueMetricType,
AverageValue: targetQueueLengthQty,
},
}
metricSpec := v2beta2.MetricSpec{External: externalMetric, Type: externalMetricType}
return []v2beta2.MetricSpec{metricSpec}
}
// GetMetrics returns value for a supported metric and an error if there is a problem getting the metric
func (s *IBMMQScaler) GetMetrics(ctx context.Context, metricName string, metricSelector labels.Selector) ([]external_metrics.ExternalMetricValue, error) {
queueDepth, err := s.getQueueDepthViaHTTP()
if err != nil {
return []external_metrics.ExternalMetricValue{}, fmt.Errorf("error inspecting IBM MQ queue depth: %s", err)
}
metric := external_metrics.ExternalMetricValue{
MetricName: ibmMqQueueDepthMetricName,
Value: *resource.NewQuantity(int64(queueDepth), resource.DecimalSI),
Timestamp: metav1.Now(),
}
return append([]external_metrics.ExternalMetricValue{}, metric), nil
}