Linux System Report: support utility for Linux users

[tomreyn]

We now have a little shell script which puts together the most relevant information we need when someone is having trouble running MegaGlest. This is also useful in situations where MegaGlest does not run at all or crashes quickly, an increasingly rare but difficult to diagnose case. On the other hand the system report also provides in-depth informationon the users' hardware and operating system, giving us a good idea of which environment MegaGlest is operating in.

This utility has been around for a while, but got a larger rewrite now (to add more features and safeguards) and it hasn't been tested much, yet, so please help testing. It's pretty straight forward, all you need to do is open a terminal window and paste this:

Code: [Select]

cd /tmp && wget 'http://megaglest.svn.sourceforge.net/svnroot/megaglest/trunk/source/tools/support/linux/system_report' && chmod +x system_report && ./system_report
This produces a report file which you should then make available as indicated.

This utility just gathers information (nothing personal except your hostname and username - you are welcome to edit this out if you prefer, but if you do, please make it visible), it does not make any changes to your system. You are also not supposed to run it as root/with sudo, running it as a normal/restricted user is fully sufficient.

Thanks in advance for testing.

[Zhook]

Ok, I'll test it today.

[Zhook]

Cool!
Here is my log: http://www.ovrload.ru/temp/system_report_dc77f0246552bfc7479f14d07c66c6f9.log

[Omega]

Any chance of a Windows version in the future, too?

[Zhook]

Already translated into russian:

(click to show/hide)

Code: [Select]

#!/bin/sh
#
# MegaGlest System Report
#
# Examines the Linux operating environment of a MegaGlest installation and
# dumps this information into REPORT_LOCATION for support purposes.
#
# -----------------------------------------------------------------------------
#
# Автор - Tom Reynolds <tomreyn[at]megaglest.org>
# Copyright (c) 2012 Tom Reynolds, The Megaglest Team, under GNU GPL v3.0
#
# -----------------------------------------------------------------------------
#
# Configuration section

# Папка для логов
#REPORT_LOCATION=

# Папка установки MegaGlest, см. --help
#INSTALLATION_LOCATION=

# Чтобы пользователь нажимал Enter для выхода
#PAUSE=1

# End of configuration section
#
# -----------------------------------------------------------------------------
#

LANG=C
VERSION='0.3'
MYNAME=`basename $0`
DEFAULT_REPORT_FILENAME=system_report.log

if [ "$1"'x' = '-vx' -o "$1"'x' = '--versionx' ]
then
echo 'MegaGlest System Report '"$VERSION"
echo ''
exit 0
fi

if [ "$1"'x' = '-hx' -o "$1"'x' = '--helpx' ]
then
echo 'Применение:'
echo ' '"$MYNAME"' <опции>'
echo ' '"$MYNAME"' [путь к установленной программе]'
echo ''
echo 'Доступные опции:'
echo ' --version   показать инфо о версии и выйти'
echo ' --help      показать эту справку и выйти'
echo ''
echo 'путь установки - одна из опций megaglest'
echo 'папка установки должна содержать скрипт "start_megaglest".'
echo ''
exit 0
fi

if [ "$REPORT_LOCATION"'x' = 'x' ]
then
REPORT_LOCATION=$DEFAULT_REPORT_FILENAME
fi

if [ "$PAUSE"'x' = 'x' ]
then
PAUSE=1
fi

# Check whether report file is writable
rm -f "$REPORT_LOCATION"
touch "$REPORT_LOCATION" >/dev/null 2>&1
if [ "$?"'x' != '0x' ]
then # Unable to write report file
rm -f /tmp/$DEFAULT_REPORT_FILENAME
touch /tmp/$DEFAULT_REPORT_FILENAME >/dev/null 2>&1
if [ "$?"'x' != '0x' ]
then # Unable to write to backup report file locationм
echo 'ERROR: невозможно создать лог в '"$REPORT_LOCATION"' или /tmp/'"$DEFAULT_REPORT_FILENAME" >&2
echo '       пожалуйста, отредактируйте скрипт задав в качестве REPORT_LOCATION папку с правами на запись.' >&2
echo '' >&2
rm -f "$REPORT_LOCATION"
exit 1
else # Writing to backup report file location succeeded
echo 'WARNING: не могу записать лог в  '"$REPORT_LOCATION"'.'
echo '         Пишу в /tmp/'"$DEFAULT_REPORT_FILENAME"' .' >&2
echo '' >&2
REPORT_LOCATION=/tmp/$DEFAULT_REPORT_FILENAME
fi
fi
rm -f "$REPORT_LOCATION"

