Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Merge pull request #7 from twitter/lahosken_doc

doc: config goes easier if you choose the right Transport instead of the wrong Transport
  • Loading branch information...
commit 495f49d6749e702633e4715e9dbdfd1ab4d51662 2 parents 9cea1ca + 3ed0a3c
@lahosken lahosken authored
Showing with 12 additions and 7 deletions.
  1. +12 −7 README.md
View
19 README.md
@@ -83,12 +83,13 @@ Replaying transactions at a fixed rate enables you to study the behavior of your
### Supported Services
-Iago understands service requests in the following formats:
+Iago can generate service requests that travel the net in different ways and are in different formats. The code that does this is in a Transport, a class that extends <code>ParrotTransport</code>. Iago comes with several Transports already defined. When you configure your test, you will need to set some parameters; to understand which of those parameters are used and how they are used, you probably want to look at the source code for your test's Transport class.
-* HTTP
-* Thrift
-* Memcached / Kestrel
-* UDP
+* HTTP: Use <a href="https://github.com/twitter/iago/blob/master/src/main/scala/com/twitter/parrot/server/FinagleTransport.scala">FinagleTransport</a>
+* Thrift: Use <a href="https://github.com/twitter/iago/blob/master/src/main/scala/com/twitter/parrot/server/ThriftTransport.scala">ThriftTransport</a>
+* Memcached: Use <a href="https://github.com/twitter/iago/blob/master/src/main/scala/com/twitter/parrot/server/MemcacheTransport.scala">MemcacheTransport</a>
+* Kestrel: Use <a href="https://github.com/twitter/iago/blob/master/src/main/scala/com/twitter/parrot/server/KestrelTransport.scala">KestrelTransport</a>
+* UDP: Use <a href="https://github.com/twitter/iago/blob/master/src/main/scala/com/twitter/parrot/server/ParrotUdpTransport.scala">ParrotUdpTransport</a>
Your service is typically an HTTP or Thrift service written in either Scala or Java.
@@ -331,7 +332,11 @@ You define your Iago subclass to execute your service and map transactions to re
## Configuring Your Test
-To configure your test, create a `launcher.scala` file that that creates a `ParrotLauncherConfig` instance with the configuration parameters you want to set. The following example shows parameters for testing a Thrift service:
+To configure your test, create a `launcher.scala` file that that creates a `ParrotLauncherConfig` instance with the configuration parameters you want to set.
+
+There are several parameters to set. A good one to <a href="#Supported Services">figure out early is <code>transport</code></a>; that will in turn help you to find out what, e.g., <code>responseType</code> you need.
+
+The following example shows parameters for testing a Thrift service:
```scala
import com.twitter.parrot.config.ParrotLauncherConfig
@@ -345,7 +350,7 @@ new ParrotLauncherConfig {
requestRate = 1
numInstances = 1
duration = 5
- timeUnit = "MINUTES"
+ timeUnit = "MINUTES" // affects duration; does not affect requestRate
role = "preflight"
imports = "import com.twitter.example.EchoLoadTest"
Please sign in to comment.
Something went wrong with that request. Please try again.