Skip to content

Commit e0be22d

Browse files
harp-intelharp-intel
authored
Rename "Brief System Summary" to "System Summary" across multiple com… (#593)
* Rename "Brief System Summary" to "System Summary" across multiple commands for consistency Signed-off-by: Harper, Jason M <[email protected]> * Rename "System Info" to "System Summary" for consistency across metadata handling and HTML representation Signed-off-by: Harper, Jason M <[email protected]> --------- Signed-off-by: Harper, Jason M <[email protected]>
1 parent 028ee2e commit e0be22d

File tree

9 files changed

+27
-27
lines changed

9 files changed

+27
-27
lines changed

‎cmd/benchmark/benchmark.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ func runCmd(cmd *cobra.Command, args []string) error {
223223
var tables []table.TableDefinition
224224
// add system summary table if not disabled
225225
if !flagNoSystemSummary {
226-
tables = append(tables, common.TableDefinitions[common.BriefSysSummaryTableName])
226+
tables = append(tables, common.TableDefinitions[common.SystemSummaryTableName])
227227
}
228228
// add benchmark tables
229229
selectedBenchmarkCount := 0

‎cmd/flamegraph/flamegraph.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ func validateFlags(cmd *cobra.Command, args []string) error {
179179
func runCmd(cmd *cobra.Command, args []string) error {
180180
var tables []table.TableDefinition
181181
if !flagNoSystemSummary {
182-
tables = append(tables, common.TableDefinitions[common.BriefSysSummaryTableName])
182+
tables = append(tables, common.TableDefinitions[common.SystemSummaryTableName])
183183
}
184184
tables = append(tables, tableDefinitions[CallStackFrequencyTableName])
185185
reportingCommand := common.ReportingCommand{

‎cmd/lock/lock.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ func pullDataFiles(appContext common.AppContext, scriptOutputs map[string]script
195195
func runCmd(cmd *cobra.Command, args []string) error {
196196
var tables []table.TableDefinition
197197
if !flagNoSystemSummary {
198-
tables = append(tables, common.TableDefinitions[common.BriefSysSummaryTableName])
198+
tables = append(tables, common.TableDefinitions[common.SystemSummaryTableName])
199199
}
200200
tables = append(tables, tableDefinitions[KernelLockAnalysisTableName])
201201
reportingCommand := common.ReportingCommand{

‎cmd/metrics/metadata.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ func (c *X86MetadataCollector) CollectMetadata(t target.Target, noRoot bool, noS
173173
return Metadata{}, fmt.Errorf("failed to get system summary: %w", err)
174174
}
175175
} else {
176-
metadata.SystemSummaryFields = [][]string{{"", "System Info Not Available"}}
176+
metadata.SystemSummaryFields = [][]string{{"", "System Summary Not Available"}}
177177
}
178178
// Architecture
179179
if metadata.Architecture, err = getArchitecture(scriptOutputs); err != nil {
@@ -352,7 +352,7 @@ func (c *ARMMetadataCollector) CollectMetadata(t target.Target, noRoot bool, noS
352352
return Metadata{}, fmt.Errorf("failed to get system summary: %w", err)
353353
}
354354
} else {
355-
metadata.SystemSummaryFields = [][]string{{"", "System Info Not Available"}}
355+
metadata.SystemSummaryFields = [][]string{{"", "System Summary Not Available"}}
356356
}
357357
// Architecture
358358
if metadata.Architecture, err = getArchitecture(scriptOutputs); err != nil {
@@ -555,7 +555,7 @@ BEGIN {
555555
}
556556
// add the system summary table scripts to the list
557557
if !noSystemSummary {
558-
for _, scriptName := range common.TableDefinitions[common.BriefSysSummaryTableName].ScriptNames {
558+
for _, scriptName := range common.TableDefinitions[common.SystemSummaryTableName].ScriptNames {
559559
scriptDef := script.GetScriptByName(scriptName)
560560
metadataScripts = append(metadataScripts, scriptDef)
561561
}
@@ -637,7 +637,7 @@ func ReadJSONFromFile(path string) (md Metadata, err error) {
637637

638638
// getSystemSummary - retrieves the system summary from the target
639639
func getSystemSummary(scriptOutputs map[string]script.ScriptOutput) (summaryFields [][]string, err error) {
640-
allTableValues, err := table.ProcessTables([]table.TableDefinition{common.TableDefinitions[common.BriefSysSummaryTableName]}, scriptOutputs)
640+
allTableValues, err := table.ProcessTables([]table.TableDefinition{common.TableDefinitions[common.SystemSummaryTableName]}, scriptOutputs)
641641
if err != nil {
642642
err = fmt.Errorf("failed to process script outputs: %w", err)
643643
return

‎cmd/metrics/resources/base.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@
168168
const [hasHighlightedMetrics, setHasHighlightedMetrics] = React.useState(false);
169169
const description = <<.DESCRIPTION>>
170170
const metadata = <<.METADATA>>
171-
const system_info = <<.SYSTEMINFO>>
171+
const system_summary = <<.SYSTEMSUMMARY>>
172172

173173
// Check for highlighted metrics whenever current_metrics changes
174174
React.useEffect(() => {
@@ -701,7 +701,7 @@
701701
<Tab label="Memory" />
702702
<Tab label="Power" />
703703
<Tab label="All Metrics" />
704-
<Tab label="System Info" />
704+
<Tab label="System Summary" />
705705
<Tab label="Metadata" />
706706
</Tabs>
707707
</Box>
@@ -967,7 +967,7 @@
967967
</TableRow>
968968
</TableHead>
969969
<TableBody>
970-
{system_info && system_info.map(([key, value]) => (
970+
{system_summary && system_summary.map(([key, value]) => (
971971
<TableRow key={key}>
972972
<TableCell sx={{ fontFamily: 'Monospace' }} component="th" scope="row" >
973973
{JSON.stringify(key)}

‎cmd/metrics/summary.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -629,12 +629,12 @@ func (mg *MetricGroup) loadHTMLTemplateValues(metadata Metadata, metricDefinitio
629629
}
630630
templateVals["METADATA"] = string(jsonMetadata)
631631

632-
// system info tab
633-
jsonSystemInfo, err := json.Marshal(metadata.SystemSummaryFields)
632+
// system summary tab
633+
jsonSystemSummary, err := json.Marshal(metadata.SystemSummaryFields)
634634
if err != nil {
635635
return
636636
}
637-
templateVals["SYSTEMINFO"] = string(jsonSystemInfo)
637+
templateVals["SYSTEMSUMMARY"] = string(jsonSystemSummary)
638638
return
639639
}
640640

‎cmd/metrics/trim.go‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -313,9 +313,9 @@ func loadMetadataFromHTMLSummary(summaryHTMLPath string) (Metadata, error) {
313313
return metadata, fmt.Errorf("failed to read summary HTML file: %w", err)
314314
}
315315

316-
// assumes system_info comes after metadata in the file
316+
// assumes system_summary comes after metadata in the file
317317
const metadataPrefix = "const metadata = "
318-
const systemInfoPrefix = "const system_info = "
318+
const systemSummaryPrefix = "const system_summary = "
319319
for line := range strings.SplitSeq(string(content), "\n") {
320320
line = strings.TrimSpace(line)
321321
if strings.HasPrefix(line, metadataPrefix) {
@@ -327,16 +327,16 @@ func loadMetadataFromHTMLSummary(summaryHTMLPath string) (Metadata, error) {
327327
if err != nil {
328328
return metadata, fmt.Errorf("failed to parse metadata JSON: %w", err)
329329
}
330-
} else if strings.HasPrefix(line, systemInfoPrefix) {
331-
// system info
332-
var systemInfo [][]string
333-
jsonStart := len(systemInfoPrefix)
330+
} else if strings.HasPrefix(line, systemSummaryPrefix) {
331+
// system summary
332+
var systemSummary [][]string
333+
jsonStart := len(systemSummaryPrefix)
334334
jsonString := strings.TrimSpace(line[jsonStart:])
335-
err = json.Unmarshal([]byte(jsonString), &systemInfo)
335+
err = json.Unmarshal([]byte(jsonString), &systemSummary)
336336
if err != nil {
337-
return metadata, fmt.Errorf("failed to parse system info JSON: %w", err)
337+
return metadata, fmt.Errorf("failed to parse system summary JSON: %w", err)
338338
}
339-
metadata.SystemSummaryFields = systemInfo
339+
metadata.SystemSummaryFields = systemSummary
340340
return metadata, nil
341341
}
342342
}

‎cmd/telemetry/telemetry.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ func runCmd(cmd *cobra.Command, args []string) error {
273273
var tables []table.TableDefinition
274274
// add system summary table if not disabled
275275
if !flagNoSystemSummary {
276-
tables = append(tables, common.TableDefinitions[common.BriefSysSummaryTableName])
276+
tables = append(tables, common.TableDefinitions[common.SystemSummaryTableName])
277277
}
278278
// add category tables
279279
for _, cat := range categories {

‎internal/common/table_defs.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ import (
99
"strings"
1010
)
1111

12-
const BriefSysSummaryTableName = "Brief System Summary"
12+
const SystemSummaryTableName = "System Summary"
1313

1414
var TableDefinitions = map[string]table.TableDefinition{
15-
BriefSysSummaryTableName: {
16-
Name: BriefSysSummaryTableName,
17-
MenuLabel: BriefSysSummaryTableName,
15+
SystemSummaryTableName: {
16+
Name: SystemSummaryTableName,
17+
MenuLabel: SystemSummaryTableName,
1818
HasRows: false,
1919
ScriptNames: []string{
2020
script.HostnameScriptName,

0 commit comments

Comments
 (0)