yab/man/yab.html at dev · zmt/yab

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"

"http://www.w3.org/TR/html4/loose.dtd">

<html>

<head>

p { margin-top: 0; margin-bottom: 0; }

pre { margin-top: 0; margin-bottom: 0; }

table { margin-top: 0; margin-bottom: 0; }

</style>

</head>

<body>

<a href="#SYNOPSIS">SYNOPSIS</a>

<a href="#DESCRIPTION">DESCRIPTION</a>

<a href="#OPTIONS">OPTIONS</a>

<hr>

yab − yet

another benchmarker

<h2>SYNOPSIS</h2>

yab

[<service> <method> <body>] [OPTIONS]

<h2>DESCRIPTION</h2>

yab is a

benchmarking tool for TChannel and HTTP applications.

It’s primarily intended for Thrift applications but

supports other encodings like JSON and binary (raw). It can

be used in a curl-like fashion when benchmarking features

are disabled.

yab includes a

full man page (man yab), which is also available online:

http://yarpc.github.io/yab/man.html

Default options

can be specified in a ~/.config/yab/defaults.ini file (or

~/Library/Preferences/yab/defaults.ini on Mac) with contents

similar to this:

[request]

timeout = 2s

[transport]

peer-list = "/path/to/peer/list.json"

[benchmark]

warmup = 10

<h2>OPTIONS</h2>

Application

Options

<table width="100%" border=0 rules="none" frame="void"

cellspacing="0" cellpadding="0">

−v</td>

Enable more detailed logging. Repeats

increase the verbosity, ie. -vvv</td>

</table>

−−version

Displays the application

version

Request

Options

Configures the request data and the encoding.

To make Thrift

requests, specify a Thrift file and pass the Thrift service

and procedure to the method argument (-m or --method) as

Service::Method.

$ yab -p

localhost:9787 kv -t kv.thrift -m KeyValue::Count -r

’{}’

You can also

use positional arguments to specify the method and body:

$ yab -p

localhost:9787 -t kv.thrift kv KeyValue::Count

’{}’

The TChannel

health endpoint can be hit without specifying a Thrift file

by passing --health.

Thrift requests

can be specified as JSON or YAML. For example, for a method

defined as:

void addUser(1:

string name, 2: i32 age)

You can pass

the request as JSON: {"name":

"Prashant", age: 100} or as YAML:

name: Prashant

age: 100

The request

body can be specified on the command line using -r or

--request:

$ yab -p

localhost:9787 -t kv.thrift kv \

KeyValue::Get -r ’{"key":

"hello"}’

Or it can be

loaded from a file using -f or --file:

$ yab -p

localhost:9787 -t kv.thrift kv KeyValue::Get --file

req.yaml

To make a proto

requrest, specify a compiled FileDescriptorSet and pass the

fully qualified service an method name as procedure.

$ yab -p

localhost:5435 --file-descriptor-set-bin proto.bin \

service package.Service/Method -r ’{"key":

"value"}’

A

FileDescriptorSet can be generated using the

8000

--descriptor_set_out= flag in protoc.

Request options

can also be specified in a YAML file, e.g., get.yab:

service: kv

peer: localhost:9787

method: KeyValue::get

thrift: kv.thrift

request:

key: hello

The above YAML

file represents the same request as the command above, and

can be run using yab -y get.yab.

You can make

the request by directly executing the file (./get.yab) if

you add a shebang and mark the file as executable:

#!/usr/bin/env

yab

service: kv

peer: localhost:9787

method: KeyValue::get

thrift: kv.thrift

request:

key: hello

YAML templates

can use arguments using ${ARGNAME:default_value} in the

body, which can be specified on the command line using -A.

If an argument is not specified on the command line, then

the default value is used. For example, we can update the

YAML template to take an argument for the key:

#!/usr/bin/env

yab

service: kv

peer: localhost:9787

method: KeyValue::get

thrift: kv.thrift

request:

key: ${key:hello}

If no key is

specified on the command line, the default value of

"hello" is used as the key. However we can specify

the key on the command line:

$ ./get.yab -A

key:world

A YAML template

may have multiple keys and multiple keys can be specified on

the command line:

$ ./set.yab -A

key:hello -A value:world

Binary data can

be specified in one of many ways:

<table width="100%" border=0 rules="none" frame="void"

cellspacing="0" cellpadding="0">

•</td>

As a string or an

array of bytes: "data" or [100, 97, 116, 97]</td>

•</td>

As base64:

{"base64": "ZGF0YQ=="}</td>

•</td>

Loaded from a file:

{"file": "data.bin"}</td>

</table>

Examples:

$ yab -p

localhost:9787 -t kv.thrift kv -m KeyValue::Set \

-r ’{"key": "hello",

"value": [100, 97, 116, 97]}’

$ yab -p

localhost:9787 -t kv.thrift kv KeyValue::Set \

-r ’{"key": "hello",

"value": {"file":

"data.bin"}}’

