README.md in sidekiq_prometheus-1.8.0 vs README.md in sidekiq_prometheus-1.8.1
- old
+ new
@@ -73,12 +73,12 @@
end
```
#### Configuration options
-* `preset_labels`: Hash of labels that will be included with every metric when they are registered.
-* `custom_labels`: Array of names for each label that will be passed during the reporting.
+* `preset_labels`: Hash of labels that will be included with every metric when they are registered. `Hash{Symbol (label name) => String (label value)}`
+* `custom_labels`: Hash of metrics and labels that can be applied to specific metrics. The metric name must be a registered metric. `Hash{Symbol (metric name) => Array<Symbol> (label names)}`
* `gc_metrics_enabled`: Boolean that determines whether to record object allocation metrics per job. The default is `true`. Setting this to `false` if you don't need this metric.
* `global_metrics_enabled`: Boolean that determines whether to report global metrics from the PeriodicMetrics reporter. When `true` this will report on a number of stats from the Sidekiq API for the cluster. This requires Sidekiq::Enterprise as the reporter uses the leader election functionality to ensure that only one worker per cluster is reporting metrics.
* `periodic_metrics_enabled`: Boolean that determines whether to run the periodic metrics reporter. `PeriodicMetrics` runs a separate thread that reports on global metrics (if enabled) as well worker GC stats (if enabled). It reports metrics on the interval defined by `periodic_reporting_interval`. Defaults to `true`.
* `periodic_reporting_interval`: interval in seconds for reporting periodic metrics. Default: `30`
* `metrics_server_enabled`: Boolean that determines whether to run the rack server. Defaults to `true`
@@ -89,11 +89,11 @@
* `registry`: An instance of `Prometheus::Client::Registry`. If you have a registry with defined metrics you can use this option to pass in your registry.
```ruby
SidekiqPrometheus.configure do |config|
config.preset_labels = { service: 'myapp' }
- config.custom_labels = [:worker_class, :job_type, :any_other_label]
+ config.custom_labels = { sidekiq_job_count: [:worker_class, :job_type, :any_other_label] }
config.gc_metrics_enabled = false
config.global_metrics_enabled = true
config.periodic_metrics_enabled = true
config.periodic_reporting_interval = 20
config.metrics_server_enabled = true
@@ -252,14 +252,10 @@
To install this gem onto your local machine, run `bundle exec rake install`.
## Contributors
-* Lukas Eklund ([@leklund](https://github.com/leklund))
-* NHM Tanveer Hossain Khan ([@we4tech](https://github.com/we4tech))
-* [@Postmodern](https://github.com/postmodern)
-* Ross Jones ([@rossjones](https://github.com/rossjones))
-* Alejandro Arrufat ([@mirubiri](https://github.com/mirubiri))
+See: https://github.com/fastly/sidekiq-prometheus/graphs/contributors
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/fastly/sidekiq-prometheus. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.