Skip to content

Commit

Permalink
Document new parameters into example json file
Browse files Browse the repository at this point in the history
  • Loading branch information
9seconds committed Feb 25, 2021
1 parent 5de77be commit f3035e9
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions example.config.hjson
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@
// "directory": "${provider_name}",
// "rate_limit_interval": "100ms",
// "rate_limit_burst": 10,
// "circuit_breaker_open_threshold": 5,
// "circuit_breaker_half_open_timeout": "1m",
// "circuit_breaker_reset_failures_timeout": "20s",
// "update_every": "24h",
// "http_timeout": "10s",
// "specific_parameters": {}
Expand All @@ -67,6 +70,19 @@
// Please see rate_limit_interval and rate_limit_burst meanings
// here: https://pkg.go.dev/golang.org/x/time/rate
//
// circuit_breaker_open_threshold defines a number of errors
// required to transit into OPEN state. In open state circuit
// breaker does not allow real requests to the target netloc.
//
// circuit_breaker_half_open_timeout defines a time period when
// circuit breaker closes for a single request to check if we
// already can proceed with out requests or not. If request fails,
// it immediately goes into OPEN state. Succeeds - to CLOSED state.
//
// circuit_breaker_reset_failures_timeout defines a time interval
// when failure counter resets. It is applicable only for closed
// state.
//
// update_every is a periodicity that is used to update provider
// database if this is applicable.
//
Expand Down

0 comments on commit f3035e9

Please sign in to comment.