Tampa
Tampa

Reputation: 78244

Supervisor and Environment Variables

I really don't know how to get supervisor to work with environment variables.

Below is a configuration snippet.

[program:htNotificationService]
priority=2
#autostart=true
#autorestart=true
directory=/home/ubuntu/workspace/htFrontEnd/heythat/htsite
command = /usr/bin/python htNotificationService.py -service
stdout_logfile=/var/log/heythat/htNotificationService.log
redirect_stderr=true
environment=PATH=/home/ubuntu/workspace/htFrontEnd/heythat
stopsignal=QUIT

I have tried the following:

environment=PATH=/home/ubuntu/workspace/htFrontEnd/heythat
environment=PYTHONPATH=$PYTHONPATH:/home/ubuntu/workspace/htFrontEnd/heythat
environment=PATH=/home/ubuntu/workspace/htFrontEnd/heythat,PYTHONPATH=$PYTHONPATH:/home/ubuntu/workspace/htFrontEnd/heythat

When I start supervisor I get

htNotificationService: ERROR (abnormal termination)

I can start from the shell by setting the python path, but not from supervisor. In the logs I get an error that says that an import can't be found. Well, that would be solved if supervisor would work. I even have the path in /etc/environments?

Why will supervisor not work?

Upvotes: 104

Views: 137137

Answers (6)

Michael Ekoka
Michael Ekoka

Reputation: 20078

Sometimes, I find shell scripts more convenient to set up the environment.

So instead of this

[program:htNotificationService]
priority=2
directory=/home/ubuntu/workspace/htFrontEnd/heythat/htsite
command = /usr/bin/python htNotificationService.py -service
stdout_logfile=/var/log/heythat/htNotificationService.log
redirect_stderr=true
environment=PATH=/home/ubuntu/workspace/htFrontEnd/heythat
stopsignal=QUIT

I might have this in supervisor

[program:htNotificationService]
priority=2
directory=/home/ubuntu/runscripts/heythat/htsite
command = htNotificationService.sh 
stdout_logfile=/var/log/heythat/htNotificationService.log
redirect_stderr=true
stopsignal=QUIT

And htNotification.sh

#!/usr/bin/env bash

# change to directory
cd /home/ubuntu/workspace/htFrontEnd/heythat/htsite

# export environment variables here   
set -a
PATH=/home/ubuntu/workspace/htFrontEnd/heythat
USER=joe       # if it's needed
HOME=/home/joe # if it's needed
...
set +a

# or alternatively, source a separate environment file
source /home/ubuntu/.envs/htFrontEnd/heythat/htsite/development

# run the program
/usr/bin/python htNotificationService.py -service

Upvotes: 0

edibleEnergy
edibleEnergy

Reputation: 1849

Referencing existing env vars is done with %(ENV_VARNAME)s

See: https://github.com/Supervisor/supervisor/blob/master/supervisor/skel/sample.conf

Setting multiple environment variables is done by separating them with commas

See: http://supervisord.org/subprocess.html#subprocess-environment

Try:

environment=PYTHONPATH=/opt/mypypath:%(ENV_PYTHONPATH)s,PATH=/opt/mypath:%(ENV_PATH)s

Upvotes: 145

twiclo
twiclo

Reputation: 659

I know this is old but I just struggled with this for hours and wanted to maybe help out the next guy.

Don't forget to reload your config files after making updates

supervisorctl reread
supervisorctl update

Upvotes: 31

FuzzyAmi
FuzzyAmi

Reputation: 8119

this works for me. note the tabs before each line:

environment=
    CLOUD_INSTANCE_NAME=media-server-xx-xx-xx-xx,
    CLOUD_APPLICATION=media-server,
    CLOUD_APP_COMPONENT=none,
    CLOUD_ZONE=a,
    CLOUD_REGION=b,
    CLOUD_PRIVATE_IP=none,
    CLOUD_PUBLIC_IP=xx.xx.xx.xx,
    CLOUD_PUBLIC_IPV6=xx.xx.xx.xx.xx.xx,
    CLOUD_PROVIDER=c

Upvotes: 29

gogasca
gogasca

Reputation: 10058

If you install supervisor from a package installer, check which Supervisor version you are using. As of August 2016 you will get 3.0b2. If this is the case you will need a newer version of supervisor. You can get it by installing supervisor manually or by using Python's pip. Make sure all the dependencies are met, along with the upstart setup so that supervisord works as a service and starts on system boot.

Upvotes: 7

Shankar ARUL
Shankar ARUL

Reputation: 13710

In your .conf file under the supervisord block, you can add all the environment key=value pairs as such

[supervisord]
environment=CELERY_BROKER_URL="amqp://guest:[email protected]:5672//",FLASK_CONFIG="TESTING"

[program:celeryd]
command=celery worker -A celery --loglevel=info -P gevent -c 1000

If you dont want to hardcode the variables but want to pull it in from the os environment, step 1 on your bash

Export env var

>> sudo export CELERY_BROKER_URL="amqp://guest:[email protected]:5672//"

Reload Bash

>> . ~/.bashrc

Check if env vars are set properly

>> env

Now modify the conf file to read - Note: prepend your env variables with ENV_

[supervisord]
environment=CELERY_BROKER_URL="%(ENV_CELERY_BROKER_URL)s",FLASK_CONFIG="%(ENV_FLASK_CONFIG)s"

[program:celeryd]
command=celery worker -A celery --loglevel=info -P gevent -c 1000

Upvotes: 44

Related Questions