開發環境

客戶端

開發板：FireFly-RK3399

Linux 4.4

IP：192.168.137.110

服務端

VMware Workstation Pro16,ubuntu 18.04

IP:192.168.137.100

MAC0cc1ed

netconsole簡介

netconsole模塊可以讓printk信息（輸出到控制臺的信息）通過網絡（UDP）發送到遠程主機。

與串口控制臺不同，netconsole不需要串口線和串口。另外，它可以輕易地將多臺服務器的內核信息收集到一臺服務器上。

當設備上串口無法使用時，使用netconsole將日志信息保存到遠程主機更方便、可行。

netconsole模塊不能用于獲取crash dump，也不能進行一般的控制臺輸入輸出。

netconsole模塊不能獲得網絡相關的kernel panic，以及與操作系統啟動到網絡和netconsole模塊啟動之間發生的pnic相關的內核信息。

netconsole編譯

netconsole 可以獨立編譯為模塊手動加載，也可以編譯進內核自動加載，本例使用的是第一種。

編譯為獨立模塊

netconsole默認是沒有編譯進內核，需要手動編譯到內核或編譯成模塊。

在內核目錄下執行make menuconfig 開啟以下選項

DeviceDrivers>Networkdevicesupport>Networkconsoleloggingsupport

將內核重新編譯后燒寫到開發板上。

手動編譯netconsole模塊

makeCONFIG_NETCONSOLE=m-C/home/zhongyi/code/rk3399_linux_release_v2.5.1_20210301/kernelM=/home/zhongyi/code/rk3399_linux_release_v2.5.1_20210301/kernel/drivers/netmodulesCROSS_COMPILE=/home/zhongyi/code/rk3399_linux_release_v2.5.1_20210301/prebuilts/gcc/linux-x86/aarch64/gcc-linaro-6.3.1-2017.05-x86_64_aarch64-linux-gnu/bin/aarch64-linux-gnu-

之后，就會在模塊目錄下生成netconsole.ko的文件，這個文件就是我們所需的。

將netconsole編譯進內核

如自定義內核啟用netconsole只需將以下內核選項打開即可(編譯為模塊).

CONFIG_NETCONSOLE=m
CONFIG_NETCONSOLE_DYNAMIC=y

如果將netconsole編譯進內核自動加載，則需要在內核啟動參數中傳遞進去，并且還要確保網卡驅動在netconsole驅動前加載。

netconsole加載

將netconsole.ko通過共享目錄發送到開發板，給予權限，這個需要預先知道服務端的IP地址以及MAC地址。

日志服務器在同一內網, 直接通過ping獲取服務器目的MAC:

$ping-c1192.168.1.103>/dev/null
$arp-n192.168.1.103
AddressHWtypeHWaddressFlagsMaskIface
192.168.1.103ether08461d:82Ceth0
1234

日志服務器不在同一內網, 獲取網關目的MAC:

$netstat-rn|grep^0.0.0.0
0.0.0.0192.168.1.10.0.0.0UG000eth0
$ping-c1192.168.1.1>/dev/null
$arp-n192.168.1.1
AddressHWtypeHWaddressFlagsMaskIface
192.168.1.1ether00662a:3cC

執行加載指令

insmodnetconsole.konetconsole=6665@192.168.137.110/eth0,514@192.168.137.100/00299c:ed

各個參數含義如下

netconsole=src-port]@[src-ip]/[],[tgt-port]@/[tgt-macaddr]
wheresrc-portsourceforUDPpackets(defaultsto6665)#開發板上的端口，省略的話默認為6665
src-ipsourceIPtouse(interfaceaddress)#開發板上的IP地址
devnetworkinterface(eth0)#開發板上使用的網卡設備名
tgt-portportforloggingagent(6666)#目的機器的端口，省略的話默認為6666
tgt-ipIPaddressforloggingagent#目的機器的IP地址
tgt-macaddrethernetMACaddressforloggingagent(broadcast)#目的機器的MAC地址

rsyslog服務端設置

開啟514端口

客戶端設置好了，配置rsyslog以在服務器模式下運行

sudovim/etc/rsyslog.conf

取消注釋udp和tcp端口綁定的行：

#providesUDPsyslogreception
module(load="imudp")
input(type="imudp"port="514")

#providesTCPsyslogreception
module(load="imtcp")
input(type="imtcp"port="514")

測試端口是否能通

?~sudonc-vuz192.168.137.110514
Connectionto192.168.137.110514port[udp/syslog]succeeded!

創建接收模板

創建一個模板，指示rsyslog服務器如何存儲傳入的syslog消息，在GLOBAL DIRECTIVES部分之前添加模板：

$templateremote-incoming-logs,"/var/log/%HOSTNAME%/%fromhost-ip%-%$YEAR%-%$MONTH%-%$DAY%.log
*.*?remote-incoming-logs
&~

