https://github.com/fluent/fluent-plugin-prometheus_pushgateway
https://github.com/fluent/fluent-plugin-prometheus_pushgateway
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fluent/fluent-plugin-prometheus_pushgateway
- Owner: fluent
- License: apache-2.0
- Created: 2020-02-13T02:45:13.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-26T04:35:14.000Z (11 months ago)
- Last Synced: 2025-06-06T14:40:19.246Z (9 months ago)
- Language: Ruby
- Size: 39.1 KB
- Stars: 2
- Watchers: 16
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog
- License: LICENSE
Awesome Lists containing this project
README
# Fluent::Plugin::PrometheusPushgateway
Please read [fluent-plugin-prometheus](https://github.com/fluent/fluent-plugin-prometheus) first since fluent-plugin-prometheus_pushgateway gem depends on it.
This is Fluentd's plugin for sending data collected by fluent-plugin-prometheus plugin to [Pushgateway](https://github.com/prometheus/pushgateway).
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'fluent-plugin-prometheus_pushgateway'
```
And then execute:
```
$ bundle install
```
Or install it yourself as:
```
$ gem install fluent-plugin-prometheus_pushgateway
```
## Usage
**See also [fluent-plugin-prometheus](https://github.com/fluent/fluent-plugin-prometheus)**.
```
@type prometheus_pushgateway
job_name fluentd_prometheus_pushgateway
```
More configuration parameters:
- `gateway`: binding interface (default: 'http://localhost:9091')
- `job_name`: job name. this value must be a unique (required)
- `instance`: instance name (default: nil)
- `push_interval`: the interval of pushing data to pushgateway (default: 3)
these parameters are used when `gateway` starts with 'https'
- `tls_ca_cert_path`: The CA certificate path for TLS (default nil)
- `tls_client_cert_path`: The client certificate path for TLS (default nil)
- `tls_private_key_path`: The client private key path for TLS (default nil)
- `tls_private_key_passphrase`: The client private key passphrase for TLS (default nil)
- `tls_verify_mode`: The verify mode of TLS (default :peer)
- `tls_version`: The default version of TLS (default :TLSv1_2)
- `tls_ciphers`: The cipher configuration of TLS (default ALL:!aNULL:!eNULL:!SSLv2)
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `fluent-plugin-prometheus_pushgateway.gemspec`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/fluent/fluent-plugin-prometheus_pushgateway.