Create OpenShift dashboard to visualize Collector metrics (open-telemetry#2996)

* Create OpenShift dashboard to visualize Collector metrics open-telemetry#2995

Signed-off-by: Israel Blancas <iblancasa@gmail.com>

* Add documentation

Signed-off-by: Israel Blancas <iblancasa@gmail.com>

* Typo

Signed-off-by: Israel Blancas <iblancasa@gmail.com>

* Change the dashboard to be a runnable

Signed-off-by: Israel Blancas <iblancasa@gmail.com>

* Apply changes requested in code review

Signed-off-by: Israel Blancas <iblancasa@gmail.com>

* Change flag

Signed-off-by: Israel Blancas <iblancasa@gmail.com>

---------

Signed-off-by: Israel Blancas <iblancasa@gmail.com>

Author: iblancasa

.chloggen/2995-openshift-dashboard.yaml

@@ -0,0 +1,16 @@
+# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix'
+change_type: enhancement
+
+# The name of the component, or a single word describing the area of concern, (e.g. collector, target allocator, auto-instrumentation, opamp, github action)
+component: collector
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Create automatically an OpenShift dashboard to visualize OpenTelemetry Collector metrics
+
+# One or more tracking issues related to the change
+issues: [2995]
+
+# (Optional) One or more lines of additional information to render under the primary note.
+# These lines will be padded with 2 spaces and then inserted directly into the document.
+# Use pipe (|) for multiline entries.
+subtext: To enable this feature, you need to specify the `--openshift-create-dashboard` argument to the operator

internal/openshift/dashboards/dashboards.go

@@ -0,0 +1,74 @@
+// Copyright The OpenTelemetry Authors
+//
+// 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.
+
+package openshift
+
+import (
+	"context"
+	_ "embed"
+
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/client-go/kubernetes"
+)
+
+// The dashboard is created manually following the syntax from Grafana 5. For development purposes, this dashboard can be created just by loading the JSON file
+// in a ConfigMap from the openshift-config-managed and adding the console.openshift.io/dashboard=true label.
+//
+//go:embed metrics-dashboard.json
+var dashboardContent string
+
+const (
+	openshiftDashboardsNamespace = "openshift-config-managed"
+	configMapName                = "opentelemetry-collector"
+)
+
+type DashboardManagement struct {
+	clientset kubernetes.Interface
+}
+
+func NewDashboardManagement(clientset kubernetes.Interface) DashboardManagement {
+	return DashboardManagement{
+		clientset: clientset,
+	}
+}
+
+func (d DashboardManagement) Start(ctx context.Context) error {
+	cm := corev1.ConfigMap{
+		ObjectMeta: v1.ObjectMeta{
+			Name:      configMapName,
+			Namespace: openshiftDashboardsNamespace,
+			Labels: map[string]string{
+				"console.openshift.io/dashboard": "true",
+			},
+		},
+		Data: map[string]string{
+			"otel.json": dashboardContent,
+		},
+	}
+
+	_, err := d.clientset.CoreV1().ConfigMaps(openshiftDashboardsNamespace).Create(ctx, &cm, metav1.CreateOptions{})
+	if err != nil {
+		return nil
+	}
+
+	<-ctx.Done()
+
+	return d.clientset.CoreV1().ConfigMaps(openshiftDashboardsNamespace).Delete(ctx, configMapName, metav1.DeleteOptions{})
+}
+
+func (d DashboardManagement) NeedLeaderElection() bool {
+	return true
+}

internal/openshift/dashboards/metrics-dashboard.json

@@ -54,6 +54,7 @@ import (
 	"github.com/open-telemetry/opentelemetry-operator/internal/autodetect/openshift"
 	"github.com/open-telemetry/opentelemetry-operator/internal/autodetect/prometheus"
 	"github.com/open-telemetry/opentelemetry-operator/internal/config"
+	openshiftDashboards "github.com/open-telemetry/opentelemetry-operator/internal/openshift/dashboards"
 	"github.com/open-telemetry/opentelemetry-operator/internal/rbac"
 	"github.com/open-telemetry/opentelemetry-operator/internal/version"
 	"github.com/open-telemetry/opentelemetry-operator/internal/webhook/podmutation"
@@ -111,6 +112,7 @@ func main() {
 		pprofAddr                        string
 		enableLeaderElection             bool
 		createRBACPermissions            bool
+		createOpenShiftDashboard         bool
 		enableMultiInstrumentation       bool
 		enableApacheHttpdInstrumentation bool
 		enableDotNetInstrumentation      bool
@@ -147,6 +149,7 @@ func main() {
 		"Enable leader election for controller manager. "+
 			"Enabling this will ensure there is only one active controller manager.")
 	pflag.BoolVar(&createRBACPermissions, "create-rbac-permissions", false, "Automatically create RBAC permissions needed by the processors (deprecated)")
+	pflag.BoolVar(&createOpenShiftDashboard, "openshift-create-dashboard", false, "Create an OpenShift dashboard for monitoring the OpenTelemetryCollector instances")
 	pflag.BoolVar(&enableMultiInstrumentation, "enable-multi-instrumentation", false, "Controls whether the operator supports multi instrumentation")
 	pflag.BoolVar(&enableApacheHttpdInstrumentation, constants.FlagApacheHttpd, true, "Controls whether the operator supports Apache HTTPD auto-instrumentation")
 	pflag.BoolVar(&enableDotNetInstrumentation, constants.FlagDotNet, true, "Controls whether the operator supports dotnet auto-instrumentation")
@@ -215,6 +218,7 @@ func main() {
 		"enable-nginx-instrumentation", enableNginxInstrumentation,
 		"enable-nodejs-instrumentation", enableNodeJSInstrumentation,
 		"enable-java-instrumentation", enableJavaInstrumentation,
+		"create-openshift-dashboard", createOpenShiftDashboard,
 		"zap-message-key", encodeMessageKey,
 		"zap-level-key", encodeLevelKey,
 		"zap-time-key", encodeTimeKey,
@@ -277,9 +281,17 @@ func main() {
 		setupLog.Error(clientErr, "failed to create kubernetes clientset")
 	}
 
-	reviewer := rbac.NewReviewer(clientset)
 	ctx := ctrl.SetupSignalHandler()
 
+	if createOpenShiftDashboard {
+		dashErr := mgr.Add(openshiftDashboards.NewDashboardManagement(clientset))
+		if dashErr != nil {
+			setupLog.Error(dashErr, "failed to create the OpenShift dashboards")
+		}
+	}
+
+	reviewer := rbac.NewReviewer(clientset)
+
 	// builds the operator's configuration
 	ad, err := autodetect.New(restConfig, reviewer)
 	if err != nil {