[Python] Docker コンテナ内のアプリのログをホストの Syslog に追加する

Fri, 24 Dec 2021 00:00:00 +0900

docker コンテナ内で動作している python アプリのログをホストの syslog に追加します。

Ubuntu 20.04 で作業しましたが、rsyslog は最初からインストールされていました。

概要

Python 標準の logging モジュールに syslog 出力用のハンドラ SysLogHandler があるので、アプリ側ではそれを指定するだけで OK です。

Syslog はホストに対して UDP でログを送信して追加します。
理由は以下です。

docker コンテナ内でアプリを動かしているので、今後コンテナが増えたときコンテナごとに rsyslog を設定してやるのが面倒そう
各コンテナのログを一箇所に集約したい
syslog の記録には TCP or UDP のポート 514 が使用されるらしいが、SysLogHandler では UDP しか対応していないよう

rsyslog の設定変更

UDP のポート514 でログを待ち受けるように設定を変更します。

/etc/rsyslog.conf を編集します。

$ sudo gedit /etc/rsyslog.conf

以下の２行のコメントを外します。

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

変更後は再起動します。

$ sudo systemctl restart rsyslog

アプリ側の実装

ログに関する設定を logging.yaml に切り出しています。

https://kuttsun.blogspot.com/2021/12/python_21.html

その前提のうえで、以下のように指定するだけでログが UDP で送信されるようになります。

root:
 level: DEBUG
 handlers: [syslog]
handlers:
 syslog:
 class: logging.handlers.SysLogHandler
 formatter: syslog_format
 address: ['host.docker.internal', 514]
 #address: '/dev/log'
 level: INFO
formatters:
 syslog_format:
 format: 'appname: %(module)s %(message)s'

IPアドレスについては、docker コンテナからホストのIPアドレスを参照する必要があるので host.docker.internal を指定します。
（localhost はコンテナ自身を指すので使えない)
ちなみに host.docker.internal はもともと Windows と Mac でしか使えませんでしたが、最近 Linux でも使えるようになったそうです。

https://qiita.com/skobaken/items/03a8b9d0e443745862ac

これ使えなかったら直接IPアドレスを指定しないといけなくなり、ホストのIPアドレスが変わるたびに修正しないといけなくてマジ困ります。ってかこれを知るまでずっと困ってました。

参考 URL

Syslog を Telegraf に送り、Grafana で閲覧できるようにする

Mon, 20 Dec 2021 00:00:00 +0900

以下に Syslog 用のテンプレートと解説があるので簡単にできるかと思ったんですが、結構苦労しました・・・。

https://grafana.com/grafana/dashboards/12433

概要

ホストの Syslog から Telegraf にログを送り、Telegraf が InfluxDB に保存し、Grafana が InfluxDB から読み込んで可視化します。

Telegraf、InfluxDB、Grafana は全て docker-compose で動かしています。
これについては以下の記事で書いているので省略します。

https://kuttsun.blogspot.com/2021/12/telegraf-influxdb-garafana.html

上記記事からの変更点を以下に記述します。

rsyslog の設定

まずは Syslog から Telegraf にログを送信するように設定します。
/etc/rsyslog.conf を編集します。

$ sudo gedit /etc/rsyslog.conf

以下の設定を追加します。

$WorkDirectory /var/spool/rsyslog 
$ActionQueueType LinkedList 
$ActionQueueFileName srvrfwd 
$ActionResumeRetryCount -1 
$ActionQueueSaveOnShutdown on 
$ModLoad imudp #loads the udp module 
$UDPServerAddress localhost 
$UDPServerRun 514
*.* @@(o)127.0.0.1:6514;RSYSLOG_SyslogProtocol23Format

rsyslog を再起動します。

$ sudo systemctl restart rsyslog

Telegraf の設定

telegraf.conf に以下の設定を追加します。

[[inputs.syslog]]
 server = "tcp://0.0.0.0:6514"

Syslog から TCP ポート 6514 で受信するように設定していますが、docker で動かしているので localhost を指定すると上手く動作しません。
とりあえず 0.0.0.0 を指定しましたが、もしかしたら host.docker.internal とかでもいけるのかもしれません（未確認）。

docker-compose.yaml の変更

ポート 6514 を使用できるようにします。

services:
 telegraf:
 container_name: telegraf
 image: telegraf
 ports:
 - 6514:6514

docker コンテナを再起動します。

Grafana の設定

以下のページからダッシュボードの JSON ファイルをダウンロードしてインポートするだけです。

https://grafana.com/grafana/dashboards/12433

これで以下のようなダッシュボードが完成します。

Syslog on ポンコツ地方エンジニアの技術ブログ

[Python] Docker コンテナ内のアプリのログをホストの Syslog に追加する

概要

rsyslog の設定変更

アプリ側の実装

参考 URL

Syslog を Telegraf に送り、Grafana で閲覧できるようにする

概要

rsyslog の設定

Telegraf の設定

docker-compose.yaml の変更

Grafana の設定

参考 URL