Skip to content

Commit e69f0de

Browse files
committed
Add known adapters and plugins to README [ci skip]
1 parent fc63d9a commit e69f0de

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

README.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Yabeda
22

3-
[![Gem Version](https://badge.fury.io/rb/yabeda.svg)](https://rubygems.org/gems/yabeda) [![Build Status](https://travis-ci.org/yabeda-rb/yabeda.svg?branch=master)](https://travis-ci.org/yabeda-rb/yabeda)
3+
[![Gem Version](https://badge.fury.io/rb/yabeda.svg)](https://rubygems.org/gems/yabeda)
44

55
**This software is Work in Progress: features will appear and disappear, API will be changed, your feedback is always welcome!**
66

@@ -96,12 +96,40 @@ And then execute:
9696
9797
## Available monitoring system adapters
9898
99-
- [Prometheus](https://github.com/yabeda-rb/yabeda-prometheus)
99+
### Maintained by Yabeda
100+
101+
- Prometheus:
102+
- [yabeda-prometheus](https://github.com/yabeda-rb/yabeda-prometheus) — wraps [official Ruby client for Prometheus](https://github.com/prometheus/client_ruby).
103+
- [yabeda-prometheus-mmap](https://github.com/yabeda-rb/yabeda-prometheus-mmap) — wraps [GitLab's fork of Prometheus Ruby client](https://gitlab.com/gitlab-org/prometheus-client-mmap) which may work better for multi-process application servers.
100104
- [Datadog](https://github.com/yabeda-rb/yabeda-datadog)
101105
- [NewRelic](https://github.com/yabeda-rb/yabeda-newrelic)
106+
107+
### Third-party adapters
108+
109+
These are developed and maintained by other awesome folks:
110+
102111
- [Statsd](https://github.com/asusikov/yabeda-statsd)
103112
- _and more! You can write your own adapter and open a pull request to add it into this list._
104113

114+
## Available plugins to collect metrics
115+
116+
### Maintained by Yabeda
117+
118+
- [yabeda-rails] — basic request metrics for [Ruby on Rails](https://rubyonrails.org/) applications.
119+
- [yabeda-sidekiq] — comprehensive set of metrics for monitoring [Sidekiq](https://sidekiq.org/) jobs execution and queues.
120+
- [yabeda-faktory] — metrics for monitoring jobs execution by Ruby workers of [Faktory](https://contribsys.com/faktory/).
121+
- [yabeda-graphql] — metrics to query and field-level monitoring for apps using [GraphQL-Ruby](https://graphql-ruby.org/).
122+
- [yabeda-puma-plugin] — metrics for internal state and performance of [Puma](https://puma.io/) application server.
123+
- [yabeda-http_requests] — monitor how many outgoing HTTP calls your application does (uses [Sniffer](https://github.com/aderyabin/sniffer)).
124+
125+
### Third-party plugins
126+
127+
These are developed and maintained by other awesome folks:
128+
129+
- [yabeda-grape](https://github.com/efigence/yabeda-grape) — metrics for [Grape](https://github.com/ruby-grape/grape) framework.
130+
- [yabeda-gruf](https://github.com/Placewise/yabeda-gruf) — metrics for [gRPC Ruby Framework](https://github.com/bigcommerce/gruf)
131+
- _and more! You can write your own adapter and open a pull request to add it into this list._
132+
105133
## Roadmap (aka TODO or Help wanted)
106134

107135
- Ability to change metric settings for individual adapters
@@ -169,3 +197,8 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/yabeda
169197
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
170198

171199
[yabeda-rails]: https://github.com/yabeda-rb/yabeda-rails/ "Yabeda plugin for collecting and exporting basic metrics for Rails applications"
200+
[yabeda-sidekiq]: https://github.com/yabeda-rb/yabeda-sidekiq/ "Yabeda plugin for complete monitoring of Sidekiq metrics"
201+
[yabeda-faktory]: https://github.com/yabeda-rb/yabeda-faktory/ "Yabeda plugin for complete monitoring of Faktory Ruby Workers"
202+
[yabeda-graphql]: https://github.com/yabeda-rb/yabeda-graphql/ "Measure and understand how good your GraphQL-Ruby application works"
203+
[yabeda-puma-plugin]: https://github.com/yabeda-rb/yabeda-puma-plugin/ "Collects Puma web-server metrics from puma control application"
204+
[yabeda-http_requests]: https://github.com/yabeda-rb/yabeda-http_requests/ "Builtin metrics to monitor external HTTP requests"

0 commit comments

Comments
 (0)