ezmetrics 1.2.1 → 2.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +21 -674
  3. data/README.md +157 -44
  4. data/lib/ezmetrics.rb +144 -32
  5. data/lib/ezmetrics/benchmark.rb +36 -27
  6. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 61d26fa5d7a779917ac2ba154e82f29745a22b64261442117d15b286d0e06276
4
- data.tar.gz: 44ff087c54cf0e5fdf8763b88deaa59f3ccdfa1e11c12ab5c1da2eebdeea7764
3
+ metadata.gz: 8285f47dd4bba3f689deb9547be625a3f1b1bd6c1a5834b3d7a51604999e2d9d
4
+ data.tar.gz: d344781510df94d4394edd207723cf82037a34850077d341f57c7b9b54b351f3
5
5
  SHA512:
6
- metadata.gz: 6bf28edd6c644648198905bcdf50a77a0083c53b6eba312b709e9c1cb951adba1c407cbc28ac3ae0588b15185b5aa0132ef1f568ff30af0158b770d388460885
7
- data.tar.gz: a08685fea3025b23e5dca7439e9b7f4f2313933363b01a716e68eba800e4b96fce0d976cf25111c0e7a36f655abb6497e3481d39caba881b2ee706e49958b365
6
+ metadata.gz: 9e7d50a7d5a39290aa6dcd488d804caec87f8259e3bbde8a6e8bd9f817c16cf6919769cc95ca64366b076b53dac6abb48e33f9c9550d0123e7d681ba652b25f3
7
+ data.tar.gz: 39e1b548e6f89fda6a92f0c02425b7b5ef81d1cbf525494cfecef98854f23ecb0922ef16b309b0ac718cca8937302005bd1d04cd6a91d87cef7f45891a65619b
data/LICENSE CHANGED
@@ -1,674 +1,21 @@
1
- GNU GENERAL PUBLIC LICENSE
2
- Version 3, 29 June 2007
3
-
4
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5
- Everyone is permitted to copy and distribute verbatim copies
6
- of this license document, but changing it is not allowed.
7
-
8
- Preamble
9
-
10
- The GNU General Public License is a free, copyleft license for
11
- software and other kinds of works.
12
-
13
- The licenses for most software and other practical works are designed
14
- to take away your freedom to share and change the works. By contrast,
15
- the GNU General Public License is intended to guarantee your freedom to
16
- share and change all versions of a program--to make sure it remains free
17
- software for all its users. We, the Free Software Foundation, use the
18
- GNU General Public License for most of our software; it applies also to
19
- any other work released this way by its authors. You can apply it to
20
- your programs, too.
21
-
22
- When we speak of free software, we are referring to freedom, not
23
- price. Our General Public Licenses are designed to make sure that you
24
- have the freedom to distribute copies of free software (and charge for
25
- them if you wish), that you receive source code or can get it if you
26
- want it, that you can change the software or use pieces of it in new
27
- free programs, and that you know you can do these things.
28
-
29
- To protect your rights, we need to prevent others from denying you
30
- these rights or asking you to surrender the rights. Therefore, you have
31
- certain responsibilities if you distribute copies of the software, or if
32
- you modify it: responsibilities to respect the freedom of others.
33
-
34
- For example, if you distribute copies of such a program, whether
35
- gratis or for a fee, you must pass on to the recipients the same
36
- freedoms that you received. You must make sure that they, too, receive
37
- or can get the source code. And you must show them these terms so they
38
- know their rights.
39
-
40
- Developers that use the GNU GPL protect your rights with two steps:
41
- (1) assert copyright on the software, and (2) offer you this License
42
- giving you legal permission to copy, distribute and/or modify it.
43
-
44
- For the developers' and authors' protection, the GPL clearly explains
45
- that there is no warranty for this free software. For both users' and
46
- authors' sake, the GPL requires that modified versions be marked as
47
- changed, so that their problems will not be attributed erroneously to
48
- authors of previous versions.
49
-
50
- Some devices are designed to deny users access to install or run
51
- modified versions of the software inside them, although the manufacturer
52
- can do so. This is fundamentally incompatible with the aim of
53
- protecting users' freedom to change the software. The systematic
54
- pattern of such abuse occurs in the area of products for individuals to
55
- use, which is precisely where it is most unacceptable. Therefore, we
56
- have designed this version of the GPL to prohibit the practice for those
57
- products. If such problems arise substantially in other domains, we
58
- stand ready to extend this provision to those domains in future versions
59
- of the GPL, as needed to protect the freedom of users.
60
-
61
- Finally, every program is threatened constantly by software patents.
62
- States should not allow patents to restrict development and use of
63
- software on general-purpose computers, but in those that do, we wish to
64
- avoid the special danger that patents applied to a free program could
65
- make it effectively proprietary. To prevent this, the GPL assures that
66
- patents cannot be used to render the program non-free.
67
-
68
- The precise terms and conditions for copying, distribution and
69
- modification follow.
70
-
71
- TERMS AND CONDITIONS
72
-
73
- 0. Definitions.
74
-
75
- "This License" refers to version 3 of the GNU General Public License.
76
-
77
- "Copyright" also means copyright-like laws that apply to other kinds of
78
- works, such as semiconductor masks.
79
-
80
- "The Program" refers to any copyrightable work licensed under this
81
- License. Each licensee is addressed as "you". "Licensees" and
82
- "recipients" may be individuals or organizations.
83
-
84
- To "modify" a work means to copy from or adapt all or part of the work
85
- in a fashion requiring copyright permission, other than the making of an
86
- exact copy. The resulting work is called a "modified version" of the
87
- earlier work or a work "based on" the earlier work.
88
-
89
- A "covered work" means either the unmodified Program or a work based
90
- on the Program.
91
-
92
- To "propagate" a work means to do anything with it that, without
93
- permission, would make you directly or secondarily liable for
94
- infringement under applicable copyright law, except executing it on a
95
- computer or modifying a private copy. Propagation includes copying,
96
- distribution (with or without modification), making available to the
97
- public, and in some countries other activities as well.
98
-
99
- To "convey" a work means any kind of propagation that enables other
100
- parties to make or receive copies. Mere interaction with a user through
101
- a computer network, with no transfer of a copy, is not conveying.
102
-
103
- An interactive user interface displays "Appropriate Legal Notices"
104
- to the extent that it includes a convenient and prominently visible
105
- feature that (1) displays an appropriate copyright notice, and (2)
106
- tells the user that there is no warranty for the work (except to the
107
- extent that warranties are provided), that licensees may convey the
108
- work under this License, and how to view a copy of this License. If
109
- the interface presents a list of user commands or options, such as a
110
- menu, a prominent item in the list meets this criterion.
111
-
112
- 1. Source Code.
113
-
114
- The "source code" for a work means the preferred form of the work
115
- for making modifications to it. "Object code" means any non-source
116
- form of a work.
117
-
118
- A "Standard Interface" means an interface that either is an official
119
- standard defined by a recognized standards body, or, in the case of
120
- interfaces specified for a particular programming language, one that
121
- is widely used among developers working in that language.
122
-
123
- The "System Libraries" of an executable work include anything, other
124
- than the work as a whole, that (a) is included in the normal form of
125
- packaging a Major Component, but which is not part of that Major
126
- Component, and (b) serves only to enable use of the work with that
127
- Major Component, or to implement a Standard Interface for which an
128
- implementation is available to the public in source code form. A
129
- "Major Component", in this context, means a major essential component
130
- (kernel, window system, and so on) of the specific operating system
131
- (if any) on which the executable work runs, or a compiler used to
132
- produce the work, or an object code interpreter used to run it.
133
-
134
- The "Corresponding Source" for a work in object code form means all
135
- the source code needed to generate, install, and (for an executable
136
- work) run the object code and to modify the work, including scripts to
137
- control those activities. However, it does not include the work's
138
- System Libraries, or general-purpose tools or generally available free
139
- programs which are used unmodified in performing those activities but
140
- which are not part of the work. For example, Corresponding Source
141
- includes interface definition files associated with source files for
142
- the work, and the source code for shared libraries and dynamically
143
- linked subprograms that the work is specifically designed to require,
144
- such as by intimate data communication or control flow between those
145
- subprograms and other parts of the work.
146
-
147
- The Corresponding Source need not include anything that users
148
- can regenerate automatically from other parts of the Corresponding
149
- Source.
150
-
151
- The Corresponding Source for a work in source code form is that
152
- same work.
153
-
154
- 2. Basic Permissions.
155
-
156
- All rights granted under this License are granted for the term of
157
- copyright on the Program, and are irrevocable provided the stated
158
- conditions are met. This License explicitly affirms your unlimited
159
- permission to run the unmodified Program. The output from running a
160
- covered work is covered by this License only if the output, given its
161
- content, constitutes a covered work. This License acknowledges your
162
- rights of fair use or other equivalent, as provided by copyright law.
163
-
164
- You may make, run and propagate covered works that you do not
165
- convey, without conditions so long as your license otherwise remains
166
- in force. You may convey covered works to others for the sole purpose
167
- of having them make modifications exclusively for you, or provide you
168
- with facilities for running those works, provided that you comply with
169
- the terms of this License in conveying all material for which you do
170
- not control copyright. Those thus making or running the covered works
171
- for you must do so exclusively on your behalf, under your direction
172
- and control, on terms that prohibit them from making any copies of
173
- your copyrighted material outside their relationship with you.
174
-
175
- Conveying under any other circumstances is permitted solely under
176
- the conditions stated below. Sublicensing is not allowed; section 10
177
- makes it unnecessary.
178
-
179
- 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180
-
181
- No covered work shall be deemed part of an effective technological
182
- measure under any applicable law fulfilling obligations under article
183
- 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184
- similar laws prohibiting or restricting circumvention of such
185
- measures.
186
-
187
- When you convey a covered work, you waive any legal power to forbid
188
- circumvention of technological measures to the extent such circumvention
189
- is effected by exercising rights under this License with respect to
190
- the covered work, and you disclaim any intention to limit operation or
191
- modification of the work as a means of enforcing, against the work's
192
- users, your or third parties' legal rights to forbid circumvention of
193
- technological measures.
194
-
195
- 4. Conveying Verbatim Copies.
196
-
197
- You may convey verbatim copies of the Program's source code as you
198
- receive it, in any medium, provided that you conspicuously and
199
- appropriately publish on each copy an appropriate copyright notice;
200
- keep intact all notices stating that this License and any
201
- non-permissive terms added in accord with section 7 apply to the code;
202
- keep intact all notices of the absence of any warranty; and give all
203
- recipients a copy of this License along with the Program.
204
-
205
- You may charge any price or no price for each copy that you convey,
206
- and you may offer support or warranty protection for a fee.
207
-
208
- 5. Conveying Modified Source Versions.
209
-
210
- You may convey a work based on the Program, or the modifications to
211
- produce it from the Program, in the form of source code under the
212
- terms of section 4, provided that you also meet all of these conditions:
213
-
214
- a) The work must carry prominent notices stating that you modified
215
- it, and giving a relevant date.
216
-
217
- b) The work must carry prominent notices stating that it is
218
- released under this License and any conditions added under section
219
- 7. This requirement modifies the requirement in section 4 to
220
- "keep intact all notices".
221
-
222
- c) You must license the entire work, as a whole, under this
223
- License to anyone who comes into possession of a copy. This
224
- License will therefore apply, along with any applicable section 7
225
- additional terms, to the whole of the work, and all its parts,
226
- regardless of how they are packaged. This License gives no
227
- permission to license the work in any other way, but it does not
228
- invalidate such permission if you have separately received it.
229
-
230
- d) If the work has interactive user interfaces, each must display
231
- Appropriate Legal Notices; however, if the Program has interactive
232
- interfaces that do not display Appropriate Legal Notices, your
233
- work need not make them do so.
234
-
235
- A compilation of a covered work with other separate and independent
236
- works, which are not by their nature extensions of the covered work,
237
- and which are not combined with it such as to form a larger program,
238
- in or on a volume of a storage or distribution medium, is called an
239
- "aggregate" if the compilation and its resulting copyright are not
240
- used to limit the access or legal rights of the compilation's users
241
- beyond what the individual works permit. Inclusion of a covered work
242
- in an aggregate does not cause this License to apply to the other
243
- parts of the aggregate.
244
-
245
- 6. Conveying Non-Source Forms.
246
-
247
- You may convey a covered work in object code form under the terms
248
- of sections 4 and 5, provided that you also convey the
249
- machine-readable Corresponding Source under the terms of this License,
250
- in one of these ways:
251
-
252
- a) Convey the object code in, or embodied in, a physical product
253
- (including a physical distribution medium), accompanied by the
254
- Corresponding Source fixed on a durable physical medium
255
- customarily used for software interchange.
256
-
257
- b) Convey the object code in, or embodied in, a physical product
258
- (including a physical distribution medium), accompanied by a
259
- written offer, valid for at least three years and valid for as
260
- long as you offer spare parts or customer support for that product
261
- model, to give anyone who possesses the object code either (1) a
262
- copy of the Corresponding Source for all the software in the
263
- product that is covered by this License, on a durable physical
264
- medium customarily used for software interchange, for a price no
265
- more than your reasonable cost of physically performing this
266
- conveying of source, or (2) access to copy the
267
- Corresponding Source from a network server at no charge.
268
-
269
- c) Convey individual copies of the object code with a copy of the
270
- written offer to provide the Corresponding Source. This
271
- alternative is allowed only occasionally and noncommercially, and
272
- only if you received the object code with such an offer, in accord
273
- with subsection 6b.
274
-
275
- d) Convey the object code by offering access from a designated
276
- place (gratis or for a charge), and offer equivalent access to the
277
- Corresponding Source in the same way through the same place at no
278
- further charge. You need not require recipients to copy the
279
- Corresponding Source along with the object code. If the place to
280
- copy the object code is a network server, the Corresponding Source
281
- may be on a different server (operated by you or a third party)
282
- that supports equivalent copying facilities, provided you maintain
283
- clear directions next to the object code saying where to find the
284
- Corresponding Source. Regardless of what server hosts the
285
- Corresponding Source, you remain obligated to ensure that it is
286
- available for as long as needed to satisfy these requirements.
287
-
288
- e) Convey the object code using peer-to-peer transmission, provided
289
- you inform other peers where the object code and Corresponding
290
- Source of the work are being offered to the general public at no
291
- charge under subsection 6d.
292
-
293
- A separable portion of the object code, whose source code is excluded
294
- from the Corresponding Source as a System Library, need not be
295
- included in conveying the object code work.
296
-
297
- A "User Product" is either (1) a "consumer product", which means any
298
- tangible personal property which is normally used for personal, family,
299
- or household purposes, or (2) anything designed or sold for incorporation
300
- into a dwelling. In determining whether a product is a consumer product,
301
- doubtful cases shall be resolved in favor of coverage. For a particular
302
- product received by a particular user, "normally used" refers to a
303
- typical or common use of that class of product, regardless of the status
304
- of the particular user or of the way in which the particular user
305
- actually uses, or expects or is expected to use, the product. A product
306
- is a consumer product regardless of whether the product has substantial
307
- commercial, industrial or non-consumer uses, unless such uses represent
308
- the only significant mode of use of the product.
309
-
310
- "Installation Information" for a User Product means any methods,
311
- procedures, authorization keys, or other information required to install
312
- and execute modified versions of a covered work in that User Product from
313
- a modified version of its Corresponding Source. The information must
314
- suffice to ensure that the continued functioning of the modified object
315
- code is in no case prevented or interfered with solely because
316
- modification has been made.
317
-
318
- If you convey an object code work under this section in, or with, or
319
- specifically for use in, a User Product, and the conveying occurs as
320
- part of a transaction in which the right of possession and use of the
321
- User Product is transferred to the recipient in perpetuity or for a
322
- fixed term (regardless of how the transaction is characterized), the
323
- Corresponding Source conveyed under this section must be accompanied
324
- by the Installation Information. But this requirement does not apply
325
- if neither you nor any third party retains the ability to install
326
- modified object code on the User Product (for example, the work has
327
- been installed in ROM).
328
-
329
- The requirement to provide Installation Information does not include a
330
- requirement to continue to provide support service, warranty, or updates
331
- for a work that has been modified or installed by the recipient, or for
332
- the User Product in which it has been modified or installed. Access to a
333
- network may be denied when the modification itself materially and
334
- adversely affects the operation of the network or violates the rules and
335
- protocols for communication across the network.
336
-
337
- Corresponding Source conveyed, and Installation Information provided,
338
- in accord with this section must be in a format that is publicly
339
- documented (and with an implementation available to the public in
340
- source code form), and must require no special password or key for
341
- unpacking, reading or copying.
342
-
343
- 7. Additional Terms.
344
-
345
- "Additional permissions" are terms that supplement the terms of this
346
- License by making exceptions from one or more of its conditions.
347
- Additional permissions that are applicable to the entire Program shall
348
- be treated as though they were included in this License, to the extent
349
- that they are valid under applicable law. If additional permissions
350
- apply only to part of the Program, that part may be used separately
351
- under those permissions, but the entire Program remains governed by
352
- this License without regard to the additional permissions.
353
-
354
- When you convey a copy of a covered work, you may at your option
355
- remove any additional permissions from that copy, or from any part of
356
- it. (Additional permissions may be written to require their own
357
- removal in certain cases when you modify the work.) You may place
358
- additional permissions on material, added by you to a covered work,
359
- for which you have or can give appropriate copyright permission.
360
-
361
- Notwithstanding any other provision of this License, for material you
362
- add to a covered work, you may (if authorized by the copyright holders of
363
- that material) supplement the terms of this License with terms:
364
-
365
- a) Disclaiming warranty or limiting liability differently from the
366
- terms of sections 15 and 16 of this License; or
367
-
368
- b) Requiring preservation of specified reasonable legal notices or
369
- author attributions in that material or in the Appropriate Legal
370
- Notices displayed by works containing it; or
371
-
372
- c) Prohibiting misrepresentation of the origin of that material, or
373
- requiring that modified versions of such material be marked in
374
- reasonable ways as different from the original version; or
375
-
376
- d) Limiting the use for publicity purposes of names of licensors or
377
- authors of the material; or
378
-
379
- e) Declining to grant rights under trademark law for use of some
380
- trade names, trademarks, or service marks; or
381
-
382
- f) Requiring indemnification of licensors and authors of that
383
- material by anyone who conveys the material (or modified versions of
384
- it) with contractual assumptions of liability to the recipient, for
385
- any liability that these contractual assumptions directly impose on
386
- those licensors and authors.
387
-
388
- All other non-permissive additional terms are considered "further
389
- restrictions" within the meaning of section 10. If the Program as you
390
- received it, or any part of it, contains a notice stating that it is
391
- governed by this License along with a term that is a further
392
- restriction, you may remove that term. If a license document contains
393
- a further restriction but permits relicensing or conveying under this
394
- License, you may add to a covered work material governed by the terms
395
- of that license document, provided that the further restriction does
396
- not survive such relicensing or conveying.
397
-
398
- If you add terms to a covered work in accord with this section, you
399
- must place, in the relevant source files, a statement of the
400
- additional terms that apply to those files, or a notice indicating
401
- where to find the applicable terms.
402
-
403
- Additional terms, permissive or non-permissive, may be stated in the
404
- form of a separately written license, or stated as exceptions;
405
- the above requirements apply either way.
406
-
407
- 8. Termination.
408
-
409
- You may not propagate or modify a covered work except as expressly
410
- provided under this License. Any attempt otherwise to propagate or
411
- modify it is void, and will automatically terminate your rights under
412
- this License (including any patent licenses granted under the third
413
- paragraph of section 11).
414
-
415
- However, if you cease all violation of this License, then your
416
- license from a particular copyright holder is reinstated (a)
417
- provisionally, unless and until the copyright holder explicitly and
418
- finally terminates your license, and (b) permanently, if the copyright
419
- holder fails to notify you of the violation by some reasonable means
420
- prior to 60 days after the cessation.
421
-
422
- Moreover, your license from a particular copyright holder is
423
- reinstated permanently if the copyright holder notifies you of the
424
- violation by some reasonable means, this is the first time you have
425
- received notice of violation of this License (for any work) from that
426
- copyright holder, and you cure the violation prior to 30 days after
427
- your receipt of the notice.
428
-
429
- Termination of your rights under this section does not terminate the
430
- licenses of parties who have received copies or rights from you under
431
- this License. If your rights have been terminated and not permanently
432
- reinstated, you do not qualify to receive new licenses for the same
433
- material under section 10.
434
-
435
- 9. Acceptance Not Required for Having Copies.
436
-
437
- You are not required to accept this License in order to receive or
438
- run a copy of the Program. Ancillary propagation of a covered work
439
- occurring solely as a consequence of using peer-to-peer transmission
440
- to receive a copy likewise does not require acceptance. However,
441
- nothing other than this License grants you permission to propagate or
442
- modify any covered work. These actions infringe copyright if you do
443
- not accept this License. Therefore, by modifying or propagating a
444
- covered work, you indicate your acceptance of this License to do so.
445
-
446
- 10. Automatic Licensing of Downstream Recipients.
447
-
448
- Each time you convey a covered work, the recipient automatically
449
- receives a license from the original licensors, to run, modify and
450
- propagate that work, subject to this License. You are not responsible
451
- for enforcing compliance by third parties with this License.
452
-
453
- An "entity transaction" is a transaction transferring control of an
454
- organization, or substantially all assets of one, or subdividing an
455
- organization, or merging organizations. If propagation of a covered
456
- work results from an entity transaction, each party to that
457
- transaction who receives a copy of the work also receives whatever
458
- licenses to the work the party's predecessor in interest had or could
459
- give under the previous paragraph, plus a right to possession of the
460
- Corresponding Source of the work from the predecessor in interest, if
461
- the predecessor has it or can get it with reasonable efforts.
462
-
463
- You may not impose any further restrictions on the exercise of the
464
- rights granted or affirmed under this License. For example, you may
465
- not impose a license fee, royalty, or other charge for exercise of
466
- rights granted under this License, and you may not initiate litigation
467
- (including a cross-claim or counterclaim in a lawsuit) alleging that
468
- any patent claim is infringed by making, using, selling, offering for
469
- sale, or importing the Program or any portion of it.
470
-
471
- 11. Patents.
472
-
473
- A "contributor" is a copyright holder who authorizes use under this
474
- License of the Program or a work on which the Program is based. The
475
- work thus licensed is called the contributor's "contributor version".
476
-
477
- A contributor's "essential patent claims" are all patent claims
478
- owned or controlled by the contributor, whether already acquired or
479
- hereafter acquired, that would be infringed by some manner, permitted
480
- by this License, of making, using, or selling its contributor version,
481
- but do not include claims that would be infringed only as a
482
- consequence of further modification of the contributor version. For
483
- purposes of this definition, "control" includes the right to grant
484
- patent sublicenses in a manner consistent with the requirements of
485
- this License.
486
-
487
- Each contributor grants you a non-exclusive, worldwide, royalty-free
488
- patent license under the contributor's essential patent claims, to
489
- make, use, sell, offer for sale, import and otherwise run, modify and
490
- propagate the contents of its contributor version.
491
-
492
- In the following three paragraphs, a "patent license" is any express
493
- agreement or commitment, however denominated, not to enforce a patent
494
- (such as an express permission to practice a patent or covenant not to
495
- sue for patent infringement). To "grant" such a patent license to a
496
- party means to make such an agreement or commitment not to enforce a
497
- patent against the party.
498
-
499
- If you convey a covered work, knowingly relying on a patent license,
500
- and the Corresponding Source of the work is not available for anyone
501
- to copy, free of charge and under the terms of this License, through a
502
- publicly available network server or other readily accessible means,
503
- then you must either (1) cause the Corresponding Source to be so
504
- available, or (2) arrange to deprive yourself of the benefit of the
505
- patent license for this particular work, or (3) arrange, in a manner
506
- consistent with the requirements of this License, to extend the patent
507
- license to downstream recipients. "Knowingly relying" means you have
508
- actual knowledge that, but for the patent license, your conveying the
509
- covered work in a country, or your recipient's use of the covered work
510
- in a country, would infringe one or more identifiable patents in that
511
- country that you have reason to believe are valid.
512
-
513
- If, pursuant to or in connection with a single transaction or
514
- arrangement, you convey, or propagate by procuring conveyance of, a
515
- covered work, and grant a patent license to some of the parties
516
- receiving the covered work authorizing them to use, propagate, modify
517
- or convey a specific copy of the covered work, then the patent license
518
- you grant is automatically extended to all recipients of the covered
519
- work and works based on it.
520
-
521
- A patent license is "discriminatory" if it does not include within
522
- the scope of its coverage, prohibits the exercise of, or is
523
- conditioned on the non-exercise of one or more of the rights that are
524
- specifically granted under this License. You may not convey a covered
525
- work if you are a party to an arrangement with a third party that is
526
- in the business of distributing software, under which you make payment
527
- to the third party based on the extent of your activity of conveying
528
- the work, and under which the third party grants, to any of the
529
- parties who would receive the covered work from you, a discriminatory
530
- patent license (a) in connection with copies of the covered work
531
- conveyed by you (or copies made from those copies), or (b) primarily
532
- for and in connection with specific products or compilations that
533
- contain the covered work, unless you entered into that arrangement,
534
- or that patent license was granted, prior to 28 March 2007.
535
-
536
- Nothing in this License shall be construed as excluding or limiting
537
- any implied license or other defenses to infringement that may
538
- otherwise be available to you under applicable patent law.
539
-
540
- 12. No Surrender of Others' Freedom.
541
-
542
- If conditions are imposed on you (whether by court order, agreement or
543
- otherwise) that contradict the conditions of this License, they do not
544
- excuse you from the conditions of this License. If you cannot convey a
545
- covered work so as to satisfy simultaneously your obligations under this
546
- License and any other pertinent obligations, then as a consequence you may
547
- not convey it at all. For example, if you agree to terms that obligate you
548
- to collect a royalty for further conveying from those to whom you convey
549
- the Program, the only way you could satisfy both those terms and this
550
- License would be to refrain entirely from conveying the Program.
551
-
552
- 13. Use with the GNU Affero General Public License.
553
-
554
- Notwithstanding any other provision of this License, you have
555
- permission to link or combine any covered work with a work licensed
556
- under version 3 of the GNU Affero General Public License into a single
557
- combined work, and to convey the resulting work. The terms of this
558
- License will continue to apply to the part which is the covered work,
559
- but the special requirements of the GNU Affero General Public License,
560
- section 13, concerning interaction through a network will apply to the
561
- combination as such.
562
-
563
- 14. Revised Versions of this License.
564
-
565
- The Free Software Foundation may publish revised and/or new versions of
566
- the GNU General Public License from time to time. Such new versions will
567
- be similar in spirit to the present version, but may differ in detail to
568
- address new problems or concerns.
569
-
570
- Each version is given a distinguishing version number. If the
571
- Program specifies that a certain numbered version of the GNU General
572
- Public License "or any later version" applies to it, you have the
573
- option of following the terms and conditions either of that numbered
574
- version or of any later version published by the Free Software
575
- Foundation. If the Program does not specify a version number of the
576
- GNU General Public License, you may choose any version ever published
577
- by the Free Software Foundation.
578
-
579
- If the Program specifies that a proxy can decide which future
580
- versions of the GNU General Public License can be used, that proxy's
581
- public statement of acceptance of a version permanently authorizes you
582
- to choose that version for the Program.
583
-
584
- Later license versions may give you additional or different
585
- permissions. However, no additional obligations are imposed on any
586
- author or copyright holder as a result of your choosing to follow a
587
- later version.
588
-
589
- 15. Disclaimer of Warranty.
590
-
591
- THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592
- APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593
- HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594
- OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595
- THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596
- PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597
- IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598
- ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599
-
600
- 16. Limitation of Liability.
601
-
602
- IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603
- WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604
- THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605
- GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606
- USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607
- DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608
- PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609
- EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610
- SUCH DAMAGES.
611
-
612
- 17. Interpretation of Sections 15 and 16.
613
-
614
- If the disclaimer of warranty and limitation of liability provided
615
- above cannot be given local legal effect according to their terms,
616
- reviewing courts shall apply local law that most closely approximates
617
- an absolute waiver of all civil liability in connection with the
618
- Program, unless a warranty or assumption of liability accompanies a
619
- copy of the Program in return for a fee.
620
-
621
- END OF TERMS AND CONDITIONS
622
-
623
- How to Apply These Terms to Your New Programs
624
-
625
- If you develop a new program, and you want it to be of the greatest
626
- possible use to the public, the best way to achieve this is to make it
627
- free software which everyone can redistribute and change under these terms.
628
-
629
- To do so, attach the following notices to the program. It is safest
630
- to attach them to the start of each source file to most effectively
631
- state the exclusion of warranty; and each file should have at least
632
- the "copyright" line and a pointer to where the full notice is found.
633
-
634
- <one line to give the program's name and a brief idea of what it does.>
635
- Copyright (C) <year> <name of author>
636
-
637
- This program is free software: you can redistribute it and/or modify
638
- it under the terms of the GNU General Public License as published by
639
- the Free Software Foundation, either version 3 of the License, or
640
- (at your option) any later version.
641
-
642
- This program is distributed in the hope that it will be useful,
643
- but WITHOUT ANY WARRANTY; without even the implied warranty of
644
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645
- GNU General Public License for more details.
646
-
647
- You should have received a copy of the GNU General Public License
648
- along with this program. If not, see <https://www.gnu.org/licenses/>.
649
-
650
- Also add information on how to contact you by electronic and paper mail.
651
-
652
- If the program does terminal interaction, make it output a short
653
- notice like this when it starts in an interactive mode:
654
-
655
- <program> Copyright (C) <year> <name of author>
656
- This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657
- This is free software, and you are welcome to redistribute it
658
- under certain conditions; type `show c' for details.
659
-
660
- The hypothetical commands `show w' and `show c' should show the appropriate
661
- parts of the General Public License. Of course, your program's commands
662
- might be different; for a GUI interface, you would use an "about box".
663
-
664
- You should also get your employer (if you work as a programmer) or school,
665
- if any, to sign a "copyright disclaimer" for the program, if necessary.
666
- For more information on this, and how to apply and follow the GNU GPL, see
667
- <https://www.gnu.org/licenses/>.
668
-
669
- The GNU General Public License does not permit incorporating your program
670
- into proprietary programs. If your program is a subroutine library, you
671
- may consider it more useful to permit linking proprietary applications with
672
- the library. If this is what you want to do, use the GNU Lesser General
673
- Public License instead of this License. But first, please read
674
- <https://www.gnu.org/licenses/why-not-lgpl.html>.
1
+ MIT License
2
+
3
+ Copyright (c) 2019 Nicolae Rotaru
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
data/README.md CHANGED
@@ -10,6 +10,16 @@ Simple, lightweight and fast metrics aggregation for Rails.
10
10
  gem 'ezmetrics'
