エラーログの出力方法について

Question

サーバー側で発生したエラーの詳細をログに書き出す方法について、少々お伺いしたいです。
例えば、未定義の変数を参照していた場合などに、何行目でエラーが起きているかなどログファイルへ出力させたいと考えております。
こちらの記事など読んでいて、logger.log(20, 'info')などを記述し、出力したいログを出力する方法は分かったのですが、実際に変数の参照エラーなどが発生した際に、その内容を出力させる方法が分からない状況です。
どなたか、こちらの問題につきまして、解決する方法を探している為、ご助言頂けましたら幸いです。

Answer 1

実際に変数の参照エラーなどが発生した際に、その内容を出力させる方法が分からない状況です。

エラーが発生した場合、例外が送出されるので、ログを出力させたい場所で try - except 文で例外を捕捉し、エラー内容を出力すればいいとおもいます。
スタックトレースは traceback モジュールで取得できるので、必要な情報を適宜整形してログに出力すればいいとおもいます。

import logging
import traceback

def func():
    print(x)  # x は未定義

try:
    func()
except Exception as e:
    msg = traceback.format_exc()
    logging.error(msg)

追記

こちらは、例外が発生した際に、except文をいくつか書いていた場合に、上のexcept文の処理が実行されるといった解釈で良かったでしょうか...?

例えば、main() から func1() を呼び出し、func1() から func2() を呼び出しているとして、func2() 内で例外が発生したとします。
その場合、例外は func2() -> func1() -> main() と except で捕捉されるまで呼び出しもとに再送出されていくので、一番上位側 (この場合 main()) に try~except を入れておけばよいという意味です。

def func2():
    raise Exception("Error")


def func1():
    func2()


def main():
    try:
        func1()
    except Exception as e:
        print(e)
        
main()

Comments

[ruuuu]

ご回答ありがとうございます。
例えばなのですが、サーバー上で処理が止まってしまっている状況で、どこでエラーが起きているか分からない場合などでも、全体的に、try-except文で囲ってエラーを出力させる形になりますでしょうか？

[tiitoi]

バッググラウンドでスクリプトを起動してエラーが出て止まるけど、どこでエラーが発生したのかわからないということでしょうか？
Linux であれば、コードを弄るのではなく、python sample.py &> log.txt のように標準出力、標準エラー出力をファイルに書き出すようにしてスクリプトを起動すればいいのではないでしょうか

[ruuuu]

>バッググラウンドでスクリプトを起動してエラーが出て止まるけど、どこでエラーが発生したのかわからないということでしょうか？
はい。つい先日こちらのケースが起きてしまいまして、コードを最初から追いかけなくてはならず、少々苦労したことがあった為、こちらの問題を解決出来たらと考えております。

>Linux であれば、コードを弄るのではなく、python sample.py &> log.txt のように標準出力、標準エラー出力をファイルに書き出すようにしてスクリプトを起動すればいいのではないでしょうか
こちらですが、具体的には「 https://teratail.com/questions/310248 」前回の質問で詳しく記載させて頂いておりました。
簡単にご説明しますと、LINEボットの開発なのですが、「python sample.py 」こちらのような形での検証が出来ない為、どうすれば良いか解決策を模索しているといった状況でした。

[tiitoi]

「LINEボットの開発」をしたことがないのでどのような手順で書いたスクリプトが実行されているのかわかりませんが、「try-except文で例外をキャッチしてログを出力する方式」の場合、プログラムのエントリポイント (プログラムが開始する部分) あたりに「例外を捕捉してログファイルに書き出すコード」を書いておけばよいと思います。
try ~ except は try 節内で発生した例外は捕捉可能なので、上位側にこれを仕込んでおけばいいです。

[ruuuu]

>「try-except文で例外をキャッチしてログを出力する方式」の場合、プログラムのエントリポイント (プログラムが開始する部分) あたりに「例外を捕捉してログファイルに書き出すコード」を書いておけばよいと思います。
こちらですが、そうなりますとコード全体をtry-exceptのtryブロックに入れ込むといった解釈で合っていますでしょうか...?

[tiitoi]

確認ですが、Python の例外の仕組み (捕捉されるまで上位に再送出されていくなど) について理解されていますでしょうか。もしされていない場合はまずそちらを勉強してください。

https://docs.python.org/ja/3/library/exceptions.html
https://python.keicode.com/lang/python-exception-handling.php

> そうなりますとコード全体をtry-exceptのtryブロックに入れ込むといった解釈で合っていますでしょうか...?

それであっています。例外が発生した場合、捕捉されるまでどんどん上位に投げられるので、一番上位の部分に try~except を入れておけばよいです。

[ruuuu]

度々すみません。
ご返信頂きありがとうございます。
>例外が発生した場合、捕捉されるまでどんどん上位に投げられるので
こちらは、例外が発生した際に、except文をいくつか書いていた場合に、上のexcept文の処理が実行されるといった解釈で良かったでしょうか...?

>それであっています。例外が発生した場合、捕捉されるまでどんどん上位に投げられるので、一番上位の部分に try~except を入れておけばよいです。
ありがとうございます。
早速、try-except文を使用し、エラーの出力がなされるか検証してみたいと思います。

[tiitoi]

> こちらは、例外が発生した際に、except文をいくつか書いていた場合に、上のexcept文の処理が実行されるといった解釈で良かったでしょうか...?

そういう意味ではないです。
回答にコード例と説明を追加しました。
これでわかりますでしょうか？

[ruuuu]

追記の方、拝見させて頂きました。
ご丁寧にご説明下さりましたおかげで、理解することが出来ました。
大変、勉強になりました。
度々のご質問にも関わらず、ご親切に教えて下さりありがとうございました。

[ruuuu]

度々恐縮なのですが、ログについて、追加でお聞きしたいことがあるのですが、処理の全体を念の為「try-catch」で囲って置くというのはあまり行われないことなのでしょうか...?
現在Djangoでバックエンド側を開発しているのですが、本番環境でもスクリプトで問題があった際に、「try-except」で全体を囲って置けば何かエラーが発生した際にも便利ではないかと考えております。
しかし、自分は実務経験も少ないというのもあり、あまりそういったコードを見たことがなく、実際どうなのかが分からず正しいのかどうなのかが分からないといった状況なのですよね...

[ruuuu]

何かエラーがあった際も、スタックトレースがアプリケーションサーバー(uwsgi)のログとして出力されるよりも、ロガーによりファイル出力を行えれば確認し易いというメリットもあるのではないかと思っています

[javahack]

一旦解決した質問であれば、新たな疑問は別途質問を立てた方が良いと思います。

[ruuuu]

「 https://teratail.com/questions/324205　」こちらで新たに立てました！