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.

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

Fleet: Add synthetics integration #636

Merged
merged 2 commits into from
May 12, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
103 changes: 92 additions & 11 deletions docs/en/ingest-management/getting-started.asciidoc
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
[[fleet-quick-start]]
[role="xpack"]
= Quick start: Get logs and metrics into the {stack}
= Quick start: Get logs, metrics, and uptime data into the {stack}

beta[]

This guide describes how to:

* Collect logs and metrics from systems and services across your organization
* Send the data to the {stack}
* Explore and visualize the data in real-time
* Set up {fleet}
* Send data to the {stack} using {agent}
* Monitor logs and metrics from systems and services across your organization
* Monitor the availability of your HTTP, TCP, and ICMP services using the Synthetics integration
* Monitor Nginx logs and metrics using the Nginx integration

For feedback and questions, please contact us in the {forum}[discuss forum].

Expand Down Expand Up @@ -119,16 +121,95 @@ Then navigate to the [Metrics System] Host overview dashboard:
[role="screenshot"]
image::images/host-metrics.png[Host overview dashboard in {kib}]

[discrete]
[[add-synthetics-integration]]
== Step 4: Monitor HTTP, TCP, and ICMP services
[discrete]

beta[] Next, you’ll add the Elastic Synthetics integration, enabling you to monitor the
status and response times of applications and services in real time. You can monitor
the availability of network endpoints via HTTP, TCP, or ICMP.

Add the Elastic Synthetics integration to the default policy used by your agent.
You use policies to manage settings across a group of agents. An agent policy may
contain any number of integrations for collecting observability data from the various
services running on your host.

. In {kib}, go back to **Management > {fleet}**, and click the **Integrations**
tab. Use the search bar to find the Elastic Synthetics integration.
+
[role="screenshot"]
image::images/kibana-fleet-integrations-synthetics.png[{fleet} showing Synthetics integration]
. Click the Elastic Synthetics integration to see more details about it, then click
**Add Elastic Synthetics**.
+
[role="screenshot"]
image::images/kibana-fleet-integrations-synthetics-overview.png[{fleet} showing Synthetics integration overview]

. On the **Add Elastic Synthetics integration** page, select the `default policy`.
+
****
In this guide, you add integrations to the default policy created by
{kib}. After you learn the basics, you can create your own policies and assign
them to agents.
****
+
[role="screenshot"]
image::images/add-synthetics-integration.png[{fleet} Add Synthetics integration page]

. Under **Configure integration**, enter the integration name and select *HTTP* from the following monitor types:
+
|===

| *HTTP* | Connects via HTTP and verifies that the host returns the expected response.

For detailed information
about HTTP options, see our {heartbeat-ref}/monitor-http-options.html[Heartbeat] documentation.

| *TCP* | Connects via TCP and verifies the endpoint by sending and receiving a custom payload.
By default, the hostname and port are required.

For detailed information about TCP options, see our
{heartbeat-ref}/monitor-tcp-options.html[Heartbeat] documentation.

| *ICMP* | Uses an ICMP `v4` and `v6` Echo Request to ping the configured hosts. By default,
the host name is required.

For detailed information about ICMP options, see our
{heartbeat-ref}/monitor-icmp-options.html[Heartbeat] documentation.

|===

. Enter the URL you want to monitor for availability and select a monitor interval in seconds or minutes. By default, a monitoring
schedule of every 3 minutes is selected.

. The *HTTP* and *TCP* monitor types both support TLS. Under *TLS settings*, select *Enable
TLS configuration*. Click the down arrow next to advanced HTTP or TCP options, and then
enter your required settings.

. When you're done, click *Save integration* to deploy the changes.

. To see the updated policy, click the *Policies* tab, then click the
*Default policy* link.
+
The newly added Elastic Synthetics integration should appear under **Integrations** in the
default policy, along with the `system-1` integration.
+
[role="screenshot"]
image::images/kibana-fleet-policies-default-with-synthetics.png[{fleet} showing default agent policy with synthetics-1 datasource]
+
All {agent}s that use this policy will collect logs, metrics, and uptime data from the host.

. To view the data in the {observability-guide}/view-monitor-status.html[Uptime app], go to
**Observability > Uptime**.

[discrete]
[[add-nginx-integration]]
== Step 4: Monitor Nginx logs and metrics
== Step 5: Monitor Nginx logs and metrics
[discrete]

Next, you'll browse a catalog of integrations, then add an Nginx integration to
the default policy used by your agent. You use policies to manage settings
across a group of agents. An agent policy may contain any number of integrations
for collecting observability data from the various services running on your
host.
the default policy used by your agent.

NOTE: For these steps, we assume that you have `nginx` running on some of your
infrastructure, and want to collect logs and metrics from it.
Expand Down Expand Up @@ -163,13 +244,13 @@ settings
*Default policy* link.
+
The newly added Nginx integration should appear under **Integrations** in the
default policy, along with the `system-1` integration.
default policy, along with the `system-1` and `synthetics-1` integrations.
+
[role="screenshot"]
image::images/kibana-fleet-policies-default-with-nginx.png[{fleet} showing default agent policy with nginx-1 datasource]
+
All {agent}s that use this policy will collect logs and metrics from the
Nginx server and the host.
Nginx server and the host, along with uptime data.

. To view the data, click the **Data streams** tab.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.