Skip to content

Commit

Permalink
Create OpenShift dashboard to visualize Collector metrics #2995
Browse files Browse the repository at this point in the history
Signed-off-by: Israel Blancas <iblancasa@gmail.com>
  • Loading branch information
iblancasa committed Jul 4, 2024
1 parent 3fc9f8a commit ea3d829
Show file tree
Hide file tree
Showing 4 changed files with 1,268 additions and 1 deletion.
16 changes: 16 additions & 0 deletions .chloggen/2995-openshift-dashboard.yaml
Original file line number Diff line number Diff line change
@@ -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 `--create-openshift-dashboard` argument to the operator
59 changes: 59 additions & 0 deletions internal/openshift/dashboards/dashboards.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
// 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"

"github.com/go-logr/logr"
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"
)

//go:embed metrics-dashboard.json
var dashboardContent string

const (
openshiftDashboardsNamespace = "openshift-config-managed"
configMapName = "opentelemetry-collector"
)

func CreateOpenShiftDashboard(clientset kubernetes.Interface) 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 := clientset.CoreV1().ConfigMaps(openshiftDashboardsNamespace).Create(context.TODO(), &cm, metav1.CreateOptions{})
return err
}

func DeleteOpenShiftDashboard(clientset kubernetes.Interface, logger logr.Logger) {
err := clientset.CoreV1().ConfigMaps(openshiftDashboardsNamespace).Delete(context.TODO(), configMapName, metav1.DeleteOptions{})
if err != nil {
logger.Error(err, "it was not possible to remove the dashboards configmap", "name", configMapName, "namespace", openshiftDashboardsNamespace)
}
}
Loading

0 comments on commit ea3d829

Please sign in to comment.