Python is used for Beats development, it is the language used to implement system tests and some other tools. Python dependencies are managed by the use of virtual environments, supported by venv.
Beats development requires Python >= 3.7.
Python uses to be installed in many operating systems. If it is not installed in your system you can follow the instructions available in https://www.python.org/downloads/
In Ubuntu/Debian systems, Python 3 can be installed with:
sudo apt-get install python3 python3-venv
There are packages for specific minor versions, so for example if Python 3.7 wants to be used, it can be installed with the following command:
sudo apt-get install python3.7 python3.7-venv
It is recommended to use Python >= 3.7.
mage targets manage their own virtual environments in a transparent
way, so for the most common operations required when contributing to beats,
nothing special needs to be done.
Virtual environments used by
make can be found in most Beats directories under
build/python-env, they are created by targets that need it, or can be
explicitly created by running
make python-env. The ones used by
created when required under
There are some environment variables that can be used to customize the creation of these virtual environments:
PYTHON_EXE: Python executable to be used in the virtual environment. It has to exist in the path.
PYTHON_ENV: Path to the virtual environment to use. If it doesn’t exist, it is created by
magetargets when needed.
Virtual environments can also be used without
mage, this is usual
for example when running individual system tests with
pytest. There are two
ways to run commands from the virtual environment:
"Activating" the virtual environment in your current terminal running
source ./build/python-env/bin/activate. Virtual environment can be deactivated by running
Directly running commands from the virtual environment path. For example
pytestcan be executed as
To recreate a virtual environment, remove its directory. All virtual
environments are also removed with
Older versions of Beats were not compatible with Python 3, if you need to temporary work on one of these versions of Beats, and you don’t want to remove your current virtual environments, you can use environment variables to run commands in a temporary virtual environment.
For example you can run
make update with Python 2.7 with the following
PYTHON_EXE=python2.7 PYTHON_ENV=/tmp/venv2 make update
If you need to run tests you can also create a virtual environment and then activate it to run commands from there:
PYTHON_EXE=python2.7 PYTHON_ENV=/tmp/venv2 make python-env source /tmp/venv2/bin/activate ...