−e,

−−encoding

The encoding of the data,

options are: Thrift, proto, JSON, raw. Defaults to Thrift if

the method contains ’::’ or a Thrift file is

specified. Defaults to proto if the method contains

’/’ or a proto filedescriptorset is

specified

−t,

−−thrift

Path of the .thrift file

−F,

−−file-descriptor-set-bin

A binary file containing a

compiled protobuf FileDescriptorSet.

−−procedure

The full method name to invoke

(Thrift: Svc::Method, Proto: package.Service/Method).

−m,

−−method

Alias for procedure

−r,

−−request

The request body, in JSON or

YAML format

−f,

−−file

Path of a file containing the

request body in JSON or YAML

−H,

−−header

Individual application header

as a key:value pair per flag

−−headers

The headers in JSON or YAML

format

−−headers-file

Path of a file containing the

headers in JSON or YAML

−B,

−−baggage

Individual context baggage

header as a key:value pair per flag

−−health

Hit the health endpoint,

Meta::health

−−timeout

The timeout for each request.

E.g., 100ms, 0.5s, 1s. If no unit is specified, milliseconds

are assumed.

−y,

−−yaml-template

Send a tchannel request

specified by a YAML template

−A,

−−arg

A list of key-value template

arguments, specified as -A foo:bar -A user:me

−−disable-thrift-envelope

Disables Thrift envelopes

(disabled by default for TChannel and gRPC)

−−multiplexed-thrift

Enables the Thrift

TMultiplexedProtocol used by services that host multiple

Thrift services on a single endpoint.

Transport

Options

Configures the network transport used to make requests.

yab can target

both TChannel and HTTP endpoints. To specify a TChannel

endpoint, specify the peer’s host and port:

$ yab -p

localhost:9787 [options]

or

$ yab -p

tchannel://localhost:9787 [options]

For HTTP

endpoints, specify the URL as the peer,

$ yab -p

http://localhost:8080/thrift [options]

The

Thrift-encoded body will be POSTed to the specified URL.

Multiple peers

can be specified using a peer list using -P or --peer-list.

When making a single request, a single peer from this list

is selected randomly. When benchmarking, connections will be

established in a round-robin fashion, starting with a random

peer.

$ yab

--peer-list hosts.json [options]

−s,

−−service

The TChannel/Hyperbahn service

name

−p,

−−peer

The host:port of the service to

call

−P,

−−peer-list

Path or URL of a JSON, YAML, or

flat file containing a list of host:ports. -P? for supported

protocols.

−−caller

Caller will override the

default caller name (which is yab-$USER).

<table width="100%" border=0 rules="none" frame="void"

cellspacing="0" cellpadding="0">

−−rk </td>

The routing key

overrides the service name traffic group for proxies.</td>

−−rd </td>

The routing

delegate overrides the routing key traffic group for

proxies. </td>

−−sk </td>

The shard key is a

transport header that clues where to send a request within a

clustered traffic group.</td>

</table>

−−jaeger

Use the Jaeger tracing client

to send Uber style traces and baggage headers

−T,

−−topt

Transport options for TChannel,

protocol headers for HTTP

−−http-method

The HTTP method to use

Benchmark

Options

Configures benchmarking, which is disabled by default.

By default, yab

will only make a single request. To enable benchmarking,

specify the maximum duration for the benchmark by passing -d

or --max-duration.

yab will make

requests until either the maximum requests (-n or

--max-requests) or the maximum duration is reached.

You can control

the rate at which yab makes requests using the --rps

flag.

An example

benchmark command might be:

$ yab -p

localhost:9787 moe --health -n 100000 -d 10s --rps 1000

This would make

requests at 1000 RPS until either the maximum number of

requests (100,000) or the maxi BD0 mum duration (10 seconds) is

reached.

By default, yab

will create multiple connections (defaulting to the number

of CPUs on the machine), but will only have one concurrent

call per connection. The number of connections and

concurrent calls per connection can be controlled using

--connections and --concurrency.

−n, −−max-requests <default:

"0">

The maximum number of requests

to make. 0 implies no limit.

−d,

−−max-duration <default:

"0s">

The maximum amount of time to

run the benchmark for. 0 implies no duration limit.

<table width="100%" border=0 rules="none" frame="void"

cellspacing="0" cellpadding="0">

−−cpus </td>

The number of OS

threads </td>

</td>

</table>

−−connections

The number of TCP connections

to use

−−warmup

<default: "10">

The number of requests to make

to warmup each connection

−−concurrency

<default: "1">

The number of concurrent calls

per connection

−−rps

<default: "0">

Limit on the number of requests

per second. The default (0) is no limit.

−−statsd

Optional host:port of a StatsD

server to report metrics

−−per-peer-stats

Whether to emit stats by peer

rather than aggregated

Help Options

−h, −−help

Show this help message

<hr>

</body>

</html>

FilesExpand file tree

yab.html

Latest commit

History

yab.html

File metadata and controls