Skip to content

Shorter menu labels for telemetry tables #322

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.

Sign up for GitHub

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
harp-intel merged 2 commits into from
Apr 28, 2025
Merged

Shorter menu labels for telemetry tables #322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd770ff
shorter menu labels for telemetry tables
harp-intel Apr 28, 2025
334f07b
remove unneeded code
harp-intel Apr 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions internal/common/common.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,12 +340,6 @@ func (rc *ReportingCommand) createReports(appContext AppContext, orderedTargetSc
}
// special case - the summary table is built from the post-processed data, i.e., table values
if rc.SummaryFunc != nil {
// override the menu label for the System Summary table to avoid conflict with performance summary table added below
for i, tv := range allTableValues {
if tv.Name == report.SystemSummaryTableName {
allTableValues[i].MenuLabel = "System Summary"
}
}
summaryTableValues := rc.SummaryFunc(allTableValues, targetScriptOutputs.scriptOutputs)
allTableValues = append(allTableValues, summaryTableValues)
}
Expand Down
49 changes: 34 additions & 15 deletions internal/report/table_defs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,6 @@ const (
SystemEventLogTableName = "System Event Log"
KernelLogTableName = "Kernel Log"
SystemSummaryTableName = "System Summary"
BriefSysSummaryTableName = "Brief System Summary"
// benchmark table names
SpeedBenchmarkTableName = "Speed Benchmark"
PowerBenchmarkTableName = "Power Benchmark"
Expand All @@ -133,6 +132,23 @@ const (
CodePathFrequencyTableName = "Code Path Frequency"
// lock table names
KernelLockAnalysisTableName = "Kernel Lock Analysis"
// common table names
BriefSysSummaryTableName = "Brief System Summary"
)

// menu labels
const (
// telemetry table menu labels
CPUUtilizationTelemetryMenuLabel = "CPU Utilization"
UtilizationCategoriesTelemetryMenuLabel = "Utilization Categories"
AverageFrequencyTelemetryMenuLabel = "Average Frequency"
IRQRateTelemetryMenuLabel = "IRQ Rate"
InstructionTelemetryMenuLabel = "Instruction"
DriveTelemetryMenuLabel = "Drive"
NetworkTelemetryMenuLabel = "Network"
MemoryTelemetryMenuLabel = "Memory"
PowerTelemetryMenuLabel = "Power"
GaudiTelemetryMenuLabel = "Gaudi"
)

const (
Expand Down Expand Up @@ -505,8 +521,9 @@ var tableDefinitions = map[string]TableDefinition{
},
FieldsFunc: systemSummaryTableValues},
BriefSysSummaryTableName: {
Name: BriefSysSummaryTableName,
HasRows: false,
Name: BriefSysSummaryTableName,
MenuLabel: BriefSysSummaryTableName,
HasRows: false,
ScriptNames: []string{
script.HostnameScriptName,
script.DateScriptName,
Expand Down Expand Up @@ -633,7 +650,7 @@ var tableDefinitions = map[string]TableDefinition{
//
CPUUtilizationTelemetryTableName: {
Name: CPUUtilizationTelemetryTableName,
MenuLabel: CPUUtilizationTelemetryTableName,
MenuLabel: CPUUtilizationTelemetryMenuLabel,
HasRows: true,
ScriptNames: []string{
script.MpstatTelemetryScriptName,
Expand All @@ -642,7 +659,7 @@ var tableDefinitions = map[string]TableDefinition{
HTMLTableRendererFunc: cpuUtilizationTelemetryTableHTMLRenderer},
UtilizationCategoriesTelemetryTableName: {
Name: UtilizationCategoriesTelemetryTableName,
MenuLabel: UtilizationCategoriesTelemetryTableName,
MenuLabel: UtilizationCategoriesTelemetryMenuLabel,
HasRows: true,
ScriptNames: []string{
script.MpstatTelemetryScriptName,
Expand All @@ -651,7 +668,7 @@ var tableDefinitions = map[string]TableDefinition{
HTMLTableRendererFunc: utilizationCategoriesTelemetryTableHTMLRenderer},
AverageFrequencyTelemetryTableName: {
Name: AverageFrequencyTelemetryTableName,
MenuLabel: AverageFrequencyTelemetryTableName,
MenuLabel: AverageFrequencyTelemetryMenuLabel,
HasRows: true,
ScriptNames: []string{
script.TurbostatTelemetryScriptName,
Expand All @@ -660,7 +677,7 @@ var tableDefinitions = map[string]TableDefinition{
HTMLTableRendererFunc: averageFrequencyTelemetryTableHTMLRenderer},
IRQRateTelemetryTableName: {
Name: IRQRateTelemetryTableName,
MenuLabel: IRQRateTelemetryTableName,
MenuLabel: IRQRateTelemetryMenuLabel,
HasRows: true,
ScriptNames: []string{
script.MpstatTelemetryScriptName,
Expand All @@ -669,7 +686,7 @@ var tableDefinitions = map[string]TableDefinition{
HTMLTableRendererFunc: irqRateTelemetryTableHTMLRenderer},
DriveTelemetryTableName: {
Name: DriveTelemetryTableName,
MenuLabel: DriveTelemetryTableName,
MenuLabel: DriveTelemetryMenuLabel,
HasRows: true,
ScriptNames: []string{
script.IostatTelemetryScriptName,
Expand All @@ -678,7 +695,7 @@ var tableDefinitions = map[string]TableDefinition{
HTMLTableRendererFunc: driveTelemetryTableHTMLRenderer},
NetworkTelemetryTableName: {
Name: NetworkTelemetryTableName,
MenuLabel: NetworkTelemetryTableName,
MenuLabel: NetworkTelemetryMenuLabel,
HasRows: true,
ScriptNames: []string{
script.NetworkTelemetryScriptName,
Expand All @@ -687,7 +704,7 @@ var tableDefinitions = map[string]TableDefinition{
HTMLTableRendererFunc: networkTelemetryTableHTMLRenderer},
MemoryTelemetryTableName: {
Name: MemoryTelemetryTableName,
MenuLabel: MemoryTelemetryTableName,
MenuLabel: MemoryTelemetryMenuLabel,
HasRows: true,
ScriptNames: []string{
script.MemoryTelemetryScriptName,
Expand All @@ -696,7 +713,7 @@ var tableDefinitions = map[string]TableDefinition{
HTMLTableRendererFunc: memoryTelemetryTableHTMLRenderer},
PowerTelemetryTableName: {
Name: PowerTelemetryTableName,
MenuLabel: PowerTelemetryTableName,
MenuLabel: PowerTelemetryMenuLabel,
HasRows: true,
ScriptNames: []string{
script.TurbostatTelemetryScriptName,
Expand All @@ -705,7 +722,7 @@ var tableDefinitions = map[string]TableDefinition{
HTMLTableRendererFunc: powerTelemetryTableHTMLRenderer},
InstructionTelemetryTableName: {
Name: InstructionTelemetryTableName,
MenuLabel: InstructionTelemetryTableName,
MenuLabel: InstructionTelemetryMenuLabel,
HasRows: true,
ScriptNames: []string{
script.InstructionTelemetryScriptName,
Expand All @@ -714,7 +731,7 @@ var tableDefinitions = map[string]TableDefinition{
HTMLTableRendererFunc: instructionTelemetryTableHTMLRenderer},
GaudiTelemetryTableName: {
Name: GaudiTelemetryTableName,
MenuLabel: GaudiTelemetryTableName,
MenuLabel: GaudiTelemetryMenuLabel,
HasRows: true,
ScriptNames: []string{
script.GaudiTelemetryScriptName,
Expand All @@ -726,7 +743,8 @@ var tableDefinitions = map[string]TableDefinition{
// flamegraph tables
//
CodePathFrequencyTableName: {
Name: CodePathFrequencyTableName,
Name: CodePathFrequencyTableName,
MenuLabel: CodePathFrequencyTableName,
ScriptNames: []string{
script.ProfileJavaScriptName,
script.ProfileSystemScriptName,
Expand All @@ -737,7 +755,8 @@ var tableDefinitions = map[string]TableDefinition{
// kernel lock analysis tables
//
KernelLockAnalysisTableName: {
Name: KernelLockAnalysisTableName,
Name: KernelLockAnalysisTableName,
MenuLabel: KernelLockAnalysisTableName,
ScriptNames: []string{
script.ProfileKernelLockScriptName,
},
Expand Down