Compiling and running Flood

Return-Path: X-Original-To: apmail-httpd-cvs-archive@www.apache.org Delivered-To: apmail-httpd-cvs-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 460FF9C5C for ; Sun, 6 May 2012 16:04:20 +0000 (UTC) Received: (qmail 1325 invoked by uid 500); 6 May 2012 16:04:20 -0000 Delivered-To: apmail-httpd-cvs-archive@httpd.apache.org Received: (qmail 1275 invoked by uid 500); 6 May 2012 16:04:20 -0000 Mailing-List: contact cvs-help@httpd.apache.org; run by ezmlm Precedence: bulk Reply-To: dev@httpd.apache.org list-help: list-unsubscribe: List-Post: List-Id: Delivered-To: mailing list cvs@httpd.apache.org Received: (qmail 1268 invoked by uid 99); 6 May 2012 16:04:20 -0000 Received: from athena.apache.org (HELO athena.apache.org) (140.211.11.136) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 06 May 2012 16:04:20 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 06 May 2012 16:04:17 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 9068023888EA; Sun, 6 May 2012 16:03:57 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1334673 - in /httpd/site/trunk/content/test/flood: building.mdtext building.xml faq.mdtext faq.xml index.mdtext index.xml Date: Sun, 06 May 2012 16:03:57 -0000 To: cvs@httpd.apache.org From: humbedooh@apache.org X-Mailer: svnmailer-1.0.8-patched Message-Id: <20120506160357.9068023888EA@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: humbedooh Date: Sun May 6 16:03:56 2012 New Revision: 1334673 URL: http://svn.apache.org/viewvc?rev=1334673&view=rev Log: updates for test/flood Added: httpd/site/trunk/content/test/flood/building.mdtext - copied, changed from r1334665, httpd/site/trunk/content/test/flood/building.xml httpd/site/trunk/content/test/flood/faq.mdtext - copied, changed from r1334665, httpd/site/trunk/content/test/flood/faq.xml httpd/site/trunk/content/test/flood/index.mdtext - copied, changed from r1334665, httpd/site/trunk/content/test/flood/index.xml Removed: httpd/site/trunk/content/test/flood/building.xml httpd/site/trunk/content/test/flood/faq.xml httpd/site/trunk/content/test/flood/index.xml Copied: httpd/site/trunk/content/test/flood/building.mdtext (from r1334665, httpd/site/trunk/content/test/flood/building.xml) URL: http://svn.apache.org/viewvc/httpd/site/trunk/content/test/flood/building.mdtext?p2=httpd/site/trunk/content/test/flood/building.mdtext&p1=httpd/site/trunk/content/test/flood/building.xml&r1=1334665&r2=1334673&rev=1334673&view=diff ============================================================================== --- httpd/site/trunk/content/test/flood/building.xml (original) +++ httpd/site/trunk/content/test/flood/building.mdtext Sun May 6 16:03:56 2012 @@ -1,129 +1,113 @@ - - - - Documentation Group - Compiling and running Flood - - - -

-Overview -

This document explains how to compile and run flood.

- -

Flood is built around -Apache Portable Runtime - specifically -apr and apr-util.

- -

Flood has been primarily developed on Linux and Solaris. FreeBSD is also -known to work. Since flood is built around APR, any APR-supported platform -should work without too much hassle. We expect Win32 would work with some -additional magic provided someone has the time and inclination to do so. -APR has completed most of the dirty work, but none of the current flood -developers use Win32.

+Title: Compiling and running Flood +Notice: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + . + http://www.apache.org/licenses/LICENSE-2.0 + . + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +# Overview # {#Overview} + +This document explains how to compile and run flood. + +Flood is built around [Apache Portable Runtime](http://apr.apache.org/) - +specifically apr and apr-util. + +Flood has been primarily developed on Linux and Solaris. FreeBSD is also +known to work. Since flood is built around APR, any APR-supported platform +should work without too much hassle. We expect Win32 would work with some +additional magic provided someone has the time and inclination to do so. +APR has completed most of the dirty work, but none of the current flood +developers use Win32. -