11
11
  ```
12
12
 
13
+ ## Available metrics
14
+
15
+ | Type | Aggregate functions |
16
+ | :--------: | :-------------------------------: |
17
+ | `duration` | `avg`, `max`, `percentile` |
18
+ | `views` | `avg`, `max`, `percentile` |
19
+ | `db` | `avg`, `max`, `percentile` |
20
+ | `queries` | `avg`, `max`, `percentile` |
21
+ | `requests` | `all`, `2xx`, `3xx`, `4xx`, `5xx` |
22
+
13
23
  ## Usage
14
24
 
15
25
  ### Getting started
@@ -27,25 +37,25 @@ and stores them for the timeframe you specified, 60 seconds by default.
27
37
  You can change the timeframe according to your needs and save the metrics by calling `log` method:
28
38
 
29
39
  ```ruby
30
- # Store the metrics for 60 seconds (default behaviour)
31
- EZmetrics.new.log(
32
- duration: 100.5,
33
- views: 40.7,
34
- db: 59.8,
35
- queries: 4,
36
- status: 200
37
- )
40
+ # Store the metrics for 60 seconds (default behaviour)
41
+ EZmetrics.new.log(
42
+ duration: 100.5,
43
+ views: 40.7,
44
+ db: 59.8,
45
+ queries: 4,
46
+ status: 200
47
+ )
38
48
  ```
39
49
 
40
50
  ```ruby