installation_location_unusable () {
echo 'ERROR: неправильная папка установки:' >&2
echo '  '"$INSTALLATION_LOCATION" >&2
echo '' >&2
echo 'Пожалуйста, укажите корректную папку (должна содержать' >&2
echo 'скрипт start_megaglest) как первый параметр к скрипту, например:' >&2
echo '  '"$MYNAME"' /home/paulo/MegaGlest-3' >&2
echo '' >&2
echo 'Вы можете использовать эти команды, чтобы найти папку:' >&2
echo '  locate -b '"'"'\start_megaglest'"'" >&2
echo '  find -type f -name start_megaglest ~/' >&2
echo '  sudo find -type f -name start_megaglest /' >&2
echo '' >&2
echo 'Убедитесь, что  megaglest установлен правильно,' >&2
echo 'используя инструкцию http://megaglest.org. ' >&2
echo 'Команды могут не работать для версии megaglest, собранной для вашего дистрибутива.' >&2
echo '' >&2
}

# Locate MegaGlest installation location
if [ "$INSTALLATION_LOCATION"'x' != 'x' ] # The user provided an installation directory via env. variable
then
if [ -f "$INSTALLATION_LOCATION/start_megaglest" -o -h "$INSTALLATION_LOCATION/start_megaglest" ]
then # The user provided an installation directory which is usable
true
else # The user provided an installation directory which is NOT usable
installation_location_unusable
exit 1
fi
else # The user did not specify the $INSTALLATION_LOCATION environment variable
if [ "$1"'x' != 'x' ]
then # The user did, however, specify the installation location as a command line argument
INSTALLATION_LOCATION=$1
if [ -f "$INSTALLATION_LOCATION/start_megaglest" -o -h "$INSTALLATION_LOCATION/start_megaglest" ]
then # The user provided an installation directory which is usable
true
else # The user provided an installation directory which is NOT usable
installation_location_unusable
exit 1
fi
else # The user did not specify the installation location at all
if [ -f ~/megaglest/start_megaglest -o -h ~/megaglest/start_megaglest ]
then # However, there is a usable installation at ~/megaglest/
INSTALLATION_LOCATION=~/megaglest
echo 'WARNING: используется автоматически выбранная папка ~/megaglest' >&2
echo '         Обычно используется по умолчанию. Для ручного выбора смотрите --help.' >&2
echo '' >&2
else # Failed to guess the installation location, so give up.
echo 'ERROR: не могу найти папку установки MegaGlest.' >&2
echo '' >&2
echo 'Выберите папку, куда устанавливали (дожна содержать' >&2
echo 'скрипт start_megaglest) как первый параметр, например:' >&2
echo '  '"$MYNAME"' /home/paulo/MegaGlest-3' >&2
echo '' >&2
        echo 'Вы можете использовать эти команды, чтобы найти папку:' >&2
echo '  locate -b '"'"'\start_megaglest'"'" >&2
echo '  find -type f -name start_megaglest ~/' >&2
echo '  sudo find -type f -name start_megaglest /' >&2
echo '' >&2
echo 'Скрипт работает только при правильной установке' >&2
echo 'с использованием файлов и инструкций с megaglest.org. Иначе работа не гарантируется' >&2
echo 'Команды могут не работать для версии megaglest, собранной для вашего дистрибутива.' >&2
echo '' >&2
exit 1
fi
fi
fi

# Start gathering information, writing it to REPORT_LOCATION
echo 'Идет сбор информации о компьютере и программе MegaGlest, пожалуйста, ждите.'
echo ''
echo '--------------------------------------------------------------------------------' >> $REPORT_LOCATION
echo '                        MEGAGLEST SYSTEM REPORT '"$VERSION" >> $REPORT_LOCATION
echo '                      '"`date -Ru`" >> $REPORT_LOCATION
echo '--------------------------------------------------------------------------------' >> $REPORT_LOCATION

