Skip to content

add body config and ES example #112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add body config and ES example #112

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion docs/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ output {
}
----------------------------------

Using the HTTP poller with custom a custom CA or self signed cert.
==== Using the HTTP poller with custom a custom CA or self signed cert.

If you have a self signed cert you will need to convert your server's certificate to a valid# `.jks` or `.p12` file. An easy way to do it is to run the following one-liner, substituting your server's URL for the placeholder `MYURL` and `MYPORT`.

Expand All @@ -86,6 +86,27 @@ The above snippet will create two files `downloaded_cert.pem` and `downloaded_tr
}
----------------------------------

==== Using Http_poller to query Elasticsearch

This plugin can be used to send a request body to Elasticsearch then process the response. This is especially useful for getting aggregation results.

[source,ruby]
----------------------------------
http_poller {
urls => {
myESurl => {
url => "http://localhost:9200/metricbeat-*/_search"
body => '{"aggs":{"1":{"avg":{"field":"system.cpu.total.pct"}}},"size":0,"query":{"bool":{"must":[{"range":{"@timestamp":{"gte":"now-10m/m","lte":"now/m"}}}]}}}'
method => post
headers => {
"Content-Type" => "application/json"
}
}
}
schedule => { every => "10m" }
}
----------------------------------


[id="plugins-{type}s-{plugin}-options"]
==== Http_poller Input Configuration Options
Expand All @@ -98,6 +119,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
| <<plugins-{type}s-{plugin}-user>> |<<string,string>>|no
| <<plugins-{type}s-{plugin}-password>> |<<password,password>>|No
| <<plugins-{type}s-{plugin}-automatic_retries>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-body>> |<<string,string>>|no
| <<plugins-{type}s-{plugin}-cacert>> |a valid filesystem path|No
| <<plugins-{type}s-{plugin}-client_cert>> |a valid filesystem path|No
| <<plugins-{type}s-{plugin}-client_key>> |a valid filesystem path|No
Expand Down Expand Up @@ -156,6 +178,14 @@ How many times should the client retry a failing URL. We highly recommend NOT se
to zero if keepalive is enabled. Some servers incorrectly end keepalives early requiring a retry!
Note: if `retry_non_idempotent` is set only GET, HEAD, PUT, DELETE, OPTIONS, and TRACE requests will be retried.

id="plugins-{type}s-{plugin}-body"]
===== `body`

* Value type is <<string,string>>
* There is no default value for this setting.

Request body to send with each request. Note that you must set this per-URL.

[id="plugins-{type}s-{plugin}-cacert"]
===== `cacert`

Expand Down