mcollina/autocannon

Inform about the number of observations

Open

#143 opened on Jun 26, 2018

View on GitHub
 (14 comments) (0 reactions) (0 assignees)JavaScript (332 forks)batch import
enhancementgood first issue

Repository metrics

Stars
 (7,425 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

To compute a confidence interval or determine if there is a statistical difference between two versions, at least three pieces of information is required:

  • the mean
  • the standard deviation (or variance)
  • the number of observations, that the mean and standard deviation were sampled from.

The number of observations is not really clear from the output.

In a previous conversation @mcollina wrote:

The approach that autocannon takes is that it samples once per second the number of requests that happened within that second (https://github.com/mcollina/autocannon/blob/master/lib/run.js#L119-L122). So, it's 30 samples.

It is not really clear to me how that data is aggregated. Or how it relates to 30 samples.

Contributor guide

Research direction
Investigate the autocannon source code to understand how samples are collected and aggregated. Specifically, look at lib/run.js around lines 119-122 to understand the sampling mechanism. Then, document the number of observations (samples) and how it relates to the output statistics. Suggest adding a column or note in the output to display the number of samples.
Tech stack
javascriptnodejs
Domain
backendtooling
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.jsBasic understanding of benchmarking
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70