[파이썬] Flask를 이용한 로깅과 모니터링

01 Sep 2023

python

Flask는 웹 애플리케이션을 개발하기 위한 빠르고 유연한 프레임워크로, 로깅과 모니터링 기능을 통해 애플리케이션을 더욱 안정적으로 운영할 수 있습니다. 이번 블로그 포스트에서는 Flask 앱의 로깅 설정, 에러 처리 및 모니터링 방법에 대해 알아보겠습니다.

로깅 설정하기

Flask는 Python의 기본 로깅 모듈인 logging을 사용하여 로그를 기록합니다. 로깅 모듈은 app.logger를 통해 애플리케이션 로그에 접근할 수 있습니다. Flask 앱의 로깅 레벨은 기본적으로 WARNING이며, 필요에 따라 app.logger.setLevel(logging.DEBUG)와 같이 로깅 레벨을 조정할 수 있습니다.

import logging
from flask import Flask

app = Flask(__name__)

# 로깅 레벨 설정
app.logger.setLevel(logging.DEBUG)

@app.route('/')
def hello():
    app.logger.debug('This is a debug log')
    app.logger.info('This is an info log')
    app.logger.warning('This is a warning log')
    app.logger.error('This is an error log')
    return 'Hello, World!'

if __name__ == '__main__':
    app.run()

로깅 레벨을 DEBUG로 설정하면, 로그에는 DEBUG, INFO, WARNING, ERROR 수준의 로그가 기록됩니다. 필요에 따라 로그 포맷, 출력 위치 등을 추가로 설정할 수도 있습니다.

에러 처리하기

Flask 앱은 @app.errorhandler 데코레이터를 사용하여 특정 예외 상황에 대한 에러 핸들러를 지정할 수 있습니다. 이를 통해 앱의 에러 처리 로직을 구현할 수 있습니다.

from flask import Flask, jsonify

app = Flask(__name__)

@app.errorhandler(404)
def not_found_error(error):
    return jsonify({'error': 'Not Found'}), 404

@app.route('/user/<int:user_id>')
def get_user(user_id):
    if user_id == 1:
        return jsonify({'user_id': user_id, 'name': 'John Doe'})
    else:
        # 404 에러 발생
        abort(404)

if __name__ == '__main__':
    app.run()

위의 예제에서는 /user/<int:user_id> 엔드포인트에서 사용자 정보를 조회하는 API를 구현하였습니다. 만약 user_id가 1인 경우에는 해당 사용자 정보를 반환하고, 그 외의 경우에는 404 에러를 발생시킵니다. 이후 @app.errorhandler(404) 데코레이터를 사용하여 404 에러에 대한 에러 핸들러를 정의하고, JSON 응답으로 ‘Not Found’ 에러를 반환하게 됩니다.

모니터링하기

Flask 앱의 모니터링을 위해 다양한 도구와 라이브러리를 사용할 수 있습니다. 예를 들어, Flask-RESTful을 이용하여 API 엔드포인트의 성능, 응답 시간 등을 모니터링할 수 있습니다. 또한, Flask-Sentry와 같은 라이브러리를 활용하여 앱의 예외 상황을 모니터링하고 로그를 수집할 수도 있습니다.

from flask import Flask
from flask_restful import Resource, Api

app = Flask(__name__)
api = Api(app)

class HelloWorld(Resource):
    def get(self):
        return {'message': 'Hello, World!'}

api.add_resource(HelloWorld, '/')

if __name__ == '__main__':
    app.run()

위의 예제는 Flask-RESTful을 사용하여 간단한 API를 구현한 것입니다. Flask-RESTful의 장점은 API 엔드포인트의 성능 측정, 요청 로그 등을 쉽게 수집하고 모니터링할 수 있다는 점입니다.

결론

Flask를 이용하여 로깅과 모니터링 기능을 구현하면 애플리케이션의 안정성을 높일 수 있습니다. 로깅을 통해 앱의 동작을 추적하고 디버깅할 수 있으며, 에러 처리와 모니터링을 통해 사용자에게 안정적인 서비스를 제공할 수 있습니다. Flask의 다양한 확장과 라이브러리들을 활용하여 앱의 로깅과 모니터링 기능을 더욱 강화해보세요.