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

[docs] Streamline beats getting started guides #17007

Merged
merged 42 commits into from
Jun 18, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
9fca58e
Move detail out of getting started guides
dedemorton Mar 14, 2020
78d1868
Changes in progress
dedemorton May 7, 2020
d5edbef
Add widgets
dedemorton May 8, 2020
98871be
Change tag width to 100%
dedemorton May 9, 2020
5c8b18f
remove unused css and red border
bmorelli25 May 11, 2020
aa992f2
breathing room below tab content
bmorelli25 May 11, 2020
ec5ae26
Remove inexplicable tab
dedemorton May 11, 2020
f13e935
Clean up wording
dedemorton May 12, 2020
46bf73c
Cleanup the getting started and move some stuff
dedemorton May 13, 2020
70023ad
Git auditbeat building
dedemorton May 14, 2020
352f9aa
Get all books building
dedemorton May 14, 2020
40c97db
More small changes
dedemorton May 14, 2020
5eac1e8
Fix build errors
dedemorton May 15, 2020
e48e739
Finish adding widgets and cleaning up gs guides
dedemorton May 16, 2020
7773f42
Fix widget filenames
dedemorton May 18, 2020
cde03dd
More cleanup work
dedemorton May 22, 2020
08c7af0
Add keystore tip to cloud example
dedemorton May 27, 2020
7cf5981
Another round of improvements
dedemorton May 28, 2020
58ada33
Delete redundant files
dedemorton May 28, 2020
09a5230
Replace dashboards in quick start topics
dedemorton May 29, 2020
16801a9
Change short titles for quick start guides
dedemorton May 29, 2020
59e2031
Make shared what's next list easier to include
dedemorton May 29, 2020
75b1f34
Remove modules quick start
dedemorton May 29, 2020
c8821a8
More cleanup
dedemorton May 30, 2020
56e06a9
Remove redundant files
dedemorton May 30, 2020
42e3281
Remove Logstash from the Winlogbeat quick start
dedemorton May 30, 2020
b7dcbbc
Remove old comments
dedemorton May 30, 2020
7e7f1d8
More cleanup work
dedemorton May 31, 2020
aee466d
Delete unused graphics
dedemorton May 31, 2020
4a8a003
Use correct spelling for GitHub
dedemorton Jun 4, 2020
6c7ffb6
Add formatting
dedemorton Jun 4, 2020
6514c40
Use correct capitalization for GitHub
dedemorton Jun 4, 2020
f003270
Use time filter instead of date range
dedemorton Jun 4, 2020
2e9f4ba
Change wording of headings as suggested during review
dedemorton Jun 6, 2020
be2a844
Add more fixes from the review
dedemorton Jun 16, 2020
e420b1d
Synchronize widget tab selection and fix bugs
dedemorton Jun 17, 2020
2227dcd
Include javascript only once in a file
dedemorton Jun 17, 2020
a7a2238
Add script and stylesheet to support tabbed panel
dedemorton Jun 18, 2020
cb7a36d
Fix step numbering
dedemorton Jun 18, 2020
be0b7e1
Include code for displaying tabbed panel
dedemorton Jun 18, 2020
0827608
Add javascript and css for tabbed panel
dedemorton Jun 18, 2020
c8d9c7d
Fix code include
dedemorton Jun 18, 2020
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
Prev Previous commit
Next Next commit
Add more fixes from the review
  • Loading branch information
dedemorton committed Jun 16, 2020
commit be2a844dec7b900015ee20cec2999a8d95528c0b
8 changes: 2 additions & 6 deletions auditbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -97,9 +97,9 @@ visualizing your data. To load these assets:
include::{libbeat-dir}/tab-widgets/setup-widget.asciidoc[]
--
+
`-e` is optional and sends output to standard error instead of syslog.
`-e` is optional and sends output to standard error instead of the configured log output.

This step loads the recommended index template for writing to {es}
This step loads the recommended {ref}/indices-templates.html[index template] for writing to {es}
and deploys the sample dashboards for visualizing the data in {kib}.

