/
prometheus.go
184 lines (157 loc) · 5.68 KB
/
prometheus.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
/*
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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 trait
import (
"fmt"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
monitoringv1 "github.com/prometheus-operator/prometheus-operator/pkg/apis/monitoring/v1"
v1 "github.com/apache/camel-k/pkg/apis/camel/v1"
"github.com/apache/camel-k/pkg/util"
)
// The Prometheus trait configures a Prometheus-compatible endpoint. It also creates a `PodMonitor` resource,
// so that the endpoint can be scraped automatically, when using the Prometheus operator.
//
// The metrics are exposed using MicroProfile Metrics.
//
// WARNING: The creation of the `PodMonitor` resource requires the https://github.com/coreos/prometheus-operator[Prometheus Operator]
// custom resource definition to be installed.
// You can set `pod-monitor` to `false` for the Prometheus trait to work without the Prometheus Operator.
//
// The Prometheus trait is disabled by default.
//
// +camel-k:trait=prometheus
type prometheusTrait struct {
BaseTrait `property:",squash"`
// Whether a `PodMonitor` resource is created (default `true`).
PodMonitor *bool `property:"pod-monitor" json:"podMonitor,omitempty"`
// The `PodMonitor` resource labels, applicable when `pod-monitor` is `true`.
PodMonitorLabels []string `property:"pod-monitor-labels" json:"podMonitorLabels,omitempty"`
}
func newPrometheusTrait() Trait {
return &prometheusTrait{
BaseTrait: NewBaseTrait("prometheus", 1900),
PodMonitor: BoolP(true),
}
}
func (t *prometheusTrait) Configure(e *Environment) (bool, error) {
return IsTrue(t.Enabled) && e.IntegrationInPhase(
v1.IntegrationPhaseInitialization,
v1.IntegrationPhaseDeploying,
v1.IntegrationPhaseRunning,
), nil
}
func (t *prometheusTrait) Apply(e *Environment) (err error) {
if e.IntegrationInPhase(v1.IntegrationPhaseInitialization) {
// Add the Camel Quarkus MP Metrics extension
util.StringSliceUniqueAdd(&e.Integration.Status.Dependencies, "mvn:org.apache.camel.quarkus:camel-quarkus-microprofile-metrics")
return nil
}
container := e.getIntegrationContainer()
if container == nil {
e.Integration.Status.SetCondition(
v1.IntegrationConditionPrometheusAvailable,
corev1.ConditionFalse,
v1.IntegrationConditionContainerNotAvailableReason,
"",
)
return nil
}
condition := v1.IntegrationCondition{
Type: v1.IntegrationConditionPrometheusAvailable,
Status: corev1.ConditionTrue,
Reason: v1.IntegrationConditionPrometheusAvailableReason,
}
controller, err := e.DetermineControllerStrategy()
if err != nil {
return err
}
containerPort := e.getIntegrationContainerPort()
if containerPort == nil {
containerPort = t.getContainerPort(e, controller)
container.Ports = append(container.Ports, *containerPort)
}
condition.Message = fmt.Sprintf("%s(%d)", container.Name, containerPort.ContainerPort)
// Add the PodMonitor resource
if IsTrue(t.PodMonitor) {
portName := containerPort.Name
// Knative defaults to naming the userland container port "user-port".
// Let's rely on that default, granted it is not officially part of the Knative
// runtime contract.
// See https://github.com/knative/specs/blob/main/specs/serving/runtime-contract.md
if portName == "" && controller == ControllerStrategyKnativeService {
portName = "user-port"
}
podMonitor, err := t.getPodMonitorFor(e, portName)
if err != nil {
return err
}
e.Resources.Add(podMonitor)
condition.Message = fmt.Sprintf("PodMonitor (%s) -> ", podMonitor.Name) + condition.Message
} else {
condition.Message = "ContainerPort " + condition.Message
}
e.Integration.Status.SetConditions(condition)
return nil
}
func (t *prometheusTrait) getContainerPort(e *Environment, controller ControllerStrategy) *corev1.ContainerPort {
var name string
var port int
if t := e.Catalog.GetTrait(containerTraitID); t != nil {
name = t.(*containerTrait).PortName
port = t.(*containerTrait).Port
}
// Let's rely on Knative default HTTP negotiation
if name == "" && controller != ControllerStrategyKnativeService {
name = defaultContainerPortName
}
return &corev1.ContainerPort{
Name: name,
ContainerPort: int32(port),
Protocol: corev1.ProtocolTCP,
}
}
func (t *prometheusTrait) getPodMonitorFor(e *Environment, portName string) (*monitoringv1.PodMonitor, error) {
labels, err := keyValuePairArrayAsStringMap(t.PodMonitorLabels)
if err != nil {
return nil, err
}
labels[v1.IntegrationLabel] = e.Integration.Name
podMonitor := monitoringv1.PodMonitor{
TypeMeta: metav1.TypeMeta{
Kind: "PodMonitor",
APIVersion: monitoringv1.SchemeGroupVersion.String(),
},
ObjectMeta: metav1.ObjectMeta{
Name: e.Integration.Name,
Namespace: e.Integration.Namespace,
Labels: labels,
},
Spec: monitoringv1.PodMonitorSpec{
Selector: metav1.LabelSelector{
MatchLabels: map[string]string{
v1.IntegrationLabel: e.Integration.Name,
},
},
PodMetricsEndpoints: []monitoringv1.PodMetricsEndpoint{
{
Port: portName,
Path: "/q/metrics",
},
},
},
}
return &podMonitor, nil
}