bencheeorg/benchee

Add configuration options to override Benchee default values

Open

#45 opened on Oct 12, 2016

View on GitHub
 (8 comments) (0 reactions) (0 assignees)Elixir (1,509 stars) (69 forks)batch import
Hacktoberfestenhancementgood first issuehelp wanted

Description

Benchee is getting a lot of configuration options - which is great. But the more configurations options and formatters there are, the more people would probably prefer to configure some of them globally for their project.

Something like:

config :benchee, :options, %{} # fancy map or keyword list overriding default options

These options should then represent the new default options. So merge order would be something like: default_config <- app_config <- benchmark_config (<- meaning right overrides left)

Contributor guide

Tech stack
elixir
Domain
backendtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Elixir basicsUnderstanding of Benchee configuration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Examine Benchee's current default options defined in lib/benchee/configuration.ex and the existing merge logic in lib/benchee/config.ex. Explore how Elixir application config (config.exs) can be read at runtime using Application.get env/3. Consider implementing a merge function that applies defaults < app config < benchmark config, and add documentation for users.