Skip to content

Commit 63962dc

Browse files
committed
Add basic structure
1 parent f81c0c8 commit 63962dc

File tree

1 file changed

+21
-47
lines changed

1 file changed

+21
-47
lines changed

docs/static/ea-integration-tutorial.asciidoc

Lines changed: 21 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,19 @@
11
[[ea-integrations-tutorial]]
2-
== Tutorial: {ls} `elastic_integration filter` to extend Elastic {integrations} (Beta)
2+
=== Tutorial: {ls} `elastic_integration filter` to extend Elastic {integrations} (Beta)
33
++++
44
<titleabbrev>Tutorial: {ls} `elastic_integration filter`</titleabbrev>
55
++++
66

77

8-
Process overview
9-
10-
* Configure Fleet to send data from Elastic Agent to Logstash
11-
* Create an Elastic Agent policy with the necessary integrations
12-
* Configure Logstash to use the elastic_integration filter plugin
13-
14-
15-
Logstash elastic-integration Filter Plugin Guide
16-
17-
Overview
188
The purpose of this guide is to walk through the steps necessary to configure {ls} to transform events
199
collected by the Elastic Agent using our pre-built Elastic Integrations that normalize data to the Elastic Common Schema (ECS).
2010
This is possible with a new beta feature in Logstash known as the elastic-integration
2111
filter plugin.
2212
Using this new plugin, Logstash reads certain field values generated by the Elastic Agent, and uses them to apply the transformations from Elastic Integrations so that it can further process events before
2313
sending them to their configured destinations.
2414

25-
Prerequisites/Requirements
15+
[[ea-integrations-prereqs]]
16+
*Prerequisites/Requirements*
2617

2718
There are a few requirements needed to make this possible:
2819

@@ -35,54 +26,38 @@ There are a few requirements needed to make this possible:
3526
This feature can also be used with a self-managed agent, but the appropriate setup and configuration details
3627
of using a self-managed agent will not be provided in this guide.
3728

38-
Configure Fleet to send data from Elastic Agent to Logstash
29+
[[ea-integrations-process-overview]]
30+
*Process overview*
3931

40-
. For Fleet Managed Agent, go to Kibana and navigate to Fleet → Settings.
32+
* <<ea-integrations-fleet>>
33+
* <<ea-integrations-create-policy>>
34+
* <<ea-integrations-pipeline>>
4135

42-
Figure 1: fleet-output
36+
[discrete]
37+
[[ea-integrations-fleet]]
38+
=== Configure Fleet to send data from Elastic Agent to Logstash
4339

40+
. For Fleet Managed Agent, go to Kibana and navigate to Fleet → Settings.
4441
. Create a new output and specify Logstash as the output type.
45-
46-
Figure 2: logstash-output
47-
4842
. Add the Logstash hosts (domain or IP address/s) that the Elastic Agent will send data to.
4943
. Add the client SSL certificate and the Client SSL certificate key to the configuration.
50-
You can specify at the bottom of the settings if you would like to make this out the default for agent
51-
integrations. By selecting this option, all Elastic Agent policies will default to using this Logstash output
52-
configuration.
44+
You can specify at the bottom of the settings if you would like to make this out the default for agent integrations.
45+
By selecting this option, all Elastic Agent policies will default to using this Logstash output configuration.
5346
. Click “Save and apply settings” in the bottom right-hand corner of the page.
5447

55-
Create an Elastic Agent policy with the necessary integrations
48+
[discrete]
49+
[[ea-integrations-create-policy]]
50+
=== Create an Elastic Agent policy with the necessary integrations
5651

5752
. In Kibana navigate to Fleet → Agent policies and click on “Create agent policy”.
58-
59-
60-
61-
Figure 3: create-agent-policy
6253
. Give this policy a name, and then click on “Advanced options”.
6354
. Change the “Output for integrations” setting to the Logstash output you created in the last step.
64-
65-
66-
67-
Figure 4: policy-output
68-
69-
7055
. Click “Create agent policy” at the bottom of the flyout.
7156
. The new policy should be listed on the Agent policies page now.
7257
. Click on the policy name so that we can start configuring an integration.
7358
. On the policy page, click “Add integration”.
7459
This will take you to the integrations browser, where you can select an integration that will have everything necessary to _integrate_ that data source with your other data in the Elastic stack.
75-
76-
Figure 5: add-integration-to-policy
77-
In this example we will search for and select the Crowdstrike integration.
78-
79-
Figure 6: crowdstrike-integration
80-
8160
. On the Crowdstrike integration overview page, click “Add Crowdstrike” to configure the integration.
82-
83-
84-
85-
Figure 7: add-crowdstrike
8661
. Configure the integration to collect the needed data.
8762
On step 2 at the bottom of the page (Where to add this integration?), make sure the “Existing hosts” option
8863
is selected and the Agent policy selected is our Logstash policy we created for our Logstash output. This
@@ -92,18 +67,17 @@ A modal will appear on the screen asking if you want to add the Elastic Agent to
9267
already done so, please install the Elastic Agent on a host somewhere. Documentation for this process can be
9368
found here: https://www.elastic.co/guide/en/fleet/current/elastic-agent-installation.html
9469

95-
Figure 8: add-elastic-agent-to-host
96-
97-
Configure Logstash to use the elastic_integration filter plugin
9870

71+
[discrete]
72+
[[ea-integrations-pipeline]]
73+
=== Configure Logstash to use the elastic_integration filter plugin
9974

10075
Create a new pipeline configuration in Logstash.
10176

10277
Make sure elastic_integration plugin is installed or install with /bin/logstash-plugin install logstash-filter-
10378
elastic_integration before running the pipeline.
10479

105-
A full list of configuration options can be found here: https://www.elastic.co/guide/en/logstash/current/plugins-
106-
filters-elastic_integration.html
80+
A full list of configuration options can be found here: https://www.elastic.co/guide/en/logstash/current/plugins-filters-elastic_integration.html
10781

10882
[source,txt]
10983
-----

0 commit comments

Comments
 (0)