41
- # Store the metrics for 10 minutes
42
- EZmetrics.new(10.minutes).log(
43
- duration: 100.5,
44
- views: 40.7,
45
- db: 59.8,
46
- queries: 4,
47
- status: 200
48
- )
51
+ # Store the metrics for 10 minutes
52
+ EZmetrics.new(10.minutes).log(
53
+ duration: 100.5,
54
+ views: 40.7,
55
+ db: 59.8,
56
+ queries: 4,
57
+ status: 200
58
+ )
49
59
  ```
50
60
 
51
61
  ---
@@ -53,13 +63,13 @@ You can change the timeframe according to your needs and save the metrics by cal
53
63
  For displaying metrics you need to call `show` method:
54
64
 
55
65
  ```ruby
56
- # Aggregate and show metrics for last 60 seconds (default behaviour)
57
- EZmetrics.new.show
66
+ # Aggregate and show metrics for last 60 seconds (default behaviour)
67
+ EZmetrics.new.show
58
68
  ```
59
69
 
60
70
  ```ruby
61
- # Aggregate and show metrics for last 10 minutes
62
- EZmetrics.new(10.minutes).show
71
+ # Aggregate and show metrics for last 10 minutes
72
+ EZmetrics.new(10.minutes).show
63
73
  ```
64
74
 
65
75
  You can combine these timeframes, for example - store for 10 minutes, display for 5 minutes.
@@ -131,6 +141,47 @@ This will return a hash with the following structure:
131
141
  }
132
142
  ```
