実用的なロギングソリューション
包括的なロギング戦略
堅牢なロギング戦略を開発するには、アプリケーションの効果的な監視とデバッグを確保するために、複数のコンポーネントと考慮事項が必要です。
集中型ロギング設定
import logging
import logging.config
import yaml
def setup_logging(config_path='logging.yaml'):
"""
Configure logging from YAML configuration file
"""
try:
with open(config_path, 'rt') as f:
config = yaml.safe_load(f.read())
logging.config.dictConfig(config)
except Exception as e:
print(f"Error loading logging configuration: {e}")
logging.basicConfig(level=logging.INFO)
ロギング設定例 (YAML)
version: 1
formatters:
standard:
format: "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
handlers:
console:
class: logging.StreamHandler
level: INFO
formatter: standard
file:
class: logging.handlers.RotatingFileHandler
level: DEBUG
formatter: standard
filename: app.log
maxBytes: 10485760
backupCount: 5
loggers:
"":
handlers: [console, file]
level: DEBUG
ロギング戦略の比較
| 戦略 |
利点 |
欠点 |
最適なシチュエーション |
| コンソールロギング (Console Logging) |
シンプルで即時フィードバックが得られる |
持続性が限られる |
開発段階 |
| ファイルロギング (File Logging) |
永続的な記録が残る |
パフォーマンスのオーバーヘッドがある |
中小規模のアプリケーション |
| 集中型ロギング (Centralized Logging) |
拡張性があり、集約されたログが得られる |
設定が複雑 |
分散システム |
コンテキスト付きロギングデコレータ
import logging
import functools
import contextvars
## Create a context variable for tracking request ID
request_id = contextvars.ContextVar('request_id', default='unknown')
def log_with_context(logger=None):
"""
Decorator to add contextual information to logs
"""
if logger is None:
logger = logging.getLogger(__name__)
def decorator(func):
@functools.wraps(func)
def wrapper(*args, **kwargs):
extra = {
'request_id': request_id.get()
}
try:
logger.info(
f"Executing {func.__name__}",
extra=extra
)
result = func(*args, **kwargs)
logger.info(
f"{func.__name__} completed successfully",
extra=extra
)
return result
except Exception as e:
logger.exception(
f"Error in {func.__name__}",
extra=extra
)
raise
return wrapper
return decorator
分散システムにおけるロギングワークフロー
graph TD
A[Client Request] --> B[Generate Request ID]
B --> C[Log Request Start]
C --> D[Service Processing]
D --> E[Log Intermediate Steps]
E --> F{Process Successful?}
F -->|Yes| G[Log Success]
F -->|No| H[Log Error]
G --> I[Return Response]
H --> I
高度なロギング技術
-
構造化ロギング (Structured Logging)
- JSON またはキーバリュー形式を使用する
- ログの解析と分析を容易にする
-
ログサンプリング (Log Sampling)
- 高トラフィックのアプリケーションでロギング量を削減する
- 代表的なログエントリをキャプチャする
-
動的ログレベル調整 (Dynamic Log Level Adjustment)
- 実行時にログレベルを変更する
- 異なる環境に適応する
実用的なロギングの実装
import logging
from pythonjsonlogger import jsonlogger
class CustomJsonFormatter(jsonlogger.JsonFormatter):
def process_log_record(self, log_record):
## Add custom fields or transform existing ones
log_record['service'] = 'LabEx Application'
return log_record
def configure_json_logging():
logger = logging.getLogger()
json_handler = logging.StreamHandler()
formatter = CustomJsonFormatter(
'%(asctime)s %(levelname)s %(message)s %(request_id)s'
)
json_handler.setFormatter(formatter)
logger.addHandler(json_handler)
ベストプラクティス
- 構造化ロギングを使用する
- ログローテーションを実装する
- コンテキスト情報を含める
- 詳細度とパフォーマンスのバランスを取る
- 適切なログレベルを使用する
- 機密情報を保護する
これらの実用的なロギングソリューションを実装することで、開発者は LabEx が推奨するアプローチを使用して、より観測可能で保守しやすいアプリケーションを作成することができます。