-Checking out flood +# Checking out flood # {#Checkout} -

The current copy of flood is available via Subversion. Flood also depends +The current copy of flood is available via Subversion. Flood also depends on the apr and apr-util packages available from the same Subversion -repository.

+repository. -

Note: Flood will automatically detect -and configure APR and APR-util if they are in the appropriate -subdirectories. If you have an already installed copy of APR and -APR-util (such as the ones that come with httpd-2.0 or Subversion), you -may specify --with-apr and --with-apr-util at configure-time.

- -

- % svn co http://svn.apache.org/repos/asf/httpd/flood/trunk flood
- % cd flood
- % svn co http://svn.apache.org/repos/asf/apr/apr/trunk apr
- % svn co http://svn.apache.org/repos/asf/apr/apr-util/trunk apr-util
-

- -

-Configuring flood and its dependencies - -

Now that you have all of the required modules checked out, you now -need to generate the configure scripts and execute them for your -platform.

- -

Flood and SSL support

Note: SSL support is not -enabled by default in flood. If you wish to enable SSL support, you -must specify --enable-ssl when configuring flood.

- -

If you attempt to run flood against a https URL without SSL -support compiled-in, you will receive an error similar to the -following:

- -

- % ./flood examples/round-robin-ssl.xml
- open request failed (https://www.modssl.org/example/test.phtml).
- Error running farmer 'Joe': This function has not been implemented on this
- platform
-

- -

The --enable-ssl option enables detection of the -OpenSSL libraries. If flood can not automatically detect OpenSSL, -you will need to specify --with-openssl to point at -the appropriate installed version of OpenSSL. The ---with-capath option points at a directory that contains -the Certificate Authorities (CAs) for OpenSSL. The default -capath is in $openssl_prefix/certs.

- -

Running configure from the flood directory

- % ./buildconf
- % ./configure --disable-shared
-

- -

-Compiling flood and its dependencies - -

In this example, APR and apr-util will automatically be built with -flood. So, you only need to issue a make in the flood directory.

- -

- % make all
-

- -

-Running flood - -

By default, flood is a static executable, so the executable is -relocatable. There are some example flood profiles in the examples/ -directory from CVS.

- -

- % ./flood examples/round-robin.xml > foo.out
-

- -

-Analyzing flood output - -

The foo.out file generated above is in a simple easy-to-parse format. -There are some included shell and awk scripts in the examples directory -that provide some easy mechanisms to extract info from the flood output -files.

- -

- % ./examples/analyze-relative foo.out
-

- -

-Questions - -

This should provide a quick and easy way to jumpstart your flood -installation. If you have any questions, please email the -dev@httpd.apache.org mailing list.

+**Note:** Flood will automatically detect and +configure APR and APR-util if they are in the appropriate subdirectories. +If you have an already installed copy of APR and APR-util (such as the ones +that come with httpd-2.0 or Subversion), you may specify --with-apr and +--with-apr-util at configure-time. +` +% svn co http://svn.apache.org/repos/asf/httpd/flood/trunk flood +% cd flood +% svn co http://svn.apache.org/repos/asf/apr/apr/trunk apr +% svn co http://svn.apache.org/repos/asf/apr/apr-util/trunk apr-util +` + +# Configuring flood and its dependencies # {#Configuring} + +Now that you have all of the required modules checked out, you now need to +generate the configure scripts and execute them for your platform. + +### Flood and SSL support ### + +**Note:** SSL support is **not** enabled by +default in flood. If you wish to enable SSL support, you must specify +`--enable-ssl` when configuring flood. + +If you attempt to run flood against a https URL without SSL support +compiled-in, you will receive an error similar to the following: +` +%./flood examples/round-robin-ssl.xml +open request failed (https://www.modssl.org/example/test.phtml). +Error running farmer 'Joe': This function has not been implemented on this +platform +` +The `--enable-ssl` option enables detection of the OpenSSL libraries. If +flood can not automatically detect OpenSSL, you will need to specify +`--with-openssl` to point at the appropriate installed version of OpenSSL. +The `--with-capath` option points at a directory that contains the +Certificate Authorities ( **CA** s) for OpenSSL. The default capath is in +`$openssl_prefix/certs`. + +### Running configure from the flood directory ### +` +%./buildconf +%./configure --disable-shared +` + +# Compiling flood and its dependencies # {#Compiling} + +In this example, APR and apr-util will automatically be built with flood. +So, you only need to issue a make in the flood directory. +` +% make all +` + +# Running flood # {#Running} + +By default, flood is a static executable, so the executable is relocatable. +There are some example flood profiles in the examples/ directory from CVS. +` +%./flood examples/round-robin.xml > foo.out +` + +# Analyzing flood output # {#Analysis} + +The foo.out file generated above is in a simple easy-to-parse format. There +are some included shell and awk scripts in the examples directory that +provide some easy mechanisms to extract info from the flood output files. +` +%./examples/analyze-relative foo.out +` + +# Questions # {#Questions} + +This should provide a quick and easy way to jumpstart your flood +installation. If you have any questions, please email the +dev@httpd.apache.org mailing list. - - Copied: httpd/site/trunk/content/test/flood/faq.mdtext (from r1334665, httpd/site/trunk/content/test/flood/faq.xml) URL: http://svn.apache.org/viewvc/httpd/site/trunk/content/test/flood/faq.mdtext?p2=httpd/site/trunk/content/test/flood/faq.mdtext&p1=httpd/site/trunk/content/test/flood/faq.xml&r1=1334665&r2=1334673&rev=1334673&view=diff ============================================================================== --- httpd/site/trunk/content/test/flood/faq.xml (original) +++ httpd/site/trunk/content/test/flood/faq.mdtext Sun May 6 16:03:56 2012 @@ -1,88 +1,76 @@ - - - - Documentation Group - FAQ - - +Title: FAQ +Notice: Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + . + http://www.apache.org/licenses/LICENSE-2.0 + . + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. -

-Frequently Asked Questions +# Frequently Asked Questions # {#Questions} -

What is Flood?
What are some of the features of Flood?
How does Flood retrieve variables from pages?
Can I use Flood with SSL sites?
Flood seems like it is stalling.

+- [What is Flood?](#WhatIsFlood) -

-What is Flood? -

Flood is a profile-driven HTTP load tester. In layman's terms, -it means that flood is capable of generating large amounts of web -traffic. Flood's flexibility and power arises in its configuration -syntax. It is able to work well with dynamic content.

+- [What are some of the features of Flood?](#FloodFeatures) -

-What are some of the features of Flood? -

XML-based configuration
Able to set and retrieve variables from pages
Uses threads and processes intelligently to scale
Works with SSL

+- [How does Flood retrieve variables from pages?](#FloodRegex) -

-How does Flood retrieve variables from pages? +- [Can I use Flood with SSL sites?](#FloodSSL) -

Flood's configuration syntax allows for regular expression -matching to isolate values in a page.

+- [Flood seems like it is stalling.](#TCPFIN) -

Consider placing an order on a website. You add the order and -you know that the order confirmation page has the following format:

+# What is Flood? # {#WhatIsFlood} -

"Order XYZZY placed successfully."

+Flood is a profile-driven HTTP load tester. In layman's terms, it means +that flood is capable of generating large amounts of web traffic. Flood's +flexibility and power arises in its configuration syntax. It is able to +work well with dynamic content. -

By using the following semantics, flood can store XYZZY into the -OrderID variable:

+# What are some of the features of Flood? # {#FloodFeatures} -

responsetemplate="Order ([^ ]*) placed successfully" responsename="OrderID"

+- XML-based configuration -

In a subsequent request, you can use this OrderID variable in any -template variable:

+- Able to set and retrieve variables from pages -

requesttemplate="https://localhost/getOrderStatus?orderId=${orderID}"

+- Uses threads and processes intelligently to scale -

This will send the following request:

+- Works with SSL -

https://localhost/getOrderStatus?orderId=XYZZY

+# How does Flood retrieve variables from pages? # {#FloodRegex} -

+Flood's configuration syntax allows for regular expression matching to +isolate values in a page. -

-Can I use Flood with SSL sites? +Consider placing an order on a website. You add the order and you know that +the order confirmation page has the following format: +`"Order XYZZY placed successfully."` +By using the following semantics, flood can store XYZZY into the OrderID +variable: +`responsetemplate="Order ([^ ]*) placed successfully" +responsename="OrderID"` +In a subsequent request, you can use this OrderID variable in any template +variable: +`requesttemplate="https://localhost/getOrderStatus?orderId=${orderID}"` +This will send the following request: +`https://localhost/getOrderStatus?orderId=XYZZY` -

Yes. However, due to export regulations and laws, Flood does not have -SSL support enabled by default. When configuring flood, you must pass -the --enable-ssl flag. Flood currently works with -OpenSSL.

+# Can I use Flood with SSL sites? # {#FloodSSL} -

+Yes. However, due to export regulations and laws, Flood does not have SSL +support enabled by default. When configuring flood, you must pass the +`--enable-ssl` flag. Flood currently works with OpenSSL. -

-Flood seems like it is stalling. +# Flood seems like it is stalling. # {#TCPFIN} - +Your TCP implementation may have run out of ephemeral ports. Please consult +your operating systems' manuals on how to decrease the FIN timeout. -

Your TCP implementation may have run out of ephemeral ports. -Please consult your operating systems' manuals on how to decrease -the FIN timeout.

- -

- - - Copied: httpd/site/trunk/content/test/flood/index.mdtext (from r1334665, httpd/site/trunk/content/test/flood/index.xml) URL: http://svn.apache.org/viewvc/httpd/site/trunk/content/test/flood/index.mdtext?p2=httpd/site/trunk/content/test/flood/index.mdtext&p1=httpd/site/trunk/content/test/flood/index.xml&r1=1334665&r2=1334673&rev=1334673&view=diff ============================================================================== --- httpd/site/trunk/content/test/flood/index.xml (original) +++ httpd/site/trunk/content/test/flood/index.mdtext Sun May 6 16:03:56 2012 @@ -1,111 +1,116 @@ - - - - Documentation Group - Flood - - -

-Flood - a profile-driven HTTP load tester - -

Flood is a profile-driven HTTP load tester. It can be used to -gather important performance metrics for your website.

- -

Please see the FAQ for common questions about -flood.

- -

-Getting and using flood - -

Please read the Building flood document -for a quick installation guide for flood.

- -

-Example profiles - -

Flood's configuration is XML-based. Some of the links below showcase some -of the features available in flood. All of these files are available in the -examples directory in flood's Subversion repository.

- -

Round-robin annotated flood config example (Recommended for flood newbies)
An example using dynamic content-specific variables
An example using keepalives
An example using SSL
An example using timers
A sh/gawk script that shows how to interpret the relative_times output of flood

- -

-Subversion Access - -

You may browse the flood's Subversion repository online or via flood ViewCVS

- -

Anonymous Subversion access (via WebDAV) is available.

- -

- % svn co http://svn.apache.org/repos/asf/httpd/flood/trunk flood
-

- -

-Mailing Lists - -

Our mailing lists are open to the public.

- -

Subscription

dev@httpd.apache.org - discussion of what to do
cvs@httpd.apache.org - commit notifications

- -