echo '' >> $REPORT_LOCATION
echo '' >> $REPORT_LOCATION
echo '***** Operating system *********************************************************' | tee -a $REPORT_LOCATION
echo '' >> $REPORT_LOCATION
if [ `which lsb_release`'x' = 'x' ]
then # no lsb_release in path
lsb=0
if [ -e /etc/debian_version ];   then distribution='Debian';   release='unknown release version'; codename=`cat /etc/debian_version`;   fi
if [ -e /etc/SuSE-release ];     then distribution='SuSE';     release='unknown release version'; codename=`cat /etc/SuSE-release`;     fi
if [ -e /etc/fedora-release ];   then distribution='Fedora';   release='unknown release version'; codename=`cat /etc/fedora-release`;   fi
if [ -e /etc/redhat-release ];   then distribution='Redhat';   release='unknown release version'; codename=`cat /etc/redhat-release`;   fi
if [ -e /etc/mandrake-release ]; then distribution='Mandrake'; release='unknown release version'; codename=`cat /etc/mandrake-release`; fi
else
lsb=1
distribution=`lsb_release -i | awk -F':' '{ gsub(/^[ \t]*/,"",$2); print $2 }'`
release=`lsb_release -r | awk -F':' '{ gsub(/^[  \t]*/,"",$2); print $2 }'`
codename=`lsb_release -c | awk -F':' '{ gsub(/^[ \t]*/,"",$2); print $2 }'`
fi
echo '* Distribution: '"$distribution" >> $REPORT_LOCATION
echo '* Release:      '"$release" >> $REPORT_LOCATION
echo '* Codename:     '"$codename" >> $REPORT_LOCATION
echo '* LSB support:  '"$lsb" >> $REPORT_LOCATION
echo '' >> $REPORT_LOCATION
echo '>>> uname -a' >> $REPORT_LOCATION
uname -a >> $REPORT_LOCATION 2>&1
sleep 1
echo '' >> $REPORT_LOCATION
echo '>>> cat /etc/issue' >> $REPORT_LOCATION
cat /etc/issue >> $REPORT_LOCATION 2>&1
sleep 1

echo '' >> $REPORT_LOCATION
echo '' >> $REPORT_LOCATION
echo '***** MegaGlest version ********************************************************' | tee -a $REPORT_LOCATION
echo '' >> $REPORT_LOCATION

# Currently commented out due to http://glest.org/glest_board/?topic=8482
#if [ "$ERROR_RUNNING_MEGAGLEST"'x' = '0x' -o  "$ERROR_RUNNING_MEGAGLEST"'x' = 'x' ]
#then # Only run this if MegaGlest didn't already fail last time it was run
echo ' (Запускаю megaglest, я закрою его автоматически.)'
echo '' >> $REPORT_LOCATION
echo '>>> ./start_megaglest --version' >> $REPORT_LOCATION
$INSTALLATION_LOCATION/start_megaglest --version >> $REPORT_LOCATION 2>&1
if [ "$?"'x' = '0x' ]
then # all cool
ERROR_RUNNING_MEGAGLEST=0
else # an error occurred
ERROR_RUNNING_MEGAGLEST=1
fi
sleep 1
#else
# echo 'WARNING: предыдущий запуск MegaGlest не удался. Пропускаю тест.' >&2
# echo '>>> SKIPPED: ./start_megaglest --version' >> $REPORT_LOCATION
#fi

echo '' >> $REPORT_LOCATION
echo '' >> $REPORT_LOCATION
echo '***** MegaGlest configuration **************************************************' | tee -a $REPORT_LOCATION
echo '' >> $REPORT_LOCATION

# Currently commented out due to http://glest.org/glest_board/?topic=8482
#if [ "$ERROR_RUNNING_MEGAGLEST"'x' = '0x' -o  "$ERROR_RUNNING_MEGAGLEST"'x' = 'x' ]
#then # Only run this if MegaGlest didn't already fail last time it was run
echo ' (Запускаю megaglest, я закрою его автоматически.)'
echo '' >> $REPORT_LOCATION
echo '>>> ./start_megaglest --show-ini-settings' >> $REPORT_LOCATION
$INSTALLATION_LOCATION/start_megaglest --show-ini-settings >> $REPORT_LOCATION 2>&1
if [ "$?"'x' = '0x' ]
then # all cool
ERROR_RUNNING_MEGAGLEST=0
else # an error occurred
ERROR_RUNNING_MEGAGLEST=1
fi
sleep 1
#else
# echo 'WARNING: предыдущий запуск MegaGlest не удался. Пропускаю тест.' >&2
# echo '>>> SKIPPED: ./start_megaglest --show-ini-settings' >> $REPORT_LOCATION
#fi

