VK Cloud logo

hw-bundle-util диагностикалық утилитасы

hw-bundle-util — VK Cloud жасаған, Bare Metal серверінің диагностикалық деректерін жинауға арналған Linux утилитасы. Утилита жабдық пен ОЖ туралы мәліметтерді бір архивке жинайды, мысалы, техникалық қолдау қызметіне жүгіну үшін.

Утилитаны пайдаланушы ОЖ-де қолмен іске қосады. Мынадай Linux дистрибутивтері (amd64 және arm64) қолдау табады:

  • Ubuntu 18.04/20.04/22.04/24.04,
  • Debian 10/11/12,
  • CentOS 8, CentOS Stream 9,
  • AlmaLinux 8/9,
  • Rocky Linux 8/9,
  • РЕД ОС 7/8.

Диагностикалық ақпараттың бір бөлігі тек суперпайдаланушы құқықтарымен қолжетімді, сондықтан hw-bundle-util утилитасын sudo арқылы немесе тікелей root тіркелгісінен іске қосу ұсынылады.

Утилита пайдаланушы деректерін және ОЖ параметрлерін өзгертпейді. Іске қосқаннан кейін орындалатын файлдың жанында диагностикалық ақпаратты жинауға арналған директория жасалады. Әдепкі бойынша hw-bundle-util сәтті орындалып, есеп қалыптастырылғаннан кейін барлық уақытша файлдар жойылады. Қажет болса, өз іске қосу параметрлеріңізді беруге болады.

Жиналатын ақпарат

Жүйенің әртүрлі құрамдастары туралы ақпарат жинау үшін Linux дистрибутивтерінің көпшілігінде қолжетімді көмекші утилиталар пайдаланылады, сондай-ақ procfs виртуалды файлдық жүйесінен жүйелік ақпарат оқылады.

hw-bundle-util мынадай дереккөздерді пайдаланады:

  • Bare Metal серверінің платформасы сипаттамалары (аналық плата, процессор, жады, BIOS/UEFI нұсқасы): dmidecode.
  • ОЖ параметрлері және жүйелік көрсеткіштер: hostname, hostnamectl, lscpu, /proc/cpuinfo, uname, /etc/os-release, /proc/uptime, /proc/loadavg.
  • Жедел жады күйі: free -h, /proc/meminfo.
  • Файлдық жүйе және жинақтауыштар параметрлері: lsblk, blkid, /sys/block, /proc/partitions.
  • SMART көрсеткіштері: табылған әрбір құрылғы бойынша smartctl кеңейтілген шығысы.
  • EDAC ішкі жүйесінен жабдықтың жұмысындағы қателер: /sys/devices/system/edac, ras-mc-ctl, edac-util, /var/log/mcelog, rasdaemon және ядро журналы (dmesg) жазбалары.
  • Соңғы 24 сағаттағы dmesg -T ядро журналы, journalctl --dmesg және /var/log/kern.log файлының соңғы жазбалары.
  • Желі күйі: ethtool арқылы желі интерфейстерінің параметрлері, DNS конфигурациясы және vk.ru мен cloud.vk.ru атауларының шешілуін тексеру (dig), шлюзге, vk.ru және cloud.vk.ru мекенжайларына, сондай-ақ 8.8.8.8, 8.8.4.4, 77.88.8.8, 77.88.8.88 жалпыға ортақ DNS серверлеріне байланысты тексеру (ping).
  • Ағымдағы уақыт және жүйелік уақыт параметрлері: date, timedatectl.
  • Жүйелік файлдар: /proc/cmdline, /proc/uptime, /proc/cpuinfo, /proc/meminfo, /proc/sys/kernel/tainted, /etc/os-release көшірмелері, /var/log/syslog немесе /var/log/messages файлының соңғы 10000 байты.

Желі жылдамдығы тексерілмейді.

Есеп мазмұны

Утилита жұмысын аяқтағаннан кейін орындалатын файлдың жанында мынадай құрылымы бар bmaas-bundle.tar.gz архиві жасалады:

bmaas-bundle.tar.gz├── log.log└── bundle/    ├── hw-bundle-util.version    ├── sanitize.legend    ├── collect/    ├── exec/    │   └── <ПРОВЕРКА>/    │       ├── <ИМЯ_УТИЛИТЫ>[.<УТОЧНЕНИЕ>].stdout    │       ├── <ИМЯ_УТИЛИТЫ>[.<УТОЧНЕНИЕ>].stderr    │       ├── <ИМЯ_УТИЛИТЫ>.version    │       └── legend    └── collection.incomplete

Мұндағы:

  • log.log: hw-bundle-util жұмысының журналы.

  • bundle/hw-bundle-util.version: есеп жиналған hw-bundle-util нұсқасы.

  • bundle/sanitize.legend: есеп буып-түйілместен бұрын ядроны жүктеу параметрлерінде ауыстырылған мәндердің тізбесі.

  • bundle/collect/: жүйеден көшірілген ОЖ файлдары. /proc/cmdline көшірмесі алдын ала құпия деректерден тазартылады.

  • bundle/exec/<ПРОВЕРКА>/: көмекші утилиталарды шақыру нәтижелері. Әрбір тексеру үшін бөлек директория жасалады, онда мыналар болады:

    • <ИМЯ_УТИЛИТЫ>[.<УТОЧНЕНИЕ>].stdout және <ИМЯ_УТИЛИТЫ>[.<УТОЧНЕНИЕ>].stderr: stdout стандартты ағынынан, сондай-ақ stderr стандартты қате ағынынан шығыс жазылған файлдар. Көмекші утилитаның жұмысы кезінде диагностикалық және жөндеу хабарламалары болмаса, stderr файлы болмайды.

      Мұндағы <УТОЧНЕНИЕ> — тексеру туралы қосымша ақпарат. Мысалы, ethtool үшін интерфейс атауы нақтыланады: ethtool.eth0.

    • <ИМЯ_УТИЛИТЫ>.version: көмекші утилита нұсқасы.

    • legend: көмекші утилитаны іске қосу туралы жиынтық — аргументтер және нәтиженің жоқ болу себептері.

  • bundle/collection.incomplete: орындау мүмкін болмаған тексерулердің тізбесі және себептері. Файл деректер толық жиналмаған жағдайда ғана жасалады, мысалы, жүйеде қажетті көмекші утилита болмаса немесе root құқықтарынсыз іске қосылса.

