From e044d25ec147ab97d17fb16ede150300adf658e1 Mon Sep 17 00:00:00 2001 From: colramos-amd Date: Fri, 11 Nov 2022 13:29:00 -0600 Subject: [PATCH] Reorder Grafana GUI Import section in GUI Signed-off-by: colramos-amd --- src/docs/grafana_analyzer.md | 87 ++++++++++++++++++++++++++++++++ src/docs/performance_analysis.md | 87 -------------------------------- 2 files changed, 87 insertions(+), 87 deletions(-) diff --git a/src/docs/grafana_analyzer.md b/src/docs/grafana_analyzer.md index 687c01142f..5f9bcf46eb 100644 --- a/src/docs/grafana_analyzer.md +++ b/src/docs/grafana_analyzer.md @@ -65,6 +65,93 @@ The uniform color coding is applied to most visualizations (bars, table, diagram ![Grafana GUI Global Variables](images/global_variables.png) +## Grafana GUI Import +The omniperf database `--import` option imports the raw profiling data to Grafana's backend MongoDB database. This step is only required for Grafana GUI based performance analysis. + +Each workload is imported to a separate database with the following naming convention: + + omniperf___ + +e.g., omniperf_asw_vcopy_mi200. + +Below is the sample command to import the *vcopy* profiling data. + +```shell +$ omniperf database --help +ROC Profiler: /usr/bin/rocprof + +usage: + +omniperf database [connection options] + + + +------------------------------------------------------------------------------- + +Examples: + + omniperf database --import -H pavii1 -u temp -t asw -w workloads/vcopy/mi200/ + + omniperf database --remove -H pavii1 -u temp -w omniperf_asw_sample_mi200 + +------------------------------------------------------------------------------- + + + +Help: + -h, --help show this help message and exit + +General Options: + -v, --version show program's version number and exit + -V, --verbose Increase output verbosity + +Interaction Type: + -i, --import Import workload to Omniperf DB + -r, --remove Remove a workload from Omniperf DB + +Connection Options: + -H , --host Name or IP address of the server host. + -P , --port TCP/IP Port. (DEFAULT: 27018) + -u , --username Username for authentication. + -p , --password The user's password. (will be requested later if it's not set) + -t , --team Specify Team prefix. + -w , --workload Specify name of workload (to remove) or path to workload (to import) + -k , --kernelVerbose Specify Kernel Name verbose level 1-5. + Lower the level, shorter the kernel name. (DEFAULT: 2) (DISABLE: 5) +``` + +**omniperf import for vcopy:** +```shell +$ omniperf database --import -H pavii1 -u temp -t asw -w workloads/vcopy/mi200/ +ROC Profiler: /usr/bin/rocprof + +-------- +Import Profiling Results +-------- + +Pulling data from /home/amd/xlu/test/workloads/vcopy/mi200 +The directory exists +Found sysinfo file +KernelName shortening enabled +Kernel name verbose level: 2 +Password: +Password recieved +-- Conversion & Upload in Progress -- + 0%| | 0/11 [00:00__ - -e.g., omniperf_asw_vcopy_mi200. - -Below is the sample command to import the *vcopy* profiling data. - -```shell -$ omniperf database --help -ROC Profiler: /usr/bin/rocprof - -usage: - -omniperf database [connection options] - - - -------------------------------------------------------------------------------- - -Examples: - - omniperf database --import -H pavii1 -u temp -t asw -w workloads/vcopy/mi200/ - - omniperf database --remove -H pavii1 -u temp -w omniperf_asw_sample_mi200 - -------------------------------------------------------------------------------- - - - -Help: - -h, --help show this help message and exit - -General Options: - -v, --version show program's version number and exit - -V, --verbose Increase output verbosity - -Interaction Type: - -i, --import Import workload to Omniperf DB - -r, --remove Remove a workload from Omniperf DB - -Connection Options: - -H , --host Name or IP address of the server host. - -P , --port TCP/IP Port. (DEFAULT: 27018) - -u , --username Username for authentication. - -p , --password The user's password. (will be requested later if it's not set) - -t , --team Specify Team prefix. - -w , --workload Specify name of workload (to remove) or path to workload (to import) - -k , --kernelVerbose Specify Kernel Name verbose level 1-5. - Lower the level, shorter the kernel name. (DEFAULT: 2) (DISABLE: 5) -``` - -**omniperf import for vcopy:** -```shell -$ omniperf database --import -H pavii1 -u temp -t asw -w workloads/vcopy/mi200/ -ROC Profiler: /usr/bin/rocprof - --------- -Import Profiling Results --------- - -Pulling data from /home/amd/xlu/test/workloads/vcopy/mi200 -The directory exists -Found sysinfo file -KernelName shortening enabled -Kernel name verbose level: 2 -Password: -Password recieved --- Conversion & Upload in Progress -- - 0%| | 0/11 [00:00