Name: logstash-mixin-http_client
Owner: Logstash Plugins
Description: Easily include an HTTP client into your plugin
Created: 2015-06-29 19:39:45.0
Updated: 2017-05-09 15:50:58.0
Pushed: 2018-01-08 21:37:31.0
Homepage: null
Size: 52
Language: Ruby
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
HTTP clients have a lot of configurable options (proxies, certificates, headers, etc.), and specifying all of these with proper validation for a logstash plugin can be irritating. We built this plugin while building our HTTP Poller Input. If you need to build a plugin that works primarily based around HTTP this mixin makes it easy and consistent! It is based on Manticore a lightning quick, fully featured JRuby HTTP client based on Apache Commons HTTP Client.`
This is a plugin for Logstash.
It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
This plugin exposes the following options:
meout (in seconds) for the entire request
ig :request_timeout, :validate => :number, :default => 60
meout (in seconds) to wait for data on the socket. Default is 10s
ig :socket_timeout, :validate => :number, :default => 10
meout (in seconds) to wait for a connection to be established. Default is 10s
ig :connect_timeout, :validate => :number, :default => 10
ould redirects be followed? Defaults to true
ig :follow_redirects, :validate => :boolean, :default => true
x number of concurrent connections. Defaults to 50
ig :pool_max, :validate => :number, :default => 50
x number of concurrent connections to a single host. Defaults to 25
ig :pool_max_per_route, :validate => :number, :default => 25
able HTTP keepalive support, enabled by default
ig :keepalive, :validate => :boolean, :default => true
w many times should the client retry a failing URL? Default is 3
ig :automatic_retries, :validate => :number, :default => 3
you need to use a custom X.509 CA (.pem certs) specify the path to that here
ig :ca_path, :validate => :path
you need to use a custom keystore (.jks) specify that here
ig :truststore_path, :validate => :path
ecify the keystore password here.
te, most .jks files created with keytool require a password!
ig :truststore_password, :validate => :password
ecify the keystore type here. One of "JKS" or "PKCS12". Default is "JKS"
ig :truststore_type, :validate => :string, :default => "JKS"
able cookie support. With this enabled the client will persist cookies
ross requests as a normal web browser would. Enabled by default
ig :cookies, :validate => :boolean, :default => true
you'd like to use an HTTP proxy . This supports multiple configuration syntaxes:
Proxy host in form: http://proxy.org:1234
Proxy host in form: {host => "proxy.org", port => 80, scheme => 'http', user => 'username@host', password => 'password'}
Proxy host in form: {url => 'http://proxy.org:1234', user => 'username@host', password => 'password'}
ig :proxy
you'd like to use a client certificate (note, most people don't want this) set the path to the x509 cert here
ig :client_cert, :validate => :path
you'd like to use a client certificate (note, most people don't want this) set the path to the x509 key here
ig :client_key, :validate => :path
you'd like to use authentication. Options available include:
er - username to be used
ssword - password to be used
ger - eagerly offer the Authorization header before the server challenges for it
ig :auth
Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one central location.
[source,ruby] directiveNeed help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
To get started, you'll need JRuby with the Bundler gem installed.
Create a new plugin or clone and existing from the GitHub logstash-plugins organization. We also provide example plugins.
Install dependencies
le install
le install
le exec rspec
Gemfile and add the local plugin path, for example:"logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
gstash 2.3 and higher
logstash-plugin install --no-verify
bin/plugin install –no-verify
n Logstash with your plugin
bin/logstash -e 'filter {awesome {}}'
his point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
2.2 Run in an installed Logstash
can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
ild your plugin gem
gem build logstash-filter-awesome.gemspec
stall the plugin from the Logstash home
bin/logstash-plugin install –no-verify
bin/plugin install –no-verify
art Logstash and proceed to test the plugin
ontributing
contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
ramming is not a required skill. Whatever you've seen about open source and maintainers or community members saying "send patches or die" - you will not see that here.
s more important to the community that you are able to contribute.
more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.