-
Notifications
You must be signed in to change notification settings - Fork 2k
[v17] [tctl/top] Add raw metrics view #57634
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
Merged
Merged
Changes from all commits
Commits
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 hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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,104 @@ | ||
| // Teleport | ||
| // Copyright (C) 2025 Gravitational, Inc. | ||
| // | ||
| // This program is free software: you can redistribute it and/or modify | ||
| // it under the terms of the GNU Affero General Public License as published by | ||
| // the Free Software Foundation, either version 3 of the License, or | ||
| // (at your option) any later version. | ||
| // | ||
| // This program is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| // GNU Affero General Public License for more details. | ||
| // | ||
| // You should have received a copy of the GNU Affero General Public License | ||
| // along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
|
|
||
| package top | ||
|
|
||
| import "github.com/charmbracelet/bubbles/key" | ||
|
|
||
| type keyMap struct { | ||
| Quit key.Binding | ||
|
|
||
| // Movement | ||
| Right key.Binding | ||
| Left key.Binding | ||
| Up key.Binding | ||
| Down key.Binding | ||
| Filter key.Binding | ||
|
|
||
| // Tabs | ||
| Common key.Binding | ||
| Backend key.Binding | ||
| Cache key.Binding | ||
| Watcher key.Binding | ||
| Audit key.Binding | ||
| Raw key.Binding | ||
| } | ||
|
|
||
| // newDefaultKeymap returns default keybinds used by top | ||
| func newDefaultKeymap() *keyMap { | ||
| return &keyMap{ | ||
| Quit: key.NewBinding( | ||
| key.WithKeys("q", "ctrl+c"), | ||
| key.WithHelp("q", "quit"), | ||
| ), | ||
| Left: key.NewBinding( | ||
| key.WithKeys("left", "esc", "shift+tab", "h"), | ||
| key.WithHelp("←", "previous"), | ||
| ), | ||
| Right: key.NewBinding( | ||
| key.WithKeys("right", "tab", "l"), | ||
| key.WithHelp("→", "next"), | ||
| ), | ||
| Up: key.NewBinding( | ||
| key.WithKeys("up", "k"), | ||
| key.WithHelp("↑", "up"), | ||
| ), | ||
| Down: key.NewBinding( | ||
| key.WithKeys("down", "j"), | ||
| key.WithHelp("↓", "down"), | ||
| ), | ||
| Common: key.NewBinding( | ||
| key.WithKeys("1"), | ||
| key.WithHelp("1", "common"), | ||
| ), | ||
| Backend: key.NewBinding( | ||
| key.WithKeys("2"), | ||
| key.WithHelp("2", "backend"), | ||
| ), | ||
| Cache: key.NewBinding( | ||
| key.WithKeys("3"), | ||
| key.WithHelp("3", "cache"), | ||
| ), | ||
| Watcher: key.NewBinding( | ||
| key.WithKeys("4"), | ||
| key.WithHelp("4", "watcher"), | ||
| ), | ||
| Audit: key.NewBinding( | ||
| key.WithKeys("5"), | ||
| key.WithHelp("5", "audit"), | ||
| ), | ||
| Raw: key.NewBinding( | ||
| key.WithKeys("6"), | ||
| key.WithHelp("6", "raw"), | ||
| ), | ||
|
|
||
| Filter: key.NewBinding( | ||
| key.WithKeys("/"), | ||
| key.WithHelp("/", "filter"), | ||
| ), | ||
| } | ||
| } | ||
|
|
||
| func (k keyMap) ShortHelp() []key.Binding { | ||
| return []key.Binding{k.Left, k.Right, k.Quit} | ||
| } | ||
|
|
||
| func (k keyMap) FullHelp() [][]key.Binding { | ||
| return [][]key.Binding{ | ||
| {k.Left, k.Right}, | ||
| {k.Quit}, | ||
| } | ||
| } |
This file contains hidden or 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,115 @@ | ||
| // Teleport | ||
| // Copyright (C) 2025 Gravitational, Inc. | ||
| // | ||
| // This program is free software: you can redistribute it and/or modify | ||
| // it under the terms of the GNU Affero General Public License as published by | ||
| // the Free Software Foundation, either version 3 of the License, or | ||
| // (at your option) any later version. | ||
| // | ||
| // This program is distributed in the hope that it will be useful, | ||
| // but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| // GNU Affero General Public License for more details. | ||
| // | ||
| // You should have received a copy of the GNU Affero General Public License | ||
| // along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
|
|
||
| package top | ||
|
|
||
| import ( | ||
| "cmp" | ||
| "fmt" | ||
| "slices" | ||
|
|
||
| "github.com/charmbracelet/bubbles/list" | ||
| "github.com/dustin/go-humanize" | ||
| dto "github.com/prometheus/client_model/go" | ||
| ) | ||
|
|
||
| // metricItem implements [list.DefaultItem] interface to allow rendering via [list.DefaultDelegate] | ||
| type metricItem struct { | ||
| name string | ||
| value string | ||
| } | ||
|
|
||
| func (m metricItem) Title() string { return m.name } | ||
| func (m metricItem) Description() string { return m.value } | ||
| func (m metricItem) FilterValue() string { return m.name } | ||
|
|
||
| // getMetricLabelString formats prometheus labels into a readable string. | ||
| // | ||
| // Example for multiple labels: | ||
| // | ||
| // "{label_key1=\"value1\",labelkey2=\"value2\"}" | ||
| // | ||
| // Empty slice will return: | ||
| // | ||
| // "" | ||
| func getMetricLabelString(labels []*dto.LabelPair) string { | ||
| var out string | ||
|
|
||
| if len(labels) == 0 { | ||
| return "" | ||
| } | ||
|
|
||
| for i, label := range labels { | ||
| if i > 0 { | ||
| out += "," | ||
| } | ||
| out += label.GetName() + "=\"" + label.GetValue() + "\"" | ||
| } | ||
|
|
||
| return "{" + out + "}" | ||
| } | ||
|
|
||
| // metricItemFromPromMetric returns a single [list.Item] from a prometheus metric family and a single metric. | ||
| func metricItemFromPromMetric(mf *dto.MetricFamily, m *dto.Metric) list.Item { | ||
| value := "n/a" | ||
|
|
||
| switch mf.GetType() { | ||
| case dto.MetricType_COUNTER: | ||
| value = humanize.FormatFloat("", m.GetCounter().GetValue()) | ||
| case dto.MetricType_GAUGE: | ||
| value = humanize.FormatFloat("", m.GetGauge().GetValue()) | ||
| case dto.MetricType_SUMMARY: | ||
| value = fmt.Sprintf("count: %d sum: %s", | ||
| m.GetSummary().GetSampleCount(), | ||
| humanize.FormatFloat("", m.GetSummary().GetSampleSum()), | ||
| ) | ||
| case dto.MetricType_HISTOGRAM: | ||
| // List view does not allow enough space to make historgram buckets meaningful, only show sum and count. | ||
| value = fmt.Sprintf("count: %d sum: %s", | ||
| m.GetHistogram().GetSampleCount(), | ||
| humanize.FormatFloat("", m.GetHistogram().GetSampleSum()), | ||
| ) | ||
| } | ||
|
|
||
| return metricItem{ | ||
| name: mf.GetName() + getMetricLabelString(m.GetLabel()), | ||
| value: value, | ||
| } | ||
| } | ||
|
|
||
| // convertMetricsToItems converts a [metricsMsg] into a sorted slice of [list.Item] to be used in a list view. | ||
| func convertMetricsToItems(msg metricsMsg) []list.Item { | ||
|
|
||
| var itemCount int | ||
| for _, mf := range msg { | ||
| itemCount += len(mf.GetMetric()) | ||
| } | ||
|
|
||
| items := make([]list.Item, 0, itemCount) | ||
|
|
||
| for _, mf := range msg { | ||
| for _, m := range mf.GetMetric() { | ||
| items = append(items, metricItemFromPromMetric(mf, m)) | ||
| } | ||
| } | ||
|
|
||
| // Sort the item list to keep the display order consistent. | ||
| slices.SortFunc(items, func(i, j list.Item) int { | ||
| return cmp.Compare(i.FilterValue(), j.FilterValue()) | ||
| }) | ||
|
|
||
| return items | ||
| } |
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.
Uh oh!
There was an error while loading. Please reload this page.