Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
autobench
Advanced tools
Readme
Automated benchmark avoiding regression in HTTP Applications.
Wrap autocannon
and autocannon-compare
in a box to automatize and monitor HTTP routes.
This is a Node.js module available through the npm registry. It can be installed using the npm
or yarn
command line tools.
npm i autobench
or globally
npm i -g autobench
autobench
# or directly
npx autobench
Add environment DEBUG=autobench:*
to see the log applications. Example:
DEBUG=autobench:debug autobench compare
DEBUG=autobench:info autobench compare
DEBUG=autobench:* autobench compare
In order to use the autobench
, the project must have a autobench.yml
as config file.
The config file parameters are described bellow:
# Name of project [OPTIONAL]
name: 'Autobench Example'
# Benchmarking folder to store and retrieve benchmarks. [REQUIRED]
benchFolder: 'bench'
# Root URL to perform the benchmarking. [REQUIRED] It could be sent by `AUTOBENCH_URL` environment variable
url: 'http://localhost:3000'
# Number of connections. See https://github.com/mcollina/autocannon to further explanation. [OPTIONAL]
connections: 10
# Number of pipelining. See https://github.com/mcollina/autocannon to further explanation. [OPTIONAL]
pipelining: 1
# Duration of benchmark. See https://github.com/mcollina/autocannon to further explanation. [OPTIONAL]
duration: 30
# Group of routes to perform benchmarking. [REQUIRED]
benchmarks:
# Benchmark route name. [REQUIRED]
- name: 'request 1'
# Route path. [REQUIRED]
path: '/'
# Method [OPTIONAL] - Default `GET`
method: 'POST'
# Headers to request [OPTIONAL]
headers:
Content-type: 'application/json'
# Body to request [OPTIONAL] - It's automatically parsed to JSON object.
body:
example: 'true'
email: 'hey-[<id>]@example.com'
# [OPTIONAL] when this field is set as `true` the `[<id>]` is replaced with a generated HyperID at runtime
idReplacement: true
- name: 'request 2'
path: '/slow'
See autobench.yml
file to examples.
Command to perform benchmark and compare to the stored benchmark.
It's required to have a previous benchmark stored in the benchFolder
. See Autobench Create to realize it.
Options:
Option | Description | Full command |
---|---|---|
-s | When is identified a Performance Regression a autobench-review.md file is created with the summary | autobench compare -s |
autobench compare [-s]
The autobench-review.md
looks like:
## Performance Regression ⚠️
---
The previous benchmark for request-1 was significantly performatic than from this PR.
- **Router**: request-1
- **Requests Diff**: 10%
- **Throughput Diff**: 10%
- **Latency Diff**: 10%
---
The previous benchmark for request-2 was significantly performatic than from this PR.
- **Router**: request-2
- **Requests Diff**: 20%
- **Throughput Diff**: 20%
- **Latency Diff**: 20%
Command to store/override the results in the benchFolder
.
Usually, it should be used to update the to latest benchmarking result, for instance, after each PR merged.
autobench create
See autobench-example for further details.
FAQs
[![NPM version](https://img.shields.io/npm/v/autobench.svg?style=flat)](https://www.npmjs.com/package/autobench) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)
The npm package autobench receives a total of 8 weekly downloads. As such, autobench popularity was classified as not popular.
We found that autobench demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.