feat(performance): add simple django scenario (#2553)

* feat(performance): add django-simple scenario

* fix ddtrace version install

* Update benchmarks/docker/django_simple/start

Co-authored-by: Gabriele N. Tornetta <[email protected]>

* Update benchmarks/docker/django_simple/start

Co-authored-by: Gabriele N. Tornetta <[email protected]>

* fixes

* add profiler variant

* doc update

* move out of docker dir

* profiling, statsd, summary

* add tracer+profiler variant

* major rework with sirun and jq for summary

* major rework with sirun and jq for summary

* fewer sirun iterations

* fix profiler variant

* cleanup

* use yaml config for sirun

Co-authored-by: Gabriele N. Tornetta <[email protected]>
Co-authored-by: crysmags <[email protected]>
Co-authored-by: Brett Langdon <[email protected]>

Author: 4 people

benchmarks/__init__.py

@@ -0,0 +1,97 @@
+ARG PYTHON_VERSION=3.9-slim-buster
+
+# define an alias for the specfic python version used in this file.
+FROM python:${PYTHON_VERSION} as python
+
+# Python build stage
+FROM python as python-build-stage
+
+# Install apt packages
+RUN apt-get update && apt-get install --no-install-recommends -y \
+  # dependencies for building Python packages
+  build-essential \
+  # need git for pip installs
+  git
+
+# Requirements are installed here to ensure they will be cached.
+COPY ./requirements.txt .
+
+# Create Python Dependency and Sub-Dependency Wheels.
+RUN pip wheel --wheel-dir /usr/src/app/wheels  \
+  -r requirements.txt
+
+# Python 'run' stage
+FROM python as python-run-stage
+
+ARG APP_HOME=/app
+
+ENV PYTHONUNBUFFERED 1
+ENV PYTHONDONTWRITEBYTECODE 1
+
+WORKDIR ${APP_HOME}
+
+RUN addgroup --system django \
+    && adduser --system --ingroup django django
+
+# Install required system dependencies
+RUN apt-get update && apt-get install --no-install-recommends -y \
+  # Translations dependencies
+  gettext \
+  # other dependencies
+  procps \
+  curl \
+  # dependencies for installing Python packages from git
+  build-essential \
+  git \
+  # cleaning up unused files
+  && apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false \
+  && rm -rf /var/lib/apt/lists/*
+
+# All absolute dir copies ignore workdir instruction. All relative dir copies are wrt to the workdir instruction
+# copy python dependency wheels from python-build-stage
+COPY --from=python-build-stage /usr/src/app/wheels  /wheels/
+
+# sirun
+RUN curl -sL https://github.com/DataDog/sirun/releases/download/v0.1.8/sirun-v0.1.8-x86_64-unknown-linux-gnu.tar.gz | tar zxf - -C /tmp && mv /tmp/sirun /usr/bin
+
+# k6
+RUN curl -SL https://github.com/k6io/k6/releases/download/v0.32.0/k6-v0.32.0-linux-amd64.tar.gz | tar zxf - -C /tmp && mv /tmp/k6-v0.32.0-linux-amd64/k6 /usr/bin
+
+# jq
+RUN curl -L -o /usr/bin/jq https://github.com/stedolan/jq/releases/download/jq-1.6/jq-linux64 && \
+  chmod +x /usr/bin/jq
+
+# copy application code to WORKDIR
+COPY --chown=django:django . ${APP_HOME}
+
+# make django owner of the WORKDIR directory as well.
+RUN chown django:django ${APP_HOME}
+
+# top level directory for artifacts
+ARG ARTIFACTS=/artifacts
+RUN mkdir -p ${ARTIFACTS}
+RUN chown django:django ${ARTIFACTS}
+
+USER django
+
+# Create venv
+ENV VIRTUAL_ENV=/app/venv
+RUN python3 -m venv $VIRTUAL_ENV
+ENV PATH="$VIRTUAL_ENV/bin:$PATH"
+
+# use wheels to install python dependencies
+RUN pip install --no-cache-dir --no-index --find-links=/wheels/ /wheels/*
+
+# Run migrations in image creation as data will not change during run
+RUN python /app/manage.py collectstatic --noinput \
+    && python /app/manage.py migrate
+
+# For performance testing
+ENV DDTRACE_GIT_COMMIT_ID ""
+ENV DDTRACE_WHEELS ""
+ENV WEB_CONCURRENCY 1
+ENV SIRUN_NO_STDIO 0
+ENV K6_STATSD_ENABLE_TAGS "true"
+
+ENTRYPOINT ["/app/entrypoint"]
+CMD ["/app/benchmark"]

benchmarks/django_simple/Dockerfile

@@ -0,0 +1,32 @@
+Simple Django Performance Scenario
+==================================
+
+This application image uses a simple Django application for performance testing ``ddtrace``.
+
+Build
+-----
+
+Use docker to build the image which will run tests and store output in an artifacts directory::
+
+  docker build -t django_simple benchmarks/django_simple/
+
+Run
+---
+
+To run, execute::
+
+  docker run -it --rm django_simple
+
+If you want to save the output, mount a volume to ``/app/output``::
+
+  docker run -it --rm -v "/path/to/output":"/artifacts/output" django_simple
+
+This image will by default install the release version of ``ddtrace``.
+
+You can install a different version by using git tags or commit hashes as the value for the ``DDTRACE_GIT_COMMIT_ID`` environment variable::
+
+  docker run -it --rm -e "DDTRACE_GIT_COMMIT_ID=v0.48.1" django_simple
+
+You can also install from a set of wheel by mounting a volume with the necessary wheels and setting the ``DDTRACE_WHEELS`` environment variable::
+
+  docker run -it --rm  -e "DDTRACE_WHEELS=/artifacts/wheels" -v "/path/to/wheels/":"/artifacts/wheels/" django_simple

benchmarks/django_simple/README.rst

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+set -o errexit
+set -o pipefail
+set -o nounset
+
+mkdir -p /artifacts/output/
+
+# cleanup any existing output artifacts
+rm -f /artifacts/output/*.*
+
+sirun meta.yaml | tee /artifacts/output/sirun.ndjson
+
+jq -s -f summarize_sirun.jq /artifacts/output/sirun.ndjson | tee /artifacts/output/summary_sirun.json
+jq -s -f summarize_k6.jq /artifacts/output/k6.ndjson | tee /artifacts/output/summary_k6.json
+
+# keep process alive before exiting
+# FIXME: remove once artifacts can be uploaded when run in CI
+sleep 30m