收到的日志將使用上面的模板進行解析并存儲在目錄/var/log/中，文件命名遵循約定：%HOSTNAME%/%fromhost-ip%-%$YEAR%-%$MONTH%-%$DAY%.log。

完成后保存并關閉文件。然后，使用以下命令檢查Rsyslog配置是否存在語法錯誤：

rsyslogd-f/etc/rsyslog.conf-N1

你應該看到以下輸出：

rsyslogd:version8.32.0,configvalidationrun(level1),masterconfig/etc/rsyslog.conf
rsyslogd:Endofconfigvalidationrun.Bye.

配置啟動文件

以root身份修改/etc/default/rsyslog啟動配置文件

RSYSLOGD_OPTIONS="-m0-r"

-r 選項以允許接受外來日志消息。

-x 禁用掉dns記錄項不夠齊全或其他的日志中心的日志。

-m 修改syslog的內部mark消息寫入間隔時間（0為關閉）。例如-m 180，表示每隔180分鐘（每天8次）在日志文件里增加一行時間戳消息。

-h 默認情況下，syslog不會發送從遠端接受過來的消息到其他主機，而使用該選項，則把該開關打開，所有接受到的信息都可根據syslog.conf中定義的@主機轉發過去。

重啟服務

重新啟動rsyslog服務以使更改生效：

sudosystemctlrestartrsyslog

確認服務是否正在偵聽已配置的端口：

ss-tunelp|grep514
udpUNCONN000.0.0.0:5140.0.0.0:*ino:178435sk:2c<->
udpUNCONN00[::]:514[::]:*ino:178436sk:2dv6only:1<->
tcpLISTEN0250.0.0.0:5140.0.0.0:*ino:178439sk:2e<->
tcpLISTEN025[::]:514[::]:*ino:178440sk:2fv6only:1<->

配置Rsyslog防火墻

如果你的ufw防火墻服務正在運行，請允許rsyslog防火墻端口：

sudoufwallow514/tcp
sudoufwallow514/udp

輸出測試

測試使用的是SysRq鍵在客戶端輸出內核信息。

在開發板上，修改/etc/sysctl.conf啟動SysRq。

kernel.sysrq=1

執行下列命令，使修改生效。

sysctl-p

執行下列命令向控制臺輸出內核信息。

root@firefly:~/mnt/module#echoh>/proc/sysrq-trigger
[10224.626165]sysrq:SysRq:HELP:loglevel(0-9)reboot(b)crash(c)terminate-all-tasks(e)memory-full-oom-kill(f)kill-all-tasks(i)thaw-filesystems(j)sak(k)show-backtrace-all-active-cpus(l)show-memory-usage(m)nice-all-RT-tasks(n)poweroff(o)show-registers(p)show-all-timers(q)unraw(r)sync(s)show-task-states(t)unmount(u)force-fb(V)show-blocked-tasks(w)dump-ftrace-buffer(z)

在服務器的/var/log/192.168.137.110目錄下即可看到生成的日志文件。

