Skip to content
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

Clarify support for ssl options for modules #7967

Merged
merged 2 commits into from
Sep 24, 2018
Merged

Clarify support for ssl options for modules #7967

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
afb6fe8
Clarify support for ssl options for modules
dedemorton Aug 14, 2018
ee8642a
Change example to show http module
dedemorton Sep 4, 2018
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
19 changes: 19 additions & 0 deletions libbeat/docs/shared-ssl-config.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ You can specify SSL options when you configure:
ifeval::["{beatname_lc}"=="heartbeat"]
* <<configuration-heartbeat-options,{beatname_uc} monitors>> that support SSL
endif::[]
ifeval::["{beatname_lc}"=="metricbeat"]
* <<metricbeat-modules,modules>> that define the host as an HTTP URL
endif::[]

Example output config with SSL enabled:

Expand Down Expand Up @@ -52,6 +55,22 @@ heartbeat.monitors:
-------------------------------------------------------------------------------
endif::[]

ifeval::["{beatname_lc}"=="metricbeat"]
Example module with SSL enabled:

[source,yaml]
----
- module: http
namespace: "myservice"
enabled: true
period: 10s
hosts: ["https://localhost"]
path: "/stats"
headers:
Authorization: "Bearer test123"
ssl.verification_mode: "none"
----
endif::[]

[float]
=== Configuration options
Expand Down
12 changes: 10 additions & 2 deletions metricbeat/docs/metricbeat-options.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,8 +204,8 @@ processors in your config.
[[module-http-config-options]]
=== Standard HTTP config options

The modules and metricsets for which the host is defined as a HTTP URL, also
support the following options:
The following options are available for modules and metricsets that define the
host as an HTTP URL:

[float]
==== `username`
Expand All @@ -217,6 +217,14 @@ The username to use for basic authentication.

The password to use for basic authentication.

[float]
==== `ssl`

Configuration options for SSL parameters like the certificate authority to use
for HTTPS-based connections.

See <<configuration-ssl>> for more information.

[float]
==== `headers`

Expand Down