├── .dockerignore ├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── sbin ├── simple-container-benchmarks └── simple-container-benchmarks-init └── server ├── package.json └── server.js /.dockerignore: -------------------------------------------------------------------------------- 1 | .gitignore -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | server/node_modules/* 2 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM ubuntu:14.04 2 | 3 | # install node and some other items 4 | RUN apt-get update -q 5 | RUN apt-get install -qy npm curl iperf ssh htop 6 | RUN command -v node >/dev/null 2>&1 || { ln -s /usr/bin/nodejs /usr/bin/node; } 7 | 8 | # the node dependencies for our node server app 9 | # using caching suggestions per http://bitjudo.com/blog/2014/03/13/building-efficient-dockerfiles-node-dot-js/ 10 | ADD ./server/package.json /tmp/package.json 11 | RUN cd /tmp && npm install 12 | 13 | # put the shell scripts in place 14 | ADD ./sbin /usr/local/sbin 15 | 16 | # our node server app 17 | ADD ./server /server 18 | RUN cp -r /tmp/node_modules /server/. 19 | 20 | # expose port 80 for the node server 21 | EXPOSE 80 5001 22 | 23 | CMD ["/usr/local/sbin/simple-container-benchmarks-init"] -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Simple Container Benchmarks 2 | 3 | [![DockerPulls](https://img.shields.io/docker/pulls/misterbisson/simple-container-benchmarks.svg)](https://registry.hub.docker.com/u/misterbisson/simple-container-benchmarks/) 4 | [![DockerStars](https://img.shields.io/docker/stars/misterbisson/simple-container-benchmarks.svg)](https://registry.hub.docker.com/u/misterbisson/simple-container-benchmarks/) 5 | 6 | Run some simple benchmarks on computational and filesystem write performance. The benchmarks are simplistic and probably don't represent workloads in your app. 7 | 8 | It's likely that all benchmarking tools suffer fundamental flaws, this is no exception. Consider the following: 9 | 10 | > Benchmarking is treacherous and confusing, and often done poorly - which means that you need to take any benchmark results with a large grain of salt. 11 | 12 | > If you've spent less than a week studying a benchmark result, it's probably wrong. 13 | 14 | If that caught your attention, read the Summary near the end of [Brendan's blog post](http://www.brendangregg.com/ActiveBenchmarking/bonnie++.html#summary), then read the reast. The quotes come from that post, and Brendan explains them in much more detail there. 15 | 16 | The best way to benchmark a system is to run your app on it, since no other code will behave quite the same way. 17 | 18 | ### How the tests work 19 | 20 | This depends on `dd` to exercise both storage and CPU. 21 | 22 | To get write performance, it pipes a gigabyte of zeros to a file on the filesystem: 23 | 24 | ``` 25 | dd bs=1M count=1024 if=/dev/zero of=~/simple-container-benchmarks-writetest conv=fdatasync 26 | ``` 27 | 28 | To test CPU performance, it fetches random numbers and md5 hashes them: 29 | 30 | ``` 31 | dd if=/dev/urandom bs=1M count=256 | md5sum 32 | ``` 33 | 34 | There are many valid criticisms of these methods of testing performance. I use them because they can be easily run on any unix-like system with no software to install. 35 | 36 | ### Where are the benchmarks? 37 | 38 | Check `docker logs $container_id`. 39 | 40 | ### Run 41 | 42 | Start the server container: 43 | 44 | ``` 45 | docker run -d \ 46 | -p 80:80 \ 47 | -p 5001:5001 \ 48 | --name=simple-container-benchmarks-server \ 49 | misterbisson/simple-container-benchmarks 50 | ``` 51 | 52 | Start the client container to read from the server we just started: 53 | 54 | ``` 55 | docker run -d \ 56 | --name=simple-container-benchmarks-client \ 57 | -e "DOCKER_HOST=$DOCKER_HOST" \ 58 | -e "TARGET=$(docker inspect --format='{{.NetworkSettings.IPAddress}}' simple-container-benchmarks-server)" \ 59 | misterbisson/simple-container-benchmarks 60 | ``` 61 | 62 | Note that I'm sending some additional environment vars there, including the docker host and the IP of the server container. I could use the `--link` argument, but my init script in the container is looking specifically for the `$TARGET` environment var. 63 | 64 | Note: I'm also using Docker as the discovery directory here. Watch how that gets more interesting as we run more containers... 65 | 66 | Running this takes a few minutes. You can check `docker logs $CONTAINERID` on the server to see some progress, and when the client container quits you can check the full log there. 67 | 68 | ### Run it a lot 69 | 70 | One pass through isn't nearly as fun as three, or 30. 71 | 72 | Let's loop it to start the server and client three at a time: 73 | 74 | ``` 75 | i=0; while [ $i -lt 3 ]; \ 76 | do docker run -d -p 80:80 -p 5001:5001 --name=simple-container-benchmarks-server-$i misterbisson/simple-container-benchmarks && \ 77 | docker run -d -e "DOCKER_HOST=$DOCKER_HOST" -e "TARGET=$(docker inspect --format='{{.NetworkSettings.IPAddress}}' simple-container-benchmarks-server-$i)" --name=simple-container-benchmarks-client-$i misterbisson/simple-container-benchmarks; \ 78 | i=$[$i+1]; sleep 1; done 79 | ``` 80 | 81 | Oh, snap, maybe you got the following error? 82 | 83 | ``` 84 | FATA[0000] Error response from daemon: Cannot start container 8bfd697de55c09f0313d6d9ce546adbc0e187351858bb064a07007a2624da442: Bind for 0.0.0.0:80 failed: port is already allocated 85 | ``` 86 | 87 | That error only makes sense if you don't expect the Docker API host to assign a unique IP for each container. You might even be used to that behavior, but that doesn't make it right. 88 | 89 | Try the same thing on Joyent's elastic Docker host. Heck, why not start 30? 90 | 91 | ``` 92 | i=0; while [ $i -lt 30 ]; \ 93 | do docker run -d -p 80:80 -p 5001:5001 --name=simple-container-benchmarks-server-$i misterbisson/simple-container-benchmarks && \ 94 | docker run -d -e "DOCKER_HOST=$DOCKER_HOST" -e "TARGET=$(docker inspect --format='{{.NetworkSettings.IPAddress}}' simple-container-benchmarks-server-$i)" --name=simple-container-benchmarks-client-$i misterbisson/simple-container-benchmarks; \ 95 | i=$[$i+1]; sleep 1; done 96 | ``` 97 | 98 | Each iteration through the loop spins up a server container, and if that goes successfully, it will spin up a client container as well. Take note of `-e "TARGET=$(docker inspect --format='{{.NetworkSettings.IPAddress}}' simple-container-benchmarks-server-$i)"` in the command to spin up the client container. That checks the Docker API for a container named `simple-container-benchmarks-server-$i`, gets the IP address for it, and inserts that IP in the `$TARGET` environment variable. 99 | 100 | Using the Docker API as the directory for service discovery works well if the containers are named predictably (a "good" container name would probably be `$app-$version-$service`, or similar) _and_ if the Docker API can be trusted to know about _all_ the containers. That's exactly how it works on Joyent's elastic Docker host: the entire data center is a single host, and the API reports on all the containers running across all the physical compute nodes. 101 | 102 | ### Build 103 | 104 | ``` 105 | docker build -t misterbisson/simple-container-benchmarks . 106 | ``` 107 | -------------------------------------------------------------------------------- /sbin/simple-container-benchmarks: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # prep the file where we save our output 4 | touch /simple-container-benchmarks.txt # create it if it doesn't exist 5 | cat /dev/null > /simple-container-benchmarks.txt # truncate it, if the file has previous content in it 6 | 7 | 8 | # system identification 9 | echo '------------------------------' >> /simple-container-benchmarks.txt 10 | echo 'Performance benchmarks' >> /simple-container-benchmarks.txt 11 | echo '------------------------------' >> /simple-container-benchmarks.txt 12 | echo "dockerhost: $DOCKER_HOST" >> /simple-container-benchmarks.txt 13 | curl -sS http://$TARGET/ips >> /simple-container-benchmarks.txt || echo 'curl: failed to connect' >> /simple-container-benchmarks.txt 14 | echo 'date: '$(date) >> /simple-container-benchmarks.txt 15 | 16 | 17 | # get disk performance stats 18 | echo '' >> /simple-container-benchmarks.txt 19 | echo '------------------------------' >> /simple-container-benchmarks.txt 20 | echo 'FS write performance' >> /simple-container-benchmarks.txt 21 | echo '------------------------------' >> /simple-container-benchmarks.txt 22 | COUNTER=0 23 | while [ $COUNTER -lt 10 ]; do 24 | curl -sS http://$TARGET/disk >> /simple-container-benchmarks.txt || echo 'curl: failed to connect' >> /simple-container-benchmarks.txt 25 | let COUNTER=COUNTER+1 26 | done 27 | 28 | 29 | 30 | # get processor performance stats 31 | echo '' >> /simple-container-benchmarks.txt 32 | echo '------------------------------' >> /simple-container-benchmarks.txt 33 | echo 'CPU performance' >> /simple-container-benchmarks.txt 34 | echo '------------------------------' >> /simple-container-benchmarks.txt 35 | COUNTER=0 36 | while [ $COUNTER -lt 10 ]; do 37 | curl -sS http://$TARGET/cpu >> /simple-container-benchmarks.txt || echo 'curl: failed to connect' >> /simple-container-benchmarks.txt 38 | let COUNTER=COUNTER+1 39 | done 40 | 41 | 42 | 43 | # get system info 44 | echo '' >> /simple-container-benchmarks.txt 45 | echo '------------------------------' >> /simple-container-benchmarks.txt 46 | echo 'System info' >> /simple-container-benchmarks.txt 47 | echo '------------------------------' >> /simple-container-benchmarks.txt 48 | curl -sS http://$TARGET/info >> /simple-container-benchmarks.txt || echo 'curl: failed to connect' >> /simple-container-benchmarks.txt 49 | 50 | # report 51 | cat /simple-container-benchmarks.txt 52 | -------------------------------------------------------------------------------- /sbin/simple-container-benchmarks-init: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # if we don't have a target var, then we're running in server mode 4 | # ...so start node and iperf 5 | if [[ ! -n "$TARGET" ]] 6 | then 7 | echo 'Server mode...' 8 | node /server/server.js && iperf -s 9 | else 10 | echo 'Client mode...' 11 | echo "Target: $TARGET" 12 | time /usr/local/sbin/simple-container-benchmarks 13 | fi 14 | -------------------------------------------------------------------------------- /server/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "simple-container-benchmarks", 3 | "description": "A simple benchmarking tool for Docker container hosts", 4 | "version": "0.0.1", 5 | "private": true, 6 | "scripts": { 7 | "start": "node server.js" 8 | }, 9 | "dependencies": { 10 | "restify": "*", 11 | "shelljs": "*" 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /server/server.js: -------------------------------------------------------------------------------- 1 | var restify = require('restify'); 2 | var server = restify.createServer(); 3 | var exec = require('shelljs').exec; 4 | 5 | server.get('/disk', disk); 6 | function disk(req, res, next) { 7 | console.log('/disk request'); 8 | var thing = exec("(dd bs=1M count=1024 if=/dev/zero of=/simple-container-benchmarks-writetest conv=fdatasync) 2>&1 | tail -1 | sed -e 's/^ *//' -e 's/ *$//'", {silent:true}).output; 9 | exec("rm /simple-container-benchmarks-writetest", {silent:true}).output; 10 | 11 | console.log(thing); 12 | 13 | res.setHeader('content-type', 'text/plain'); 14 | res.send(thing); 15 | next(); 16 | } 17 | 18 | server.get('/cpu', cpu); 19 | function cpu(req, res, next) { 20 | console.log('/cpu request'); 21 | var thing = exec("(dd if=/dev/urandom bs=1M count=256 | md5sum) 2>&1 >/dev/null | tail -1 | sed -e 's/^ *//' -e 's/ *$//'", {silent:true}).output; 22 | 23 | console.log(thing); 24 | 25 | res.setHeader('content-type', 'text/plain'); 26 | res.send(thing); 27 | next(); 28 | } 29 | 30 | server.get('/info', info); 31 | function info(req, res, next) { 32 | console.log('/info request'); 33 | 34 | var mem = exec("free | head -2", {silent:true}).output; 35 | var cpu = exec("lscpu", {silent:true}).output; 36 | 37 | console.log(mem + cpu); 38 | 39 | res.setHeader('content-type', 'text/plain'); 40 | res.send(mem + cpu); 41 | next(); 42 | } 43 | 44 | server.get('/ips', ips); 45 | function ips(req, res, next) { 46 | console.log('/ips request'); 47 | 48 | var output = ""; 49 | 50 | // the host from the request + what the server thinks its hostname is 51 | output += "host: " + req.headers.host + " " + exec("hostname", {silent:true}).output; 52 | 53 | // the ethernet interface IPs 54 | // stolen from http://stackoverflow.com/a/8440736 55 | var os = require('os'); 56 | var ifaces = os.networkInterfaces(); 57 | 58 | Object.keys(ifaces).forEach(function (ifname) { 59 | var alias = 0; 60 | 61 | ifaces[ifname].forEach(function (iface) { 62 | if ('IPv4' !== iface.family || iface.internal !== false) { 63 | // skip over internal (i.e. 127.0.0.1) and non-ipv4 addresses 64 | return; 65 | } 66 | 67 | if (alias >= 1) { 68 | // this single interface has multiple ipv4 addresses 69 | output += ifname + ':' + alias + ': ' + iface.address + "\n"; 70 | } else { 71 | // this interface has only one ipv4 adress 72 | output += ifname + ': ' + iface.address + "\n"; 73 | } 74 | }); 75 | }); 76 | 77 | console.log(output); 78 | 79 | res.setHeader('content-type', 'text/plain'); 80 | res.send(output); 81 | next(); 82 | } 83 | 84 | server.listen(80, function() { 85 | console.log('%s listening at %s', server.name, server.url); 86 | }); 87 | --------------------------------------------------------------------------------