1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 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
|
require 'helper'
describe Statsd do
before do
class Statsd
o, $VERBOSE = $VERBOSE, nil
alias connect_old connect
def connect
$connect_count ||= 1
$connect_count += 1
end
$VERBOSE = o
end
@statsd = Statsd.new('localhost', 1234)
@socket = @statsd.instance_variable_set(:@socket, FakeUDPSocket.new)
end
after do
class Statsd
o, $VERBOSE = $VERBOSE, nil
alias connect connect_old
$VERBOSE = o
end
end
describe "#initialize" do
it "should set the host and port" do
@statsd.host.must_equal 'localhost'
@statsd.port.must_equal 1234
end
it "should default the host to 127.0.0.1 and port to 8125" do
statsd = Statsd.new
statsd.host.must_equal '127.0.0.1'
statsd.port.must_equal 8125
end
it "should set delimiter to period by default" do
@statsd.delimiter.must_equal "."
end
end
describe "#host and #port" do
it "should set host and port" do
@statsd.host = '1.2.3.4'
@statsd.port = 5678
@statsd.host.must_equal '1.2.3.4'
@statsd.port.must_equal 5678
end
it "should not resolve hostnames to IPs" do
@statsd.host = 'localhost'
@statsd.host.must_equal 'localhost'
end
it "should set nil host to default" do
@statsd.host = nil
@statsd.host.must_equal '127.0.0.1'
end
it "should set nil port to default" do
@statsd.port = nil
@statsd.port.must_equal 8125
end
it "should allow an IPv6 address" do
@statsd.host = '::1'
@statsd.host.must_equal '::1'
end
end
describe "#delimiter" do
it "should set delimiter" do
@statsd.delimiter = "-"
@statsd.delimiter.must_equal "-"
end
it "should set default to period if not given a value" do
@statsd.delimiter = nil
@statsd.delimiter.must_equal "."
end
end
describe "#increment" do
it "should format the message according to the statsd spec" do
@statsd.increment('foobar')
@socket.recv.must_equal ['foobar:1|c']
end
describe "with a sample rate" do
before { class << @statsd; def rand; 0; end; end } # ensure delivery
it "should format the message according to the statsd spec" do
@statsd.increment('foobar', 0.5)
@socket.recv.must_equal ['foobar:1|c|@0.5']
end
end
end
describe "#decrement" do
it "should format the message according to the statsd spec" do
@statsd.decrement('foobar')
@socket.recv.must_equal ['foobar:-1|c']
end
describe "with a sample rate" do
before { class << @statsd; def rand; 0; end; end } # ensure delivery
it "should format the message according to the statsd spec" do
@statsd.decrement('foobar', 0.5)
@socket.recv.must_equal ['foobar:-1|c|@0.5']
end
end
end
describe "#gauge" do
it "should send a message with a 'g' type, per the nearbuy fork" do
@statsd.gauge('begrutten-suffusion', 536)
@socket.recv.must_equal ['begrutten-suffusion:536|g']
@statsd.gauge('begrutten-suffusion', -107.3)
@socket.recv.must_equal ['begrutten-suffusion:-107.3|g']
end
describe "with a sample rate" do
before { class << @statsd; def rand; 0; end; end } # ensure delivery
it "should format the message according to the statsd spec" do
@statsd.gauge('begrutten-suffusion', 536, 0.1)
@socket.recv.must_equal ['begrutten-suffusion:536|g|@0.1']
end
end
end
describe "#timing" do
it "should format the message according to the statsd spec" do
@statsd.timing('foobar', 500)
@socket.recv.must_equal ['foobar:500|ms']
end
describe "with a sample rate" do
before { class << @statsd; def rand; 0; end; end } # ensure delivery
it "should format the message according to the statsd spec" do
@statsd.timing('foobar', 500, 0.5)
@socket.recv.must_equal ['foobar:500|ms|@0.5']
end
end
end
describe "#set" do
it "should format the message according to the statsd spec" do
@statsd.set('foobar', 765)
@socket.recv.must_equal ['foobar:765|s']
end
describe "with a sample rate" do
before { class << @statsd; def rand; 0; end; end } # ensure delivery
it "should format the message according to the statsd spec" do
@statsd.set('foobar', 500, 0.5)
@socket.recv.must_equal ['foobar:500|s|@0.5']
end
end
end
describe "#time" do
it "should format the message according to the statsd spec" do
@statsd.time('foobar') { 'test' }
@socket.recv.must_equal ['foobar:0|ms']
end
it "should return the result of the block" do
result = @statsd.time('foobar') { 'test' }
result.must_equal 'test'
end
describe "when given a block with an explicit return" do
it "should format the message according to the statsd spec" do
lambda { @statsd.time('foobar') { return 'test' } }.call
@socket.recv.must_equal ['foobar:0|ms']
end
it "should return the result of the block" do
result = lambda { @statsd.time('foobar') { return 'test' } }.call
result.must_equal 'test'
end
end
describe "with a sample rate" do
before { class << @statsd; def rand; 0; end; end } # ensure delivery
it "should format the message according to the statsd spec" do
@statsd.time('foobar', 0.5) { 'test' }
@socket.recv.must_equal ['foobar:0|ms|@0.5']
end
end
end
describe "#sampled" do
describe "when the sample rate is 1" do
before { class << @statsd; def rand; raise end; end }
it "should send" do
@statsd.timing('foobar', 500, 1)
@socket.recv.must_equal ['foobar:500|ms']
end
end
describe "when the sample rate is greater than a random value [0,1]" do
before { class << @statsd; def rand; 0; end; end } # ensure delivery
it "should send" do
@statsd.timing('foobar', 500, 0.5)
@socket.recv.must_equal ['foobar:500|ms|@0.5']
end
end
describe "when the sample rate is less than a random value [0,1]" do
before { class << @statsd; def rand; 1; end; end } # ensure no delivery
it "should not send" do
assert_nil @statsd.timing('foobar', 500, 0.5)
end
end
describe "when the sample rate is equal to a random value [0,1]" do
before { class << @statsd; def rand; 0; end; end } # ensure delivery
it "should send" do
@statsd.timing('foobar', 500, 0.5)
@socket.recv.must_equal ['foobar:500|ms|@0.5']
end
end
end
describe "with namespace" do
before { @statsd.namespace = 'service' }
it "should add namespace to increment" do
@statsd.increment('foobar')
@socket.recv.must_equal ['service.foobar:1|c']
end
it "should add namespace to decrement" do
@statsd.decrement('foobar')
@socket.recv.must_equal ['service.foobar:-1|c']
end
it "should add namespace to timing" do
@statsd.timing('foobar', 500)
@socket.recv.must_equal ['service.foobar:500|ms']
end
it "should add namespace to gauge" do
@statsd.gauge('foobar', 500)
@socket.recv.must_equal ['service.foobar:500|g']
end
end
describe "with postfix" do
before { @statsd.postfix = 'ip-23-45-56-78' }
it "should add postfix to increment" do
@statsd.increment('foobar')
@socket.recv.must_equal ['foobar.ip-23-45-56-78:1|c']
end
it "should add postfix to decrement" do
@statsd.decrement('foobar')
@socket.recv.must_equal ['foobar.ip-23-45-56-78:-1|c']
end
it "should add namespace to timing" do
@statsd.timing('foobar', 500)
@socket.recv.must_equal ['foobar.ip-23-45-56-78:500|ms']
end
it "should add namespace to gauge" do
@statsd.gauge('foobar', 500)
@socket.recv.must_equal ['foobar.ip-23-45-56-78:500|g']
end
end
describe '#postfix=' do
describe "when nil, false, or empty" do
it "should set postfix to nil" do
[nil, false, ''].each do |value|
@statsd.postfix = 'a postfix'
@statsd.postfix = value
assert_nil @statsd.postfix
end
end
end
end
describe "with logging" do
require 'stringio'
before { Statsd.logger = Logger.new(@log = StringIO.new)}
it "should write to the log in debug" do
Statsd.logger.level = Logger::DEBUG
@statsd.increment('foobar')
@log.string.must_match "Statsd: foobar:1|c"
end
it "should not write to the log unless debug" do
Statsd.logger.level = Logger::INFO
@statsd.increment('foobar')
@log.string.must_be_empty
end
end
describe "stat names" do
it "should accept anything as stat" do
@statsd.increment(Object, 1)
end
it "should replace ruby constant delimeter with graphite package name" do
class Statsd::SomeClass; end
@statsd.increment(Statsd::SomeClass, 1)
@socket.recv.must_equal ['Statsd.SomeClass:1|c']
end
describe "custom delimiter" do
before do
@statsd.delimiter = "-"
end
it "should replace ruby constant delimiter with custom delimiter" do
class Statsd::SomeOtherClass; end
@statsd.increment(Statsd::SomeOtherClass, 1)
@socket.recv.must_equal ['Statsd-SomeOtherClass:1|c']
end
end
it "should replace statsd reserved chars in the stat name" do
@statsd.increment('ray@hostname.blah|blah.blah:blah', 1)
@socket.recv.must_equal ['ray_hostname.blah_blah.blah_blah:1|c']
end
end
describe "handling socket errors" do
before do
require 'stringio'
Statsd.logger = Logger.new(@log = StringIO.new)
@socket.instance_eval { def write(*) raise SocketError end }
end
it "should ignore socket errors" do
assert_nil @statsd.increment('foobar')
end
it "should log socket errors" do
@statsd.increment('foobar')
@log.string.must_match 'Statsd: SocketError'
end
end
describe "batching" do
it "should have a default batch size of 10" do
@statsd.batch_size.must_equal 10
end
it "should have a default batch byte size of nil" do
assert_nil @statsd.batch_byte_size
end
it "should have a modifiable batch size" do
@statsd.batch_size = 7
@statsd.batch_size.must_equal 7
@statsd.batch do |b|
b.batch_size.must_equal 7
end
@statsd.batch_size = nil
@statsd.batch_byte_size = 1472
@statsd.batch do |b|
assert_nil b.batch_size
b.batch_byte_size.must_equal 1472
end
end
it "should flush the batch at the batch size or at the end of the block" do
@statsd.batch do |b|
b.batch_size = 3
# The first three should flush, the next two will be flushed when the
# block is done.
5.times { b.increment('foobar') }
@socket.recv.must_equal [(["foobar:1|c"] * 3).join("\n")]
end
@socket.recv.must_equal [(["foobar:1|c"] * 2).join("\n")]
end
it "should flush based on batch byte size" do
@statsd.batch do |b|
b.batch_size = nil
b.batch_byte_size = 22
# The first two should flush, the last will be flushed when the
# block is done.
3.times { b.increment('foobar') }
@socket.recv.must_equal [(["foobar:1|c"] * 2).join("\n")]
end
@socket.recv.must_equal ["foobar:1|c"]
end
it "should flush immediately when the queue is exactly a batch size" do
@statsd.batch do |b|
b.batch_size = nil
b.batch_byte_size = 21
# The first two should flush, the last will be flushed when the
# block is done.
2.times { b.increment('foobar') }
@socket.recv.must_equal [(["foobar:1|c"] * 2).join("\n")]
end
end
it "should not flush to the socket if the backlog is empty" do
batch = Statsd::Batch.new(@statsd)
batch.flush
@socket.recv.must_be :nil?
batch.increment 'foobar'
batch.flush
@socket.recv.must_equal %w[foobar:1|c]
end
it "should support setting namespace for the underlying instance" do
batch = Statsd::Batch.new(@statsd)
batch.namespace = 'ns'
@statsd.namespace.must_equal 'ns'
end
it "should support setting host for the underlying instance" do
batch = Statsd::Batch.new(@statsd)
batch.host = '1.2.3.4'
@statsd.host.must_equal '1.2.3.4'
end
it "should support setting port for the underlying instance" do
batch = Statsd::Batch.new(@statsd)
batch.port = 42
@statsd.port.must_equal 42
end
end
describe "#connect" do
it "should reconnect" do
c = $connect_count
@statsd.connect
($connect_count - c).must_equal 1
end
end
end
describe Statsd do
describe "with a real UDP socket" do
it "should actually send stuff over the socket" do
family = Addrinfo.udp(UDPSocket.getaddress('localhost'), 0).afamily
begin
socket = UDPSocket.new family
host, port = 'localhost', 0
socket.bind(host, port)
port = socket.addr[1]
statsd = Statsd.new(host, port)
statsd.increment('foobar')
message = socket.recvfrom(16).first
message.must_equal 'foobar:1|c'
ensure
socket.close
end
end
it "should send stuff over an IPv4 socket" do
begin
socket = UDPSocket.new Socket::AF_INET
host, port = '127.0.0.1', 0
socket.bind(host, port)
port = socket.addr[1]
statsd = Statsd.new(host, port)
statsd.increment('foobar')
message = socket.recvfrom(16).first
message.must_equal 'foobar:1|c'
ensure
socket.close
end
end
it "should send stuff over an IPv6 socket" do
begin
socket = UDPSocket.new Socket::AF_INET6
host, port = '::1', 0
socket.bind(host, port)
port = socket.addr[1]
statsd = Statsd.new(host, port)
statsd.increment('foobar')
message = socket.recvfrom(16).first
message.must_equal 'foobar:1|c'
ensure
socket.close
end
end
end
describe "supports TCP sockets" do
it "should connect to and send stats over TCPv4" do
begin
host, port = '127.0.0.1', 0
server = TCPServer.new host, port
port = server.addr[1]
socket = nil
Thread.new { socket = server.accept }
statsd = Statsd.new(host, port, :tcp)
statsd.increment('foobar')
Timeout.timeout(5) do
Thread.pass while socket == nil
end
message = socket.recvfrom(16).first
message.must_equal 'foobar:1|c'
ensure
socket.close if socket
server.close
end
end
it "should connect to and send stats over TCPv6" do
begin
host, port = '::1', 0
server = TCPServer.new host, port
port = server.addr[1]
socket = nil
Thread.new { socket = server.accept }
statsd = Statsd.new(host, port, :tcp)
statsd.increment('foobar')
Timeout.timeout(5) do
Thread.pass while socket == nil
end
message = socket.recvfrom(16).first
message.must_equal 'foobar:1|c'
ensure
socket.close if socket
server.close
end
end
end
end
|