133
143
 
144
+ ---
145
+
146
+ If you prefer a single level object - you can change the default output structure by calling `.flatten` before `.show`
147
+
148
+ ```ruby
149
+ EZmetrics.new(1.hour).flatten.show(db: :avg, duration: [:avg, :max])
150
+ ```
151
+
152
+ ```ruby
153
+ {
154
+ db_avg: 182,
155
+ duration_avg: 205,
156
+ duration_max: 5171
157
+ }
158
+ ```
159
+
160
+ ---
161
+
162
+ Same for [partitioned aggregation](#partitioning)
163
+
164
+ ```ruby
165
+ EZmetrics.new(1.hour).partition_by(:minute).flatten.show(db: :avg, duration: [:avg, :max])
166
+ ```
167
+
168
+ ```ruby
169
+ [
170
+ {
171
+ timestamp: 1575242880,
172
+ db_avg: 387,
173
+ duration_avg: 477,
174
+ duration_max: 8566
175
+ },
176
+ {
177
+ timestamp: 1575242940,
178
+ db_avg: 123,
179
+ duration_avg: 234,
180
+ duration_max: 3675
181
+ }
182
+ ]
183
+ ```
184
+
134
185
  ### Aggregation
135
186
 
136
187
  The aggregation can be easily configured by specifying aggregation options as in the following examples:
@@ -217,15 +268,79 @@ EZmetrics.new.show(views: :avg, :db: [:avg, :max], requests: true)
217
268
  }