[TIP]
Expand Down Expand Up @@ -128,10 +128,6 @@ include::{libbeat-dir}/tab-widgets/start-widget.asciidoc[]
If you see a warning about too many open files, you need to increase the
`ulimit`. See the <<ulimit,FAQ>> for more details.

//REVIEWERS: Removing cURL test because I think users will see a better view of
//the data simply by going to the Discover app in Kibana. Showing the cURL
//command is not ideal for cloud users.

[float]
[[view-data]]
=== Step 6: View your data in {kib}
Expand Down
9 changes: 0 additions & 9 deletions filebeat/docs/filebeat-modules-options.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@
<titleabbrev>Modules</titleabbrev>
++++

// REVIEWERS: I've changed the focus of this topic to back to configuration.

NOTE: Using {beatname_uc} modules is optional. You may decide to
<<configuration-{beatname_lc}-options,configure inputs manually>> if you're using
a log type that isn't supported, or you want to use a different setup.
Expand Down Expand Up @@ -53,10 +51,6 @@ along with any modules that are enabled in the configuration file or `modules.d`
directory. If there's a conflict, the configuration specified at the command
line is used.

// REVIEWERS: I've removed the detail about using the --modules flag because
// it seems like an extra detail. Users can look at the command reference to
// learn how to specify the flag.

[float]
[[configure-modules-config-file]]
=== Configure modules in the +{beatname_lc}.yml+ file
Expand Down Expand Up @@ -85,9 +79,6 @@ The following example shows a configuration that runs the `nginx`,`mysql`, and
- module: system
----

// REVIEWERS: Deleting the section about configuring variable settings because
// it doesn't really add much value to users who are looking at the module
// config docs. It's just an extra hop.

[[advanced-settings]]
=== Override input settings
Expand Down
9 changes: 2 additions & 7 deletions filebeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,6 @@ include::{libbeat-dir}/tab-widgets/spinup-stack-widget.asciidoc[]
[[installation]]
=== Step 1: Install {beatname_uc}

//REVIEWERS: We don't currently say anything about licensing here. Should we?

Install {beatname_uc} on all the servers you want to monitor.

To download and install {beatname_uc}, use the commands that work with your
Expand Down Expand Up @@ -61,9 +59,6 @@ include::{libbeat-dir}/shared/connecting-to-es.asciidoc[]
[[enable-modules]]
=== Step 3: Enable and configure data collection modules

// REVIEWERS: I'm intentionally focusing on the module config steps because I
// feel it represents the fastest getting started experience. Any objections?

{beatname_uc} uses modules to collect and parse log data.

. Identify the modules you need to enable. To see a list of available
Expand Down Expand Up @@ -120,9 +115,9 @@ visualizing your data. To load these assets:
include::{libbeat-dir}/tab-widgets/setup-widget.asciidoc[]
--
+
`-e` is optional and sends output to standard error instead of syslog.
`-e` is optional and sends output to standard error instead of the configured log output.

This step loads the recommended index template for writing to {es}
This step loads the recommended {ref}/indices-templates.html[index template] for writing to {es}
and deploys the sample dashboards for visualizing the data in {kib}.

This step does not load the ingest pipelines used to parse log lines. By
Expand Down
2 changes: 0 additions & 2 deletions filebeat/docs/howto/load-ingest-pipelines.asciidoc
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
[[load-ingest-pipelines]]
== Load ingest pipelines

// REVIEWERS: This content originally lived in modules-getting-started.asciidoc

The ingest pipelines used to parse log lines are set up automatically the first
time you run {beatname_uc}, assuming the {es} output is enabled. If you're sending
events to {ls}, or plan to use
Expand Down
9 changes: 3 additions & 6 deletions heartbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,6 @@ your hosts. You'll learn how to:
* send uptime data to {es}
* visualize the uptime data in {kib}

// REVIEWERS: This screenshot comes from demo.elastic.co. Let me know if you
// have a build or screenshot that you'd prefer to use here.

[role="screenshot"]
image::./images/heartbeat-statistics.png[{beatname_uc} HTTP monitoring dashboard]

Expand Down Expand Up @@ -56,7 +53,7 @@ include::{libbeat-dir}/tab-widgets/install-widget.asciidoc[]
include::{libbeat-dir}/shared/connecting-to-es.asciidoc[]

