Skip to content

Commit c8d66ea

Browse files
authored
Merge pull request #150 from dedemorton/update_infra_docs
Add changes from review
2 parents 24273fa + 7c90799 commit c8d66ea

File tree

2 files changed

+19
-32
lines changed

2 files changed

+19
-32
lines changed

docs/en/infraops/installation.asciidoc

Lines changed: 17 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -56,45 +56,32 @@ for the logs you want to collect, see the
5656
learn how to configure inputs.
5757

5858
For either approach, you need to enable modules in {filebeat} and {metricbeat}
59-
to populate the {infra-ui} UI with data.
59+
to populate the {infra-ui} UI with data.
6060

61-
To collect metrics, enable:
62-
63-
* {metricbeat-ref}/metricbeat-module-system.html[{metricbeat} `system` module]
64-
* {metricbeat-ref}/metricbeat-module-docker.html[{metricbeat} `docker` module]
65-
* {metricbeat-ref}/metricbeat-module-kubernetes.html[{metricbeat} `kubernetes` module]
61+
[float]
62+
==== Which modules and configuration options do I enable?
6663

67-
To collect logs, enable:
64+
To populate the *Hosts* view and add logs, enable:
6865

66+
* {metricbeat-ref}/metricbeat-module-system.html[{metricbeat} `system` module]
6967
* {filebeat-ref}/filebeat-module-system.html[{filebeat} `system` module]
70-
* Any other {filebeat-ref}/filebeat-modules.html[{filebeat} modules] needed for
68+
* {filebeat-ref}/filebeat-modules.html[Other {filebeat} modules] needed for
7169
your environment, such as `apache2`, `redis`, and so on
72-
* The {filebeat-ref}/filebeat-input-docker.html[docker input in {filebeat}]
7370

71+
To populate the *Docker* view and add logs, enable:
7472

75-
// REVIEWERS: This language is too wishy washy. Can you help me come up with
76-
// better language to help users understand when this is required?
77-
78-
You may also need to add processors to your configuration to collect metadata
79-
about containers or hosts where your services are running:
80-
81-
[horizontal]
82-
*Processor*:: *Collects*
83-
`add_cloud_metadata`::
84-
Instance metadata about the machine’s hosting provider
85-
`add_kubernetes_metadata`::
86-
The pod name, namespace, and labels of the container
87-
`add_docker_metadata`::
88-
The container ID, name, image, and labels of the Docker container
89-
`add_host_metadata`::
90-
Details about the host architecture, name, id, OS, IP address, and mac
91-
address
92-
93-
To learn how to define processors, see:
73+
* {metricbeat-ref}/metricbeat-module-docker.html[{metricbeat} `docker` module]
74+
* {metricbeat-ref}/add-docker-metadata.html[{metricbeat} `add_docker_metadata` processor]
75+
* {filebeat-ref}/filebeat-input-docker.html[{filebeat} `docker` input]
76+
* {filebeat-ref}/add-docker-metadata.html[{filebeat} `add_docker_metadata` processor]
9477

95-
* {metricbeat-ref}/defining-processors.html[Define processors in {metricbeat}]
96-
* {metricbeat-ref}/defining-processors.html[Define processors in {filebeat}]
78+
To populate the *Kubernetes* view and add logs, enable:
9779

80+
* {metricbeat-ref}/metricbeat-module-kubernetes.html[{metricbeat} `kubernetes`
81+
module]
82+
* {metricbeat-ref}/add-kubernetes-metadata.html[{metricbeat} `add_kubernetes_metadata` processor]
83+
* {filebeat-ref}/filebeat-input-docker.html[{filebeat} `docker` input]
84+
* {filebeat-ref}/add-kubernetes-metadata.html[{filebeat} `add_kubernetes_metadata` processor]
9885

9986
[float]
10087
==== More about monitoring containers

docs/en/infraops/overview.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ view, and interact with data stored in {es} indices. You can easily perform
3333
advanced data analysis and visualize your data in a variety of charts, tables,
3434
and maps.
3535

36-
*https://www.elastic.co/products/kibana[{kib} {infra-ui} UI]* provides a
36+
<<infrastructure-ui-overview,{kib} {infra-ui} UI>> provides a
3737
dedicated user interface for visualizing the health of your servers,
3838
containers, and services.
3939

40-
*https://www.elastic.co/products/kibana[{kib} {logs-ui} UI]* provides a compact,
40+
<<logs-ui-overview,{kib} {logs-ui} UI>> provides a compact,
4141
customizable display for real-time log tailing.
4242

0 commit comments

Comments
 (0)