Есеп жасалғанға дейін ядроны жүктеу параметрлеріндегі тіркелгі деректері тазартылады. Жою құпия ақпаратты сақтаудың белгілі үлгілері бойынша, сондай-ақ password, passwd, token, secret, credential, apikey, api_key, accesskey, access_key кілт сөздері бойынша орындалады. Жойылған мәннің орнында secret:S0:secret-key:len=<КОЛИЧЕСТВО_СИМВОЛОВ>:fp=<ОТПЕЧАТОК> түріндегі жазба қалады, жолдың қалған бөлігі өзгермейді. Мұндағы <ОТПЕЧАТОК> — бір құпия үшін бірдей таңбалар тізбегі. Осылайша құпияның мазмұнын ашпай, қандай құпия қайда пайдаланылатынын білуге болады. Утилитаны қайта іске қосса, жаңа архивте бірдей құпиялардың жазбалары өзгереді. Бұл ізқалдырғыш әр іске қосқан сайын қайта жасалатындықтан болады.

Тазарту collect/cmdline файлына, сондай-ақ exec/kernel/dmesg.stdout және journalctl.stdout шығысына қолданылады. Қалған мазмұн архивке өзгеріссіз кіреді: көмекші утилиталардың шығысы, /proc, /sys және /etc ішіндегі файлдардың көшірмелері, утилитаның өз жұмыс журналы. /var/log/syslog немесе /var/log/messages және /var/log/kern.log файлдарынан архивке файлдың бүкіл мазмұны емес, тек соңғы жазбалар енгізіледі.

Командалар және іске қосу параметрлері

Іске қосу пішімі:

./hw-bundle-util [КОМАНДА] [ПАРАМЕТРЫ]

Командалар

Команда

Мақсаты

collect

Диагностикалық деректерді жинау. Команда көрсетілмесе, әдепкі бойынша пайдаланылады

version

Утилита нұсқасын шығару

Параметрлер

Параметр

Әдепкі мәні

Мақсаты

Анықтама

--help

—

Анықтаманы шығару. ./hw-bundle-util --help — утилита бойынша анықтама, ./hw-bundle-util collect --help — жинау параметрлері бойынша анықтама

collect командасының жұмыс директориясы және журналдау параметрлері

--working-dir

./bmaas-bundle

Жұмыс директориясы. Архив оның жанында жасалады және атауы сондай болады, бірақ .tar.gz кеңейтімімен. Директория бұрыннан бар болса, утилита іске қосылғанда оның мазмұны қайта жазылады

--console-log-level

info

Терминалға шығарудың егжей-тегжейлілігі. Рұқсат етілген мәндер: debug, info, warn, error

--file-log-level

debug

Архив ішіндегі log.log файлына жазудың егжей-тегжейлілігі. Рұқсат етілген мәндер: debug, info, warn, error

--no-cleanup

Пайдаланылмайды

Архив жасалғаннан кейін жиналған каталогтар ағашын жоймау. Әдепкі бойынша ол жойылады, өйткені архивте дәл сол деректер бар

collect командасының архивті жіберу параметрлері

--upload-url

—

Архивті жіберу керек URL мекенжайы. Параметр көрсетілмесе, архив тек дискіде, орындалатын файлдың жанында немесе --working-dir параметрімен берілген директорияда сақталады

--upload-method

S3

Жіберу тәсілі. Рұқсат етілген мәндер: S3, PUT, POST. Басқа мән берілсе, утилита 3 қайтару кодымен аяқталады. --upload-url параметрімен бірге пайдаланылады. --upload-url болмаса, --upload-method параметрі еленбейді

--upload-timeout

10m

Жіберуге арналған уақыт шектеуі

--additional-headers

—

'кілт: мән' форматындағы қосымша HTTP тақырыбы. Параметрді бірнеше рет көрсетуге болады

--skip-ssl

Пайдаланылмайды

Сервер сертификатын тексермеу. Өздігінен қол қойылған сертификаты бар орталарда пайдаланылады

Қайтару кодтары

Код

Мағынасы

0

Сәтті: есеп толық жиналды

1

Күтпеген қате

3

Пәрмен жолы аргументтеріндегі қате

4

Белгісіз команда берілді

6

Архивті жасау мүмкін болмады

7, 14

Директорияны жасау мүмкін болмады

8

Файлды жасау мүмкін болмады

9

Файлды жазу мүмкін болмады

10

Архивті жіберу мүмкін болмады

11, 12

Жұмыс директориясын анықтау мүмкін болмады

13

Директорияны жою мүмкін болмады

100

Есеп жиналып, жеткізілді, бірақ тексерулердің бір бөлігі деректер бермеді. Толығырақ collection.incomplete файлында

130

SIGINT (CTRL+C) арқылы тоқтатылды

143

SIGTERM арқылы тоқтатылды

Мақала пайдалы болды ма?