[float]
[[condiguration]]
[[configuration]]
=== Step 3: Configure Heartbeat monitors

Heartbeat provides monitors to check the status of hosts at set intervals.
Expand Down Expand Up @@ -106,9 +103,9 @@ visualizing your data. To load these assets:
include::{libbeat-dir}/tab-widgets/setup-widget.asciidoc[]
--
+
`-e` is optional and sends output to standard error instead of syslog.
`-e` is optional and sends output to standard error instead of the configured log output.

The `setup` command loads the recommended index template for writing to {es}.
This step loads the recommended {ref}/indices-templates.html[index template] for writing to {es}.
It does not install {beatname_uc} dashboards. Heartbeat dashboards and
installation steps are available in the
https://github.com/elastic/uptime-contrib[uptime-contrib] GitHub repository.
Expand Down
4 changes: 2 additions & 2 deletions journalbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,9 @@ visualizing your data. To load these assets:
include::{libbeat-dir}/tab-widgets/setup-linux-mac-win-widget.asciidoc[]
--
+
`-e` is optional and sends output to standard error instead of syslog.
`-e` is optional and sends output to standard error instead of the configured log output.

This step loads the recommended index template for writing to {es}.
This step loads the recommended {ref}/indices-templates.html[index template] for writing to {es}.

[TIP]
=====
Expand Down
3 changes: 0 additions & 3 deletions libbeat/docs/shared/obs-apps.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,3 @@ endif::[]
|Analyze security events
|===
--

//REVIEWERS: We should decide which of the Beats shippers to highlight in this topic.
//Right now, a few are missing from the list.
4 changes: 2 additions & 2 deletions metricbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -114,9 +114,9 @@ visualizing your data. To load these assets:
include::{libbeat-dir}/tab-widgets/setup-widget.asciidoc[]
--
+
`-e` is optional and sends output to standard error instead of syslog.
`-e` is optional and sends output to standard error instead of the configured log output.

This step loads the recommended index template for writing to {es}
This step loads the recommended {ref}/indices-templates.html[index template] for writing to {es}
and deploys the sample dashboards for visualizing the data in {kib}.

[TIP]
Expand Down
4 changes: 2 additions & 2 deletions packetbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -166,9 +166,9 @@ visualizing your data. To load these assets:
include::{libbeat-dir}/tab-widgets/setup-widget.asciidoc[]
--
+
`-e` is optional and sends output to standard error instead of syslog.
`-e` is optional and sends output to standard error instead of the configured log output.

This step loads the recommended index template for writing to {es}
This step loads the recommended {ref}/indices-templates.html[index template] for writing to {es}
and deploys the sample dashboards for visualizing the data in {kib}.

[TIP]
Expand Down
4 changes: 1 addition & 3 deletions winlogbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,6 @@ logging.level: info
PS C:\Program Files\Winlogbeat> .\winlogbeat.exe test config -c .\winlogbeat.yml -e
----

//REVIEWERS: I've removed the logging section from the example shown above
//because I don't think it's necessary and might confuse users. WDYT?

For more information about configuring {beatname_uc}, also see:

Expand All @@ -129,7 +127,7 @@ visualizing your data. To load these assets:
include::{libbeat-dir}/tab-widgets/setup.asciidoc[tag=win]
--

This step loads the recommended index template for writing to {es}
This step loads the recommended {ref}/indices-templates.html[index template] for writing to {es}
and deploys the sample dashboards for visualizing the data in {kib}.

[TIP]
Expand Down
4 changes: 2 additions & 2 deletions x-pack/functionbeat/docs/getting-started.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -122,9 +122,9 @@ visualizing your data. To load these assets:
include::{libbeat-dir}/tab-widgets/setup-linux-mac-win-widget.asciidoc[]
--
+
`-e` is optional and sends output to standard error instead of syslog.
`-e` is optional and sends output to standard error instead of the configured log output.

This step loads the recommended index template for writing to {es}.
This step loads the recommended {ref}/indices-templates.html[index template] for writing to {es}.

[TIP]
=====
Expand Down