218
269
  ```
219
270
 
271
+ ---
272
+
273
+ **5. Percentile**
274
+
275
+ This feature is available since version `2.0.0`.
276
+
277
+ By default percentile aggregation is turned off because it requires to store each value of all metrics.
278
+
279
+ To enable this feature - you need to set `store_each_value: true` when saving the metrics:
280
+
281
+ ```ruby
282
+ EZmetrics.new.log(
283
+ duration: 100.5,
284
+ views: 40.7,
285
+ db: 59.8,
286
+ queries: 4,
287
+ status: 200,
288
+ store_each_value: true
289
+ )
290
+ ```
291
+
292
+ The aggregation syntax has the following format `metrics_type: :percentile_{number}` where `number` is any integer in the 1..99 range.
293
+
294
+ ```ruby
295
+ EZmetrics.new.show(db: [:avg, :percentile_90, :percentile_95], duration: :percentile_99)
296
+ ```
297
+
298
+ ```ruby
299
+ {
300
+ db: {
301
+ avg: 155,
302
+ percentile_90: 205,
303
+ percentile_95: 215
304
+ },
305
+ duration: {
306
+ percentile_99: 236
307
+ }
308
+ }
309
+ ```
310
+
311
+ **6. Percentile distribution**
312
+
313
+ If you want to visualize percentile distribution (from 1% to 99%):
314
+
315
+ ```ruby
316
+ EZmetrics.new.show(duration: :percentile_distribution)
317
+ ```
318
+
319
+ ```ruby
320
+ {
321
+ duration: {
322
+ percentile_distribution: {
323
+ 1: 12,
324
+ 2: 15,
325
+ 3: 19,
326
+ #...
327
+ 97: 6540,
328
+ 98: 6682,
329
+ 99: 6730
330
+ }
331
+ }
332
+ }
333
+ ```
334
+
220
335
  ### Partitioning
221
336
 
222
337
  If you want to visualize your metrics by using a **line chart**, you will need to use partitioning.
223
338
 
224
- To aggregate metrics, partitioned by a unit of time you need to call `partition_by({time_unit})` before calling `show`
339
+ To aggregate metrics, partitioned by a unit of time you need to call `.partition_by({time_unit})` before calling `.show`
225
340
 
226
341
  ```ruby
