Skip to content

Commit 43e814b

Browse files
authored
[DOCS] Add steps for homebrew (#384)
1 parent a88838f commit 43e814b

File tree

1 file changed

+111
-8
lines changed

1 file changed

+111
-8
lines changed

docs/en/getting-started/get-started-stack.asciidoc

Lines changed: 111 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
Looking for an {stack} ("ELK" tutorial) that shows how to set up the {stack}? In
55
this tutorial, you learn how to get up and running quickly. First you install
6-
the core open source products:
6+
the core products:
77

88
* <<install-elasticsearch,{es}>>
99
* <<install-kibana,{kib}>>
@@ -56,8 +56,8 @@ Elasticsearch Service for free].
5656

5757
To download and install {es}, open a terminal window and use the commands that
5858
work with your system (<<deb, deb>> for Debian/Ubuntu, <<rpm, rpm>> for
59-
Redhat/Centos/Fedora, <<mac, mac>> for OS X, <<linux, linux>> for Linux, and
60-
<<win, win>> for Windows):
59+
Redhat/Centos/Fedora, <<mac, mac>> or <<brew, brew>> for OS X, <<linux, linux>>
60+
for Linux, and <<win, win>> for Windows):
6161

6262

6363
[[deb]]*deb:*
@@ -118,6 +118,24 @@ cd elasticsearch-{elasticsearch_version}
118118

119119
endif::[]
120120

121+
[[brew]]*brew:*
122+
123+
ifeval::["{release-state}"=="unreleased"]
124+
125+
Version {version} of {es} has not yet been released.
126+
127+
endif::[]
128+
129+
ifeval::["{release-state}"!="unreleased"]
130+
131+
["source","sh",subs="attributes,callouts"]
132+
----------------------------------------------------------------------
133+
brew tap elastic/tap
134+
brew install elastic/tap/elasticsearch-full
135+
elasticsearch
136+
----------------------------------------------------------------------
137+
138+
endif::[]
121139

122140
[[linux]]*linux:*
123141

@@ -287,6 +305,25 @@ cd kibana-{kibana_version}-darwin-x86_64/
287305

288306
endif::[]
289307

308+
*brew:*
309+
310+
ifeval::["{release-state}"=="unreleased"]
311+
312+
Version {version} of {kib} has not yet been released.
313+
314+
endif::[]
315+
316+
ifeval::["{release-state}"!="unreleased"]
317+
318+
["source","sh",subs="attributes"]
319+
----------------------------------------------------------------------
320+
brew tap elastic/tap
321+
brew install elastic/tap/kibana-full
322+
kibana
323+
----------------------------------------------------------------------
324+
325+
endif::[]
326+
290327
*win:*
291328

292329
ifeval::["{release-state}"=="unreleased"]
@@ -422,6 +459,24 @@ tar xzvf metricbeat-{version}-darwin-x86_64.tar.gz
422459

423460
endif::[]
424461

462+
*brew:*
463+
464+
ifeval::["{release-state}"=="unreleased"]
465+
466+
Version {version} of {metricbeat} has not yet been released.
467+
468+
endif::[]
469+
470+
ifeval::["{release-state}"!="unreleased"]
471+
472+
["source","sh",subs="attributes"]
473+
----------------------------------------------------------------------
474+
brew tap elastic/tap
475+
brew install elastic/tap/metricbeat-full
476+
----------------------------------------------------------------------
477+
478+
endif::[]
479+
425480
*linux:*
426481

