-
Notifications
You must be signed in to change notification settings - Fork 414
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create OpenShift dashboard to visualize Collector metrics #2996
Merged
Merged
Changes from 13 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
ea3d829
Create OpenShift dashboard to visualize Collector metrics #2995
iblancasa 745a932
Merge branch 'main' into feature/2995
iblancasa cf7983f
Merge branch 'main' of github.com:open-telemetry/opentelemetry-operat…
iblancasa 3d7735d
Add documentation
iblancasa e30c416
Typo
iblancasa de4719f
Merge branch 'main' into feature/2995
iblancasa 3d285f6
Change the dashboard to be a runnable
iblancasa e4e55d5
Merge branch 'main' of github.com:open-telemetry/opentelemetry-operat…
iblancasa da01ba4
Merge branch 'feature/2995' of github.com:iblancasa/opentelemetry-ope…
iblancasa a78ec2a
Apply changes requested in code review
iblancasa c1150eb
Merge branch 'main' into feature/2995
iblancasa 8e67212
Merge branch 'main' into feature/2995
iblancasa 3d15857
Merge branch 'main' into feature/2995
iblancasa 0d302b4
Merge branch 'feature/2995' of github.com:iblancasa/opentelemetry-ope…
iblancasa 4273ba5
Change flag
iblancasa File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
iblancasa marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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 | ||
} | ||
iblancasa marked this conversation as resolved.
Show resolved
Hide resolved
|
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does it make sense to start openshift specific flags with an
--openshift-*
prefix?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's a nice idea :)