SAM本地运行Python Lambda时环境检测及控制台无日志输出问题求解

1. 检测SAM本地运行环境的方法 #

SAM本地启动Lambda时会自动注入环境变量AWS_SAM_LOCAL，值固定为true，你可以在初始化阶段直接读取该环境变量判断：

import os

def is_running_in_sam_local() -> bool:
    return os.environ.get("AWS_SAM_LOCAL") == "true"

该方法无额外依赖，在代码初始化阶段即可正常调用。

2. 本地运行日志不输出的其他解决方案 #

你遇到的日志不输出问题，大概率是两个原因导致：一是SAM本地运行时默认对容器输出做了缓冲，二是Python的logging.basicConfig在根日志器已有Handler的场景下不会生效。可以按优先级尝试以下方案：

• 启动sam local时添加--debug参数，命令变为sam local start-api -p 8080 --debug，该参数会关闭输出缓冲，直接输出容器所有stdout、stderr内容到控制台，大部分场景下可直接解决问题。
• 启动命令添加环境变量参数关闭Python输出缓冲：sam local start-api -p 8080 --container-env PYTHONUNBUFFERED=1
• 调整日志初始化逻辑，先清空根日志器已有Handler再配置自己的规则，避免原有配置冲突：

import logging as log
import sys

# 清空根日志器已有Handler，解决basicConfig不生效问题
for handler in log.getLogger().handlers[:]:
    log.getLogger().removeHandler(handler)

# 重新配置日志规则
log.basicConfig(
    level=log.INFO,
    handlers=[log.StreamHandler(sys.stderr)]
)

• 若以上方案都不满足需求，可配合sam local的目录挂载参数，将本地目录挂载到Lambda容器内，日志直接写入挂载目录的文件中，本地即可实时查看。

3. 日志配置的生效范围 #

你给出的代码操作的是根日志器（调用getLogger()时未传入名称），默认会全局生效：

• 所有没有单独配置日志级别、自定义Handler的子模块，只要是通过标准logging.getLogger(__name__)方式获取日志器，都会继承根日志器的INFO级别配置，日志也会输出到你添加的StreamHandler中。
• 如果某一个子模块单独设置了自己的日志级别、或者添加了独立的Handler，该子模块的日志会优先使用自身的配置，不会完全遵循根日志器的规则。

内容的提问来源于stack exchange，提问作者Andreas