View Source Chaperon (chaperon v0.3.1)

Chaperon is a HTTP service load & performance testing tool.

Link to this section Summary

Functions

Connect the current node to a Chaperon cluster without taking on any work (not running any load test Session tasks).

Runs a given load_test module's scenarios concurrently, outputting metrics at the end.

Callback implementation for Application.start/2.

Link to this section Functions

Link to this function

connect_to_master(node_name)

View Source
@spec connect_to_master(atom()) :: :ok | {:error, any()}
Link to this function

connect_to_master_without_work(node_name)

View Source
@spec connect_to_master_without_work(atom()) :: :ok | {:error, any()}

Connect the current node to a Chaperon cluster without taking on any work (not running any load test Session tasks).

Useful if you want to connect to a running cluster for inspecting running load tests and kicking off new ones without performing any load testing work on the connecting node.

Link to this function

run_load_test(lt_mod, options \\ [])

View Source

Runs a given load_test module's scenarios concurrently, outputting metrics at the end.

  • lt_mod LoadTest module to be executed
  • options List of options to be used. Valid values are:
    • :print_results If set to true, will print all action results.
    • :export Can be set to any module implementing the Chaperon.Exporter behaviour. Defaults to Chaperon.Export.CSV. When using Chaperon.Export.S3 it defaults to the CSV export format. You can use another export format by wrapping it in a tuple, like so: {Chaperon.Export.S3, Chaperon.Export.JSON}
    • :output Can be set to a file path
    • :tag Can be set to be used when using the default export filename. Allows adding a custom 'tag' string as a prefix to the generated result output filename.
    • :metrics Filtering options for metrics Valid filters:
      - (metric) -> boolean
      - [metric_type]

example

Example

alias Chaperon.Export.JSON

# Prints results & outputs metrics in CSV (default) format at the end
Chaperon.run_load_test MyLoadTest, print_results: true

# Doesn't print results & outputs metrics in JSON format at the end
Chaperon.run_load_test MyLoadTest, export: JSON

# Outputs metrics in CSV format to metrics.csv file
Chaperon.run_load_test MyLoadTest, output: "metrics.csv"

# Outputs metrics in JSON format to metrics.json file
Chaperon.run_load_test MyLoadTest, export: JSON, output: "metrics.json"

# Outputs metrics in CCSV format to "results/<date>/MyLoadTest/master-<timestamp>.csv"
Chaperon.run_load_test MyLoadTest, tag: "master"

# Outputs metrics in JSON format to "results/<date>/MyLoadTest/master-<timestamp>.json"
Chaperon.run_load_test MyLoadTest, export: JSON, tag: "master"

# Tracks only calls in MyScenario (can take any function that returns `true` or `false`)
Chaperon.run_load_test MyLoadTest, tag: "master", metrics: fn
  {:call, {MyScenario, _}} ->
    true
  _ ->
    false
end

# You can also just pass a list of metric types/names:
Chaperon.run_load_test MyLoadTest metrics: [
  :run_scenario,
  :call,
  :post,
  :my_custom_metric
]

Callback implementation for Application.start/2.

Link to this function

write_output_to_file(lt_mod, runtime_config, output, path)

View Source
Link to this function

write_output_to_stdio(lt_mod, output)

View Source