Merge pull request #11 from ucloud/feature/exporter

support redis exporter

Author: polefishu

go.mod

@@ -37,3 +37,5 @@ replace (
 	// resolve it correctly.
 	github.com/prometheus/prometheus => github.com/prometheus/prometheus v0.0.0-20190525122359-d20e84d0fb64
 )
+
+go 1.13

pkg/apis/redis/v1alpha1/constants.go

@@ -71,4 +71,7 @@ const (
 
 	JobTypeBackup  = "backup"
 	JobTypeRestore = "restore"
+
+	PrometheusExporterPortNumber    = 9100
+	PrometheusExporterTelemetryPath = "/metrics"
 )

pkg/apis/redis/v1alpha1/default.go

@@ -36,6 +36,23 @@ func (in *DistributedRedisCluster) Validate() {
 	if in.Spec.Resources == nil || in.Spec.Resources.Size() == 0 {
 		in.Spec.Resources = defaultResource()
 	}
+
+	mon := in.Spec.Monitor
+	if mon != nil {
+		if mon.Prometheus == nil {
+			mon.Prometheus = &PrometheusSpec{}
+		}
+		if mon.Prometheus.Port == 0 {
+			mon.Prometheus.Port = PrometheusExporterPortNumber
+		}
+		if in.Spec.Annotations == nil {
+			in.Spec.Annotations = make(map[string]string)
+		}
+
+		in.Spec.Annotations["prometheus.io/scrape"] = "true"
+		in.Spec.Annotations["prometheus.io/path"] = PrometheusExporterTelemetryPath
+		in.Spec.Annotations["prometheus.io/port"] = fmt.Sprintf("%d", mon.Prometheus.Port)
+	}
 }
 
 func defaultResource() *v1.ResourceRequirements {

pkg/apis/redis/v1alpha1/distributedrediscluster_types.go

@@ -29,6 +29,53 @@ type DistributedRedisClusterSpec struct {
 	Storage         *RedisStorage                `json:"storage,omitempty"`
 	Resources       *corev1.ResourceRequirements `json:"resources,omitempty"`
 	PasswordSecret  *corev1.LocalObjectReference `json:"rootPasswordSecret,omitempty"`
+	Monitor         *AgentSpec                   `json:"monitor,omitempty"`
+}
+
+type AgentSpec struct {
+	Image      string          `json:"image,omitempty"`
+	Prometheus *PrometheusSpec `json:"prometheus,omitempty"`
+	// Arguments to the entrypoint.
+	// The docker image's CMD is used if this is not provided.
+	// Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
+	// cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax
+	// can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,
+	// regardless of whether the variable exists or not.
+	// Cannot be updated.
+	// More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
+	// +optional
+	Args []string `json:"args,omitempty"`
+	// List of environment variables to set in the container.
+	// Cannot be updated.
+	// +optional
+	// +patchMergeKey=name
+	// +patchStrategy=merge
+	Env []corev1.EnvVar `json:"env,omitempty" patchStrategy:"merge" patchMergeKey:"name"`
+	// Compute Resources required by exporter container.
+	// Cannot be updated.
+	// More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
+	// +optional
+	Resources corev1.ResourceRequirements `json:"resources,omitempty"`
+	// Security options the pod should run with.
+	// More info: https://kubernetes.io/docs/concepts/policy/security-context/
+	// More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
+	// +optional
+	SecurityContext *corev1.SecurityContext `json:"securityContext,omitempty"`
+}
+
+type PrometheusSpec struct {
+	// Port number for the exporter side car.
+	Port int32 `json:"port,omitempty"`
+
+	// Namespace of Prometheus. Service monitors will be created in this namespace.
+	Namespace string `json:"namespace,omitempty"`
+	// Labels are key value pairs that is used to select Prometheus instance via ServiceMonitor labels.
+	// +optional
+	Labels map[string]string `json:"labels,omitempty"`
+
+	// Interval at which metrics should be scraped
+	Interval    string            `json:"interval,omitempty"`
+	//Annotations map[string]string `json:"annotations,omitempty"`
 }
 
 // RedisStorage defines the structure used to store the Redis Data

pkg/resources/statefulsets/statefulset.go

@@ -49,7 +49,8 @@ func NewStatefulSetForCR(cluster *redisv1alpha1.DistributedRedisCluster, labels
 			},
 			Template: corev1.PodTemplateSpec{
 				ObjectMeta: metav1.ObjectMeta{
-					Labels: labels,
+					Labels:      labels,
+					Annotations: cluster.Spec.Annotations,
 				},
 				Spec: corev1.PodSpec{
 					Affinity:        getAffinity(spec.Affinity, labels),
@@ -74,6 +75,9 @@ func NewStatefulSetForCR(cluster *redisv1alpha1.DistributedRedisCluster, labels
 			ss.Spec.VolumeClaimTemplates[0].OwnerReferences = redisv1alpha1.DefaultOwnerReferences(cluster)
 		}
 	}
+	if spec.Monitor != nil {
+		ss.Spec.Template.Spec.Containers = append(ss.Spec.Template.Spec.Containers, redisExporterContainer(cluster, password))
+	}
 	return ss
 }
 
@@ -215,6 +219,32 @@ func redisServerContainer(cluster *redisv1alpha1.DistributedRedisCluster, passwo
 	return container
 }
 
+func redisExporterContainer(cluster *redisv1alpha1.DistributedRedisCluster, password *corev1.EnvVar) corev1.Container {
+	container := corev1.Container{
+		Name: "exporter",
+		Args: append([]string{
+			fmt.Sprintf("--web.listen-address=:%v", cluster.Spec.Monitor.Prometheus.Port),
+			fmt.Sprintf("--web.telemetry-path=%v", redisv1alpha1.PrometheusExporterTelemetryPath),
+		}, cluster.Spec.Monitor.Args...),
+		Image:           cluster.Spec.Monitor.Image,
+		ImagePullPolicy: corev1.PullIfNotPresent,
+		Ports: []corev1.ContainerPort{
+			{
+				Name:          "prom-http",
+				Protocol:      corev1.ProtocolTCP,
+				ContainerPort: cluster.Spec.Monitor.Prometheus.Port,
+			},
+		},
+		Env:             cluster.Spec.Monitor.Env,
+		Resources:       cluster.Spec.Monitor.Resources,
+		SecurityContext: cluster.Spec.Monitor.SecurityContext,
+	}
+	if password != nil {
+		container.Env = append(container.Env, *password)
+	}
+	return container
+}
+
 func volumeMounts() []corev1.VolumeMount {
 	return []corev1.VolumeMount{
 		{