427482
ifeval::["{release-state}"=="unreleased"]
@@ -513,6 +568,13 @@ sudo metricbeat modules enable system
513568
./metricbeat modules enable system
514569
----
515570
+
571+
*brew:*
572+
+
573+
[source,yaml]
574+
----
575+
metricbeat modules enable system
576+
----
577+
+
516578
*win:*
517579
+
518580
[source,yaml]
@@ -536,6 +598,13 @@ sudo metricbeat setup -e
536598
./metricbeat setup -e
537599
----
538600
+
601+
*brew:*
602+
+
603+
[source,yaml]
604+
----
605+
metricbeat setup -e
606+
----
607+
+
539608
*win:*
540609
+
541610
[source,yaml]
@@ -563,6 +632,13 @@ sudo service metricbeat start
563632
./metricbeat -e
564633
----
565634
+
635+
*brew:*
636+
+
637+
[source,yaml]
638+
----
639+
metricbeat -e
640+
----
641+
+
566642
*win:*
567643
+
568644
[source,yaml]
@@ -578,7 +654,7 @@ PS C:\Program Files\Metricbeat> Start-Service metricbeat
578654
==== Visualize system metrics in {kib}
579655

580656
To visualize system metrics, open your browser and navigate to the {metricbeat}
581-
system overview dashboard: http://localhost:5601/app/kibana#/dashboard/Metricbeat-system-overview
657+
system overview dashboard: http://localhost:5601/app/kibana#/dashboard/Metricbeat-system-overview-ecs
582658

583659
TIP: If you don’t see data in {kib}, try changing the date range to a larger
584660
range. By default, {kib} shows the last 15 minutes. If you see errors, make
@@ -664,6 +740,24 @@ tar -xzvf logstash-{logstash_version}.tar.gz
664740

665741
endif::[]
666742

743+
*brew:*
744+
745+
ifeval::["{release-state}"=="unreleased"]
746+
747+
Version {version} of {ls} has not yet been released.
748+
749+
endif::[]
750+
751+
ifeval::["{release-state}"!="unreleased"]
752+
753+
["source","sh",subs="attributes"]
754+
----------------------------------------------------------------------
755+
brew tap elastic/tap
756+
brew install elastic/tap/logstash-full
757+
----------------------------------------------------------------------
758+
759+
endif::[]
760+
667761
*win:*
668762

669763
ifeval::["{release-state}"=="unreleased"]
@@ -745,7 +839,8 @@ enriching, and transforming data.
745839

746840
Use the command that works with your system. If you installed {ls} as a deb or
747841
rpm package, make sure the config file is in the `config` directory.
748-
On mac, that step isn't required but it is a best practice for reasons of consistency.
842+
For other platforms, a `config` directory isn't required, but it's a best
843+
practice to be consistent.
749844

750845
*deb:*
751846

@@ -766,14 +861,21 @@ sudo service logstash start
766861
["source","sh",subs="attributes,callouts"]
767862
----------------------------------------------------------------------
768863
cd logstash-{logstash_version}
769-
./bin/logstash -f config/demo-metrics-pipeline.conf
864+
./bin/logstash -f path/to/config/demo-metrics-pipeline.conf
865+
----------------------------------------------------------------------
866+
867+
*brew:*
868+
869+
["source","sh",subs="attributes,callouts"]
870+
----------------------------------------------------------------------
871+
logstash -f path/to/config/demo-metrics-pipeline.conf
770872
----------------------------------------------------------------------
771873

772874
*win:*
773875

774876
["source","sh",subs="attributes,callouts"]
775877
----------------------------------------------------------------------
776-
bin\logstash.bat -f demo-metrics-pipeline.conf
878+
bin\logstash.bat -f path\to\config\demo-metrics-pipeline.conf
777879
----------------------------------------------------------------------
778880

779881
TIP: If you receive JVM error messages, check your Java version as shown in
@@ -787,7 +889,8 @@ configure {metricbeat} to send events to {ls}.
787889

788890
{metricbeat} sends events to {es} by default. To send events to {ls}, modify the
789891
{metricbeat} configuration file, `metricbeat.yml`. You'll find this file under
790-
the {metricbeat} install directory, or `/etc/metricbeat` for rpm and deb.
892+
the {metricbeat} install directory, `/etc/metricbeat` for rpm and deb, or
893+
`/usr/local/etc/metricbeat` for brew.
791894

792895
Disable the `output.elasticsearch` section by commenting it out, then enable
793896
the `output.logstash` section by uncommenting it:

0 commit comments

Comments
 (0)