?192.168.137.110cat192.168.137.110-2022-10-16.log
2022-10-16T2254.777180+08:00192.168.137.110[10224.626165]sysrq:SysRq:
2022-10-16T2254.777180+08:00192.168.137.110loglevel(0-9)
2022-10-16T2254.777180+08:00192.168.137.110[10224.626165]sysrq:SysRq:
2022-10-16T2254.777180+08:00192.168.137.110loglevel(0-9)
2022-10-16T2254.777180+08:00192.168.137.110reboot(b)
2022-10-16T2254.777180+08:00192.168.137.110crash(c)
2022-10-16T2254.777180+08:00192.168.137.110reboot(b)
2022-10-16T2254.777180+08:00192.168.137.110crash(c)
2022-10-16T2254.777180+08:00192.168.137.110terminate-all-tasks(e)
2022-10-16T2254.777180+08:00192.168.137.110terminate-all-tasks(e)
2022-10-16T2254.777180+08:00192.168.137.110memory-full-oom-kill(f)
2022-10-16T2254.777180+08:00192.168.137.110memory-full-oom-kill(f)
2022-10-16T2254.777180+08:00192.168.137.110kill-all-tasks(i)
2022-10-16T2254.777180+08:00192.168.137.110kill-all-tasks(i)
2022-10-16T2254.777180+08:00192.168.137.110thaw-filesystems(j)
2022-10-16T2254.777180+08:00192.168.137.110thaw-filesystems(j)
2022-10-16T2254.777180+08:00192.168.137.110sak(k)
2022-10-16T2254.777180+08:00192.168.137.110sak(k)
2022-10-16T2254.777180+08:00192.168.137.110show-backtrace-all-active-cpus(l)
2022-10-16T2254.777180+08:00192.168.137.110show-backtrace-all-active-cpus(l)
2022-10-16T2254.777180+08:00192.168.137.110show-memory-usage(m)
2022-10-16T2254.777180+08:00192.168.137.110show-memory-usage(m)
2022-10-16T2254.777180+08:00192.168.137.110nice-all-RT-tasks(n)
2022-10-16T2254.777180+08:00192.168.137.110nice-all-RT-tasks(n)
2022-10-16T2254.777180+08:00192.168.137.110poweroff(o)
2022-10-16T2254.777180+08:00192.168.137.110poweroff(o)
2022-10-16T2254.777180+08:00192.168.137.110show-registers(p)
2022-10-16T2254.777180+08:00192.168.137.110show-registers(p)
2022-10-16T2254.777180+08:00192.168.137.110show-all-timers(q)
2022-10-16T2254.777180+08:00192.168.137.110show-all-timers(q)
2022-10-16T2254.777180+08:00192.168.137.110unraw(r)
2022-10-16T2254.777180+08:00192.168.137.110unraw(r)
2022-10-16T2254.777180+08:00192.168.137.110sync(s)
2022-10-16T2254.777180+08:00192.168.137.110sync(s)
2022-10-16T2254.777180+08:00192.168.137.110show-task-states(t)
2022-10-16T2254.777180+08:00192.168.137.110show-task-states(t)
2022-10-16T2254.777180+08:00192.168.137.110unmount(u)
2022-10-16T2254.777180+08:00192.168.137.110unmount(u)
2022-10-16T2254.777180+08:00192.168.137.110force-fb(V)
2022-10-16T2254.777180+08:00192.168.137.110force-fb(V)
2022-10-16T2254.777180+08:00192.168.137.110show-blocked-tasks(w)
2022-10-16T2254.777180+08:00192.168.137.110show-blocked-tasks(w)
2022-10-16T2254.900989+08:00192.168.137.110dump-ftrace-buffer(z)
2022-10-16T2254.900989+08:00192.168.137.110dump-ftrace-buffer(z)
2022-10-16T2254.900989+08:00192.168.137.110

若進入192.168.137.110目錄無權限，則執行 sudo chmod 777 192.168.137.110 賦予權限。

其他監聽方法

netcat

在沒有syslogd在運行的主機上可以使用 netcat/socat 接收來自遠程主機的消息:

nc-u-l-p/nc-u-l
netcat-u-l-p/netcat-u-l
socatudp-recv:-

舉例

~sudonetcat-l-p514-u
[sudo]passwordforzhongyi:
[263.748032]sysrq:SysRq:HELP:[263.748032]sysrq:SysRq:HELP:loglevel(0-9)loglevel(0-9)reboot(b)reboot(b)crash(c)crash(c)terminate-all-tasks(e)terminate-all-tasks(e)memory-full-oom-kill(f)memory-full-oom-kill(f)kill-all-tasks(i)kill-all-tasks(i)thaw-filesystems(j)thaw-filesystems(j)sak(k)sak(k)show-backtrace-all-active-cpus(l)show-backtrace-all-active-cpus(l)show-memory-usage(m)show-memory-usage(m)nice-all-RT-tasks(n)nice-all-RT-tasks(n)poweroff(o)show-registers(p)poweroff(o)show-registers(p)show-all-timers(q)show-all-timers(q)unraw(r)sync(s)show-task-states(t)unraw(r)sync(s)show-task-states(t)unmount(u)force-fb(V)unmount(u)force-fb(V)show-blocked-tasks(w)show-blocked-tasks(w)dump-ftrace-buffer(z)dump-ftrace-buffer(z)

dmesg

-n/--console-level 控制kernel message console 輸出級別, 設置輸出level為debug(-n 8):

dmesg-n8

uboot中的netconsole

uboot下的netconsole類似于kernel下的telnet等網絡終端功能，將網絡作為輸入輸出的終端，這樣就便于我們在PC端通過網絡登錄設備uboot中運行命令。

uboot下netconsole的實現在drivers/net/netconsole.c中，uboot開啟netconsole只需要在配置文件configs/firefly-rk3399_defconfig加入CONFIG_NETCONSOLE=y 即可。重新編譯uboot，燒寫到設備上。

設置環境變量nc，設置CONFIG_NETCONSOLE_BUFFER_SIZE覆蓋默認緩沖區大小，設置環境變量ncip為通信對端ip，格式為:，不設置時為默認值6666，發送端口和接收端口可以分別設置，ncinport和ncoutport，

setenvipaddr192.168.137.110
setenvnc'setenvstdoutnc;setenvstdinnc'
setenvncip192.168.137.100
saveenv
runnc

uboot進入netonsole模式，此時串口控制臺就沒有輸出了。

在服務器上執行

./tools/netconsole192.168.137.110

就可以在PC端運行uboot命令了。

審核編輯：劉清