|
1 | | -# @idrinth/api-bench |
2 | | - |
3 | | -[](https://coveralls.io/github/Idrinth/api-bench?branch=the-one) |
4 | | -[](https://app.codacy.com/gh/Idrinth/api-bench/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) |
5 | | -[](https://sonarcloud.io/summary/new_code?id=Idrinth_api-bench) |
6 | | -[](https://www.codefactor.io/repository/github/idrinth/api-bench/overview/the-one) |
7 | | - |
8 | | -## Contents |
9 | | - |
10 | | -- [@idrinth/api-bench](#idrinthapi-bench) |
11 | | - - [Contents](#contents) |
12 | | - - [What does this project do?](#what-does-this-project-do) |
13 | | - - [Code Generation](#code-generation) |
14 | | - - [Why use a Benchmark Runner](#why-use-a-benchmark-runner) |
15 | | - - [Regarding existing libraries](#regarding-existing-libraries) |
16 | | - - [Usage \& Examples](#usage--examples) |
17 | | - - [CI Images](#ci-images) |
18 | | - - [Monitoring](#monitoring) |
19 | | - - [License](#license) |
20 | | - - [Socials](#socials) |
21 | | - - [Support](#support) |
22 | | - - [Privacy and Compliance](#privacy-and-compliance) |
23 | | - |
24 | | -## What does this project do? |
25 | | - |
26 | | -This project provides a framework for testing restful APIs and websites for |
27 | | -changes in response times. This helps to detect performance changes in code |
28 | | -in a quick and simple manner. |
29 | | - |
30 | | -### Code Generation |
31 | | - |
32 | | -Code generation has been extracted into `@idrinth/api-bench-cli`, it provided |
33 | | -with the framework or can be run on its own. |
34 | | - |
35 | | -### Why use a Benchmark Runner |
36 | | - |
37 | | -Given, that the amount of APIs increase by moving to microservices, we need a |
38 | | -way to determine if changes to a service's response times are related to code |
39 | | -changes. For this purpose a defined load with repeatable request seems the |
40 | | -most useful. |
41 | | - |
42 | | -### Regarding existing libraries |
43 | | - |
44 | | -Other tools like |
45 | | -[matteofigus/api-benchmark](https://github.com/matteofigus/api-benchmark), |
46 | | -[bvanderlaan/api-bench-runner](https://github.com/bvanderlaan/api-bench-runner) |
47 | | -or [jeffbski/bench-rest](https://github.com/jeffbski/bench-rest) are all |
48 | | -untouched for quite a while and don't provide type definitions for typescript. |
49 | | -This makes them less desirable when working with bigger projects where the |
50 | | -better static codecheck is a huge boost in development speed. |
51 | | - |
52 | | -Additionally, this tool separates the validation thread from the thread |
53 | | -processing the actual requests to further minimise the effect of complicated |
54 | | -validations or huge response bodies on the data gathering. |
55 | | - |
56 | | -## Usage & Examples |
57 | | - |
58 | | -Please have a look at the [website](https://idrinth-api-ben.ch) for more |
59 | | -information. |
60 | | - |
61 | | -## CI Images |
62 | | - |
63 | | -We have ready to be used CI Images: |
64 | | - |
65 | | -- [Gitlab Runner](https://hub.docker.com/r/idrinth/api-bench-gitlab-runner) |
66 | | -- [Gitea Action](https://hub.docker.com/r/idrinth/api-bench-gitea-action) |
67 | | -- [Pure Alpine](https://hub.docker.com/r/idrinth/api-bench) |
68 | | - |
69 | | -## Monitoring |
70 | | - |
71 | | -We provide a monitoring solution out of the box. |
72 | | - |
73 | | -- [Microservice](https://hub.docker.com/r/idrinth/api-bench-history-microservice) |
74 | | -- [Website](https://hub.docker.com/r/idrinth/api-bench-history-website) |
75 | | - |
76 | | -## License |
77 | | - |
78 | | -As usual with my projects this is MIT-licensed. |
79 | | - |
80 | | -## Socials |
81 | | - |
82 | | -Additionally, to support requests via GitHub issue, you can reach us via |
83 | | - |
84 | | -[](https://github.com/Idrinth/api-bench) [](https://www.linkedin.com/groups/9588634/) [](https://idrinth-api-bench.slack.com/join/shared_invite/zt-2f4zmw2sz-c3etHzCFq3LtZpkR15xXMA#/shared-invite/email) |
85 | | - |
86 | | -## Support |
87 | | - |
88 | | -Commercial support and training is provided via |
89 | | -[Björn Büttner](https://bjoern-buettner.me). |
90 | | - |
91 | | -## Privacy and Compliance |
92 | | - |
93 | | -The `@idrinth/api-bench` framework does not collect any kind of information |
94 | | -about its users or the APIs being tested. All data is local to the device |
95 | | -you run it on or the database server you configure it to dump data in. |
| 1 | +# @idrinth-api-bench/chartjs-plugin-stdev-filler |
| 2 | + |
| 3 | +This tiny plugin adds a colored area around line charts if those provide a standard deviation value. |
| 4 | + |
| 5 | +## Config |
| 6 | + |
| 7 | +```js |
| 8 | +{ |
| 9 | + datasets: [ |
| 10 | + { |
| 11 | + label: 'example 1', |
| 12 | + data: [10, 9, 11, 13, 11], |
| 13 | + stdev: [1, 1.1, 3, 9, 0.2], |
| 14 | + } |
| 15 | + ] |
| 16 | +} |
| 17 | +``` |
0 commit comments