supervisor环境变量

1. 问题描述：
   在使用airflow（1.9）的过程中，经常出现airflow scheduler中断的问题(改问题是访问mysql数据出错导致了，此处不做解释)。于是想到使用supervisor来管理scheduler，但是在使用supervisor过程中，scheduler的日志报包导入错误（ModuleNotFoundError）。
2. 排查原因：
   supervisor：版本3.3.5，python环境2.6.6
   airflow：版本1.9.0，python环境3.6.3
   supervisor的配置文件如下

   [program:airflow_scheduler]
   command=/usr/local/bin/python3 /usr/local/bin/airflow scheduler
   user=huner
   environment=AIRFLOW_HOME="/home/huner/airflow"
   stderr_logfile=/home/huner/airflow/airflow-scheduler.err.log
   stdout_logfile=/home/huner/airflow/airflow-scheduler.out.log
   

   ModuleNotFoundError使想到当初安装python包时使用的pip install XXX --user进行性的，使用这种方式安装的包会放到~/.local/下，因此不需要root权限。会不会是环境变量不正确导致python运行时不能找到~/.local/下安装的包？
   python模块导入从sys.path所包含的路径查找
   验证环境变量不正确，在shell中直接执行python3打印sys.path对比使用supervisor执行python3打印sys.path，发现supervisor得到的结果和直接执行果然PATH不一样，其中缺少了/home/sctele/.local/lib/python3.6/site-packages正是ModuleNotFoundError指向的package所在的位置。
   验证方法如下：
   第一步，创建python文件test.py，写入打印PATH的语句

   import sys
   print(sys.path)
   

   第二步，在shell中执行python3 test.py
   第三步，编写supervisor配置文件，在supervisor中执行

   [program:test_python3]
   command=/usr/local/bin/python3 /home/hunter/test.py
   user=hunter
   environment=AIRFLOW_HOME="/home/hunter/airflow"
   

3. 解决问题
   已经找到原因，环境变量sys.path缺失必要的值，只要把需要的值“加上”就可以了。
   在添加环境变量时，又遇到了问题，如何添加环境变量。
   python通过PYTHONPATH环境变量初始化sys.path，因此需要在编写supervisor配置文件时将指定PYTHONPATH，在PYTHONPATH中添加/home/sctele/.local/lib/python3.6/site-packages便可以在sys.path中添加需要的路径。

   [program:test_python3]
   command=/usr/local/bin/python3 /home/hunter/test.py
   user=hunter
   environment=AIRFLOW_HOME="/home/hunter/airflow", PYTHONPATH=/home/hunter/.local/lib/python3.6/site-packages
   

   需要说明的，这里设置的PYTHONPATH并不会导致sys.path中只有一条记录，而是会以附加的方式添加到sys.path。
4. 进一步探索
   为什么shell中执行时不需要设置PYTHONPATH，而supervisor需要呢？
   首先要了解一下python的import机制，python中的模块site负责模块导入路径的添加（Append module search paths for third-party packages to sys.path.）。查看其main方法，其中有一个addusersitepackages的动作，是导入当前用户的module search paths。进一步查看源码，是通过get_config_var('userbase')获取~/.local(sysconfig.py line 205)，而~代表就是环境变量HOME。
   所以我们可以通过添加HOME环境变量来让python正确的找到模块导入路径。

   [program:test_python3]
   command=/usr/local/bin/python3 /home/hunter/test.py
   user=hunter
   environment=AIRFLOW_HOME="/home/hunter/airflow", HOME=/home/hunter
   

5. 总结
   使用supervisor出现ModuleNotFoundError错误时是因为sys.path未加载所需模块所在的路径，可以通过设置environment来指明所需模块的路径。
   使用PYTHONPATH指明:
   environment=PYTHONPATH=/home/hunter/.local/lib/python3.6/site-packages
   对于用户python路径（pip install XXX --user安装的位置）(~/.local)，也可以通过指定HOME来让python找到模块所在的路径：
   environment=HOME=/home/hunter