kocsismate/di-container-benchmarks

Benchmarks of some popular PHP DI Containers

dev-master 2021-06-19 11:12 UTC

This package is auto-updated.

Last update: 2024-11-30 01:36:43 UTC


README

Software License Gitter

Table of Contents

Introduction

In 2014, a really interesting benchmark about DI Containers for PHP was published on Sitepoint. Unfortunately, the implementation of the tests turned out to be quite controversial, so the benchmark itself wasn't really insightful.

I have been interested in the topic since then so I wanted to conduct another benchmark that also tries to measure real-life performance, while being as unbiased and reliable as possible.

Results

You can find the benchmark results here.

Install

You can simply download or clone this repository as well as install it via Composer by running the command below:

$ composer require kocsismate/di-container-benchmarks:dev-master

Usage

Usage with Docker

As a prerequisite, Docker Compose and at least Docker 17.06 CE has to be installed on your machine in order to use this benchmark method.

Copy the .env.dist file to .env and feel free to override the values in it. Now, you can run

./benchmark.sh docker

to execute the measurements.

The HTML output will be generated in the "docs" directory.

Usage on AWS EC2

As a prerequisite, Terraform and git has to be installed on your machine in order to use this benchmark method.

First, create the necessary config file by copying the aws.tfvars.dist to aws.tfvars in the build/infrastructure/config/aws.tfvars.dist directory:

cp build/infrastructure/config/aws.tfvars.dist build/infrastructure/config/aws.tfvars

Then, override the values in it:

  • access_key: the access key of your AWS account
  • secret_key: the secret access key of your AWS account
  • ssh_key_name: the name of your key pair added to EC2
  • ssh_private_key: the file name of your private key
  • region: it is "eu-central-1" by default, but you should choose the closest one to your area
  • image_name: the name of the EC2 image
  • image_architecture: the CPU architecture of the EC2 image (e.g. x86_64 or arm64)
  • instance_type: it is "C5.large" by default (this instance type is out of the scope of the free tier!)

Finally, you have to copy your private key in the "build/infrastructure/config" directory with a file name that matches the one defined in the ssh_private_key setting.

Now, you are ready to go:

./benchmark.sh aws

The HTML output will be generated in the "docs" directory.

Usage on your host machine

If the above possibilities aren't available to you then you have to take several steps before running the benchmark:

  • Install a web server and configure it to be able to serve "public/index.php"
  • Install PHP 8.0 at least with OPcache and preloading enabled
  • Install Composer
  • Set the BENCHMARK_URL environment variable to the URL where "public/index.php" is available. For instance:
export BENCHMARK_URL=http://localhost/index.php

Now you can simply type the following in order to run the benchmark:

.\benchmark.sh host

If you don't want to specify the benchmark URL as an environment variable then you can also pass it as an argument:

./benchmark.sh host http://localhost/index.php

Usage from the browser

You can even run tests manually from your browser. When the benchmark's Docker containers are running, just visit localhost:8090, otherwise you have to locate the BENCHMARK_URL URL (mentioned in the previous section). For further information, refer to the URL in question, it provides you with detailed instructions.

Contributing

Please see CONTRIBUTING for details.

Support

Please see SUPPORT for details.

Credits

License

The MIT License (MIT). Please see the License File for more information.