echo '' >> $REPORT_LOCATION
echo '' >> $REPORT_LOCATION
echo '***** CPU **********************************************************************' | tee -a $REPORT_LOCATION
echo '' >> $REPORT_LOCATION
echo '>>> cat /proc/cpuinfo | awk -F : '"'"'/^model name/ { print $2 }' >> $REPORT_LOCATION
cat /proc/cpuinfo | awk -F : '/^model name/ { print $2 }' >> $REPORT_LOCATION
sleep 1

echo '' >> $REPORT_LOCATION
echo '' >> $REPORT_LOCATION
echo '***** Memory *******************************************************************' | tee -a $REPORT_LOCATION
echo '' >> $REPORT_LOCATION
echo '>>> free -mt' >> $REPORT_LOCATION
free -mt >> $REPORT_LOCATION
sleep 1

echo '' >> $REPORT_LOCATION
echo '' >> $REPORT_LOCATION
echo '***** Graphics *****************************************************************' | tee -a $REPORT_LOCATION
echo '' >> $REPORT_LOCATION

echo ">>> lspci -knnv | grep -EA10 '(VGA|Display)'" >> $REPORT_LOCATION
lspci -knnv | grep -EA10 '(VGA|Display)' >> $REPORT_LOCATION
sleep 1
echo '' >> $REPORT_LOCATION
echo '>>> glxinfo' >> $REPORT_LOCATION
glxinfo >> $REPORT_LOCATION 2>&1
sleep 1
echo '' >> $REPORT_LOCATION
echo '>>> xrandr' >> $REPORT_LOCATION
xrandr >> $REPORT_LOCATION  2>&1
sleep 1

# Currently commented out due to http://glest.org/glest_board/?topic=8482
#if [ "$ERROR_RUNNING_MEGAGLEST"'x' = '0x' -o  "$ERROR_RUNNING_MEGAGLEST"'x' = 'x' ]
#then # Only run this if MegaGlest didn't already fail last time it was run
echo ' (Запускаю megaglest, я закрою его автоматически.)'
echo '' >> $REPORT_LOCATION
echo '>>> ./start_megaglest --opengl-info' >> $REPORT_LOCATION
$INSTALLATION_LOCATION/start_megaglest --opengl-info >> $REPORT_LOCATION 2>&1
if [ "$?"'x' = '0x' ]
then # all cool
ERROR_RUNNING_MEGAGLEST=0
else # an error occurred
ERROR_RUNNING_MEGAGLEST=1
fi
sleep 1
#else
# echo 'WARNING: предыдущий запуск MegaGlest не удался. Пропускаю тест.' >&2
# echo '>>> SKIPPED: ./start_megaglest --opengl-info' >> $REPORT_LOCATION
#fi

echo '' >> $REPORT_LOCATION
echo '--------------------------------------------------------------------------------' >> $REPORT_LOCATION
echo '' >> $REPORT_LOCATION
echo '' >> $REPORT_LOCATION
echo '' >> $REPORT_LOCATION

echo ''
echo 'Я закончил.'
sleep 1
echo ''
echo 'Лог будет в файле:'
echo '  '"$REPORT_LOCATION"
echo ''
echo 'Пожалуйста, поместите лог на один из этих сайтов'
echo '  http://paste.megaglest.org'
echo '  http://pastebin.com'
 echo ' http://ovrload.ru'
echo ''
echo 'После того, как получите ссылку на файл, пожалуйста,'
echo 'пошлите ее разработчикам MegaGlest или напишите на форуме http://forums.megaglest.org'
 echo 'Там же вы можете получить дополнительные инструкции.'
echo ''
echo 'Спасибо, что упрощаете процедуру помощи вам.'
echo ''

if [ "$PAUSE"'x' = '1x' -o "$PAUSE"'x' = 'truex' ]
then
echo 'Нажмите  Enter для выхода.'
read input >/dev/null
fi
 

[tomreyn]

Already translated into russian:

That's kind of you, thanks, but ... I don't plan to add locaization support to it - it's just a support script. So while your translated copy is here, it will get outdated quickly and People should always use the latest one - which will be English only unfortunately.

Any chance of a Windows version in the future, too?

Loose plans, yes, but no more than that currently. It's very, very, very far from straight-forward to do something like this on Windows. It would need to be a Visual Basic script (VBS) which interfaces the Windows Management Instrumentation (WMI) to get this kind of information. And there doesn't seem to be a lot of good and free documentation on that available. So, at least to me, this would be a no fun job, and I'd be very happy if some Windows enthusiast would do it instead.

[Zhook]

I'll update translation.
Just e-mail me if you make new version and I'll translate it.
I think need to add script to contact page of mg's website.
It will simplify support.