227
- # Aggregate metrics for last hour, partition by minute
228
- EZmetrics.new(1.hour).partition_by(:minute).show(duration: [:avg, :max], db: :avg)
342
+ # Aggregate metrics for last hour, partition by minute
343
+ EZmetrics.new(1.hour).partition_by(:minute).show(duration: [:avg, :max], db: :avg)
229
344
  ```
230
345
 
231
346
  This will return an array of objects with the following structure:
@@ -276,34 +391,32 @@ Available time units for partitioning: `second`, `minute`, `hour`, `day`. Defaul
276
391
 
277
392
  The aggregation speed relies on the performance of **Redis** (data storage) and **Oj** (json serialization/parsing).
278
393
 
279
- You can check the **aggregation** time by running:
394
+ You can check the **aggregation** time (in seconds) by running:
280
395
 
281
396
  ```ruby
397
+ # 1. Simple
282
398
  EZmetrics::Benchmark.new.measure_aggregation
283
- ```
284
-
285
- | Interval | Duration (seconds) |
286
- | :------: | :----------------: |
287
- | 1 minute | 0.0 |
288
- | 1 hour | 0.04 |
289
- | 12 hours | 0.49 |
290
- | 24 hours | 1.51 |
291
- | 48 hours | 3.48 |
292
399
 
293
- ---
400
+ # 2. Partitioned
401
+ EZmetrics::Benchmark.new.measure_aggregation(:minute)
294
402
 
295
- To check the **partitioned aggregation** time you need to run:
403
+ # 3. Percentile
404
+ EZmetrics::Benchmark.new(true).measure_aggregation
296
405
 
297
- ```ruby
298
- EZmetrics::Benchmark.new.measure_aggregation(:minute)
406
+ # 4. Percentile (partitioned)
407
+ EZmetrics::Benchmark.new(true).measure_aggregation(:minute)
299
408
  ```
300
409
 
301
- | Interval | Duration (seconds) |
302
- | :------: | :----------------: |
303
- | 1 minute | 0.0 |
304
- | 1 hour | 0.04 |
305
- | 12 hours | 0.53 |
306
- | 24 hours | 1.59 |
307
- | 48 hours | 3.51 |
410
+ | Interval | Simple aggregation | Partitioned | Percentile | Percentile (partitioned) |
411
+ | :------: | :----------------: | :---------: | :--------: | :----------------------: |
412
+ | 1 minute | 0.0 | 0.0 | 0.0 | 0.0 |
413
+ | 1 hour | 0.02 | 0.02 | 0.14 | 0.16 |
414
+ | 12 hours | 0.22 | 0.25 | 2.11 | 1.97 |
415
+ | 24 hours | 0.61 | 0.78 | 5.85 | 5.85 |
416
+ | 48 hours | 1.42 | 1.75 | 14.1 | 13.9 |
308
417
 
309
418
  The benchmarks above were run on a _2017 Macbook Pro 2.9 GHz Intel Core i7 with 16 GB of RAM_
419
+
420
+ ### License
421
+
422
+ ezmetrics is released under the [MIT License](https://opensource.org/licenses/MIT).
data/lib/ezmetrics.rb CHANGED
@@ -9,16 +9,18 @@ class EZmetrics
9
9
 
10
10
  def initialize(interval_seconds=60)
11
11
  @interval_seconds = interval_seconds.to_i
12
- @redis = Redis.new
12
+ @redis = Redis.new(driver: :hiredis)
13
+ @schema = redis_schema
13
14
  end
14
15
 
15
- def log(payload={duration: 0.0, views: 0.0, db: 0.0, queries: 0, status: 200})
16
+ def log(payload={duration: 0.0, views: 0.0, db: 0.0, queries: 0, status: 200, store_each_value: false})
16
17
  @safe_payload = {
17
- duration: payload[:duration].to_f,
18
- views: payload[:views].to_f,
19
- db: payload[:db].to_f,
20
- queries: payload[:queries].to_i,
21
- status: payload[:status].to_i
18
+ duration: payload[:duration].to_f,
19
+ views: payload[:views].to_f,
20
+ db: payload[:db].to_f,
21
+ queries: payload[:queries].to_i,
22
+ status: payload[:status].to_i,
23
+ store_each_value: payload[:store_each_value].to_s == "true"
22
24
  }
23
25
 
24
26
  this_second = Time.now.to_i
@@ -31,10 +33,11 @@ class EZmetrics
31
33
  METRICS.each do |metrics_type|
32
34
  update_sum(metrics_type)
33
35
  update_max(metrics_type)
36
+ store_value(metrics_type) if safe_payload[:store_each_value]
34
37
  end
35
38
 
36
- this_second_metrics["statuses"]["all"] += 1
37
- this_second_metrics["statuses"][status_group] += 1
39
+ this_second_metrics[schema["all"]] += 1
40
+ this_second_metrics[schema[status_group]] += 1
38
41
  else
39
42
  @this_second_metrics = {
40
43
  "second" => this_second,
@@ -46,10 +49,25 @@ class EZmetrics
46
49
  "db_max" => safe_payload[:db],
47
50
  "queries_sum" => safe_payload[:queries],
48
51
  "queries_max" => safe_payload[:queries],
49
- "statuses" => { "2xx" => 0, "3xx" => 0, "4xx" => 0, "5xx" => 0, "all" => 1 }
52
+ "2xx" => 0,
53
+ "3xx" => 0,
54
+ "4xx" => 0,
55
+ "5xx" => 0,
56
+ "all" => 1
50
57
  }
51
58
 
52
- this_second_metrics["statuses"][status_group] = 1
59
+ if safe_payload[:store_each_value]
60
+ this_second_metrics.merge!(
61
+ "duration_values" => [safe_payload[:duration]],
62
+ "views_values" => [safe_payload[:views]],
63
+ "db_values" => [safe_payload[:db]],
64
+ "queries_values" => [safe_payload[:queries]]
65
+ )
66
+ end
67
+
68
+ this_second_metrics[status_group] = 1
69
+
70
+ @this_second_metrics = this_second_metrics.values
53
71
  end
54
72
 
55
73
  redis.setex(this_second, interval_seconds, Oj.dump(this_second_metrics))
@@ -63,20 +81,25 @@ class EZmetrics
63
81
  partitioned_metrics ? aggregate_partitioned_data : aggregate_data
64
82
  end
65
83
 
84
+ def flatten
85
+ @flat = true
86
+ self
87
+ end
88
+
66
89
  def partition_by(time_unit=:minute)
67
90
  time_unit = PARTITION_UNITS.include?(time_unit) ? time_unit : :minute
68
- @partitioned_metrics = interval_metrics.group_by { |h| second_to_partition_unit(time_unit, h["second"]) }
91
+ @partitioned_metrics = interval_metrics.group_by { |array| second_to_partition_unit(time_unit, array[schema["second"]]) }
69
92
  self
70
93
  end
71
94
 
72
95
  private
73
96
 
74
- attr_reader :redis, :interval_seconds, :interval_metrics, :requests,
97
+ attr_reader :redis, :interval_seconds, :interval_metrics, :requests, :flat, :schema,
75
98
  :storage_key, :safe_payload, :this_second_metrics, :partitioned_metrics, :options
76
99
 
77
100
  def aggregate_data
78
101
  return {} unless interval_metrics.any?
79
- @requests = interval_metrics.sum { |hash| hash["statuses"]["all"] }
102
+ @requests = interval_metrics.sum { |array| array[schema["all"]] }
80
103
  build_result
81
104
  rescue
82
105
  {}
@@ -85,17 +108,20 @@ class EZmetrics
85
108
  def aggregate_partitioned_data
86
109
  partitioned_metrics.map do |partition, metrics|
87
110
  @interval_metrics = metrics
88
- @requests = interval_metrics.sum { |hash| hash["statuses"]["all"] }
89
- { timestamp: partition, data: build_result }
111
+ @requests = interval_metrics.sum { |array| array[schema["all"]] }
112
+ METRICS.each { |metrics_type| instance_variable_set("@sorted_#{metrics_type}_values", nil) }
113
+ flat ? { timestamp: partition, **build_result } : { timestamp: partition, data: build_result }
90
114
  end
91
115
  rescue
92
- new(options)
116
+ self
93
117
  end
94
118
 
95
119
  def build_result
96
120
  result = {}
97
121
 
98
- result[:requests] = { all: requests, grouped: count_all_status_groups } if options[:requests]
122
+ if options[:requests]
123
+ append_requests_to_result(result, { all: requests, grouped: count_all_status_groups })
124
+ end
99
125
 
100
126
  options.each do |metrics, aggregation_functions|
101
127
  next unless METRICS.include?(metrics)
@@ -103,8 +129,8 @@ class EZmetrics
103
129
  next unless aggregation_functions.any?
104
130
 
105
131
  aggregation_functions.each do |aggregation_function|
106
- result[metrics] ||= {}
107
- result[metrics][aggregation_function] = aggregate(metrics, aggregation_function)
132
+ aggregated_metrics = aggregate(metrics, aggregation_function)
133
+ append_metrics_to_result(result, metrics, aggregation_function, aggregated_metrics)
108
134
  end
109
135
  end
110
136
  result
@@ -112,6 +138,22 @@ class EZmetrics
112
138
  result
113
139
  end
114
140
 
141
+ def append_requests_to_result(result, aggregated_requests)
142
+ return result[:requests] = aggregated_requests unless flat
143
+
144
+ result[:requests_all] = aggregated_requests[:all]
145
+ aggregated_requests[:grouped].each do |group, counter|
146
+ result[:"requests_#{group}"] = counter
147
+ end
148
+ end
149
+
150
+ def append_metrics_to_result(result, metrics, aggregation_function, aggregated_metrics)
151
+ return result[:"#{metrics}_#{aggregation_function}"] = aggregated_metrics if flat
152
+
153
+ result[metrics] ||= {}
154
+ result[metrics][aggregation_function] = aggregated_metrics
155
+ end
156
+
115
157
  def second_to_partition_unit(time_unit, second)
116
158
  return second if time_unit == :second
117
159
  time = Time.at(second)
@@ -124,39 +166,109 @@ class EZmetrics
124
166
  @interval_metrics ||= begin
125
167
  interval_start = Time.now.to_i - interval_seconds
126
168
  interval_keys = (interval_start..Time.now.to_i).to_a
127
- redis.mget(interval_keys).compact.map { |hash| Oj.load(hash) }
169
+ redis.mget(interval_keys).compact.map { |array| Oj.load(array) }
128
170
  end
129
171
  end
130
172
 
131
173
  def aggregate(metrics, aggregation_function)
132
- return unless AGGREGATION_FUNCTIONS.include?(aggregation_function)
133
174
  return avg("#{metrics}_sum") if aggregation_function == :avg
134
175
  return max("#{metrics}_max") if aggregation_function == :max
176
+
177
+ if aggregation_function == :percentile_distribution
178
+ sorted_values = send("sorted_#{metrics}_values")
179
+ return (1..99).to_a.inject({}) do |result, number|
180
+ result[number] = percentile(sorted_values, number)
181
+ result
182
+ end
183
+ end
184
+
185
+ percentile = aggregation_function.match(/percentile_(?<value>\d+)/)
186
+
187
+ if percentile && percentile["value"].to_i.between?(1, 99)
188
+ sorted_values = send("sorted_#{metrics}_values")
189
+ percentile(sorted_values, percentile["value"].to_i)
190
+ end
191
+ end
192
+
193
+ METRICS.each do |metrics|
194
+ define_method "sorted_#{metrics}_values" do
195
+ instance_variable_get("@sorted_#{metrics}_values") || instance_variable_set(
196
+ "@sorted_#{metrics}_values", interval_metrics.map { |array| array[schema["#{metrics}_values"]] }.flatten.compact.sort
197
+ )
198
+ end
199
+ end
200
+
201
+ def redis_schema
202
+ [
203
+ "second",
204
+ "duration_sum",
205
+ "duration_max",
206
+ "views_sum",
207
+ "views_max",
208
+ "db_sum",
209
+ "db_max",
210
+ "queries_sum",
211
+ "queries_max",
212
+ "2xx",
213
+ "3xx",
214
+ "4xx",
215
+ "5xx",
216
+ "all",
217
+ "duration_values",
218
+ "views_values",
219
+ "db_values",
220
+ "queries_values"
221
+ ].each_with_index.inject({}){ |result, pair| result[pair[0]] = pair[1] ; result }
135
222
  end
136
223
 
137
224
  def update_sum(metrics)
138
- this_second_metrics["#{metrics}_sum"] += safe_payload[metrics]
225
+ this_second_metrics[schema["#{metrics}_sum"]] += safe_payload[metrics]
226
+ end
227
+
228
+ def store_value(metrics)
229
+ this_second_metrics[schema["#{metrics}_values"]] << safe_payload[metrics]
139
230
  end
140
231
 
141
232
  def update_max(metrics)
142
- max_value = [safe_payload[metrics], this_second_metrics["#{metrics}_max"]].max
143
- this_second_metrics["#{metrics}_max"] = max_value
233
+ max_value = [safe_payload[metrics], this_second_metrics[schema["#{metrics}_max"]]].max
234
+ this_second_metrics[schema["#{metrics}_max"]] = max_value
144
235
  end
145
236
 
146
237
  def avg(metrics)
147
- (interval_metrics.sum { |h| h[metrics] }.to_f / requests).round
238
+ (interval_metrics.sum { |array| array[schema[metrics]] }.to_f / requests).round
148
239
  end
149
240
 
150
241
  def max(metrics)
151
- interval_metrics.max { |h| h[metrics] }[metrics].round
242
+ interval_metrics.max { |array| array[schema[metrics]] }[schema[metrics]].round
243
+ end
244
+
245
+ def percentile(sorted_array, pcnt)
246
+ array_length = sorted_array.length
247
+
248
+ return "not enough data (requests: #{array_length}, required: #{pcnt})" if array_length < pcnt
249
+
250
+ rank = (pcnt.to_f / 100) * (array_length + 1)
251
+ whole = rank.truncate
252
+
253
+ # if has fractional part
254
+ if whole != rank
255
+ s0 = sorted_array[whole - 1]
256
+ s1 = sorted_array[whole]
257
+
258
+ f = (rank - rank.truncate).abs
259
+
260
+ return ((f * (s1 - s0)) + s0)&.round
261
+ else
262
+ return (sorted_array[whole - 1])&.round
263
+ end
152
264
  end
153
265
 
154
266
  def count_all_status_groups
155
- interval_metrics.inject({ "2xx" => 0, "3xx" => 0, "4xx" => 0, "5xx" => 0 }) do |result, h|
156
- result["2xx"] += h["statuses"]["2xx"]
157
- result["3xx"] += h["statuses"]["3xx"]
158
- result["4xx"] += h["statuses"]["4xx"]
159
- result["5xx"] += h["statuses"]["5xx"]
267
+ interval_metrics.inject({ "2xx" => 0, "3xx" => 0, "4xx" => 0, "5xx" => 0 }) do |result, array|
268
+ result["2xx"] += array[schema["2xx"]]
269
+ result["3xx"] += array[schema["3xx"]]
270
+ result["4xx"] += array[schema["4xx"]]
271
+ result["5xx"] += array[schema["5xx"]]
160
272
  result
161
273
  end
162
274
  end
@@ -2,12 +2,13 @@ require "benchmark"
2
2
 
3
3
  class EZmetrics::Benchmark
4
4
 
5
- def initialize
6
- @start = Time.now.to_i
7
- @redis = Redis.new
8
- @durations = []
9
- @iterations = 3
10
- @intervals = {
5
+ def initialize(store_each_value=false)
6
+ @store_each_value = store_each_value
7
+ @start = Time.now.to_i
8
+ @redis = Redis.new(driver: :hiredis)
9
+ @durations = []
10
+ @iterations = 1
11
+ @intervals = {
11
12
  "1.minute" => 60,
12
13
  "1.hour " => 3600,
13
14
  "12.hours" => 43200,
@@ -29,31 +30,38 @@ class EZmetrics::Benchmark
29
30
 
30
31
  private
31
32
 
32
- attr_reader :start, :redis, :durations, :intervals, :iterations
33
+ attr_reader :start, :redis, :durations, :intervals, :iterations, :store_each_value
33
34
 
34
35
  def write_metrics
35
36
  seconds = intervals.values.max
36
37
  seconds.times do |i|
37
38
  second = start - i
38
39
  payload = {
39
- "second" => second,
40
- "duration_sum" => rand(10000),
41
- "duration_max" => rand(10000),
42
- "views_sum" => rand(1000),
43
- "views_max" => rand(1000),
44
- "db_sum" => rand(8000),
45
- "db_max" => rand(8000),
46
- "queries_sum" => rand(100),
47
- "queries_max" => rand(100),
48
- "statuses" => {
49
- "2xx" => rand(1..10),
50
- "3xx" => rand(1..10),
51
- "4xx" => rand(1..10),
52
- "5xx" => rand(1..10),
53
- "all" => rand(1..40)
54
- }
40
+ "second" => second,
41
+ "duration_sum" => rand(10000),
42
+ "duration_max" => rand(10000),
43
+ "views_sum" => rand(1000),
44
+ "views_max" => rand(1000),
45
+ "db_sum" => rand(8000),
46
+ "db_max" => rand(8000),
47
+ "queries_sum" => rand(100),
48
+ "queries_max" => rand(100),
49
+ "2xx" => rand(1..10),
50
+ "3xx" => rand(1..10),
51
+ "4xx" => rand(1..10),
52
+ "5xx" => rand(1..10),
53
+ "all" => rand(1..40)
55
54
  }
56
- redis.setex(second, seconds, Oj.dump(payload))
55
+
56
+ if store_each_value
57
+ payload.merge!(
58
+ "duration_values" => Array.new(100) { rand(10..60000) },
59
+ "views_values" => Array.new(100) { rand(10..60000) },
60
+ "db_values" => Array.new(100) { rand(10..60000) },
61
+ "queries_values" => Array.new(10) { rand(1..60) }
62
+ )
63
+ end
64
+ redis.setex(second, seconds, Oj.dump(payload.values))
57
65
  end
58
66
  nil
59
67
  end
@@ -67,10 +75,11 @@ class EZmetrics::Benchmark
67
75
  def measure_aggregation_time(interval, seconds, partition_by)
68
76
  iterations.times do
69
77
  durations << ::Benchmark.measure do
70
- if partition_by
71
- EZmetrics.new(seconds).partition_by(partition_by).show
78
+ ezmetrics = EZmetrics.new(seconds)
79
+ if store_each_value
80
+ partition_by ? ezmetrics.partition_by(partition_by).show(db: :percentile_90) : ezmetrics.show(db: :percentile_90)
72
81
  else
73
- EZmetrics.new(seconds).show
82
+ partition_by ? ezmetrics.partition_by(partition_by).show : ezmetrics.show
74
83
  end
75
84
  end.real
76
85
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ezmetrics
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.2.1
4
+ version: 2.0.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Nicolae Rotaru
@@ -78,7 +78,7 @@ files:
78
78
  - lib/ezmetrics/benchmark.rb
79
79
  homepage: https://github.com/nyku/ezmetrics
80
80
  licenses:
81
- - GPL-3.0
81
+ - MIT
82
82
  metadata: {}
83
83
  post_install_message:
84
84
  rdoc_options: []