Skip to content

Commit 941f5ab

Browse files
committed
update monitoring docs
1 parent d4055a7 commit 941f5ab

File tree

1 file changed

+16
-21
lines changed

1 file changed

+16
-21
lines changed

docs/monitoring-and-logging.README.md

Lines changed: 16 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,10 @@ Parses log files and ships them to elasticsearch. Note we use the version shippe
1111
Visualisation tool that supports multiple different datasources. In our stack,
1212
we use it to visualise prometheus and elasticsearch data.
1313

14-
### [opendistro](https://opendistro.github.io/)
14+
### [opensearch](https://opendistro.github.io/)
1515

16-
An open-source distribution of elasticsearch. Elasticsearch is a search engine that provides full
17-
text search over a collection of JSON documents. In this project, the main use is for the archiving
18-
and retrieval of log files.
16+
A search engine that provides full text search over a collection of JSON documents. In this project,
17+
the main use is for the archiving and retrieval of log files.
1918

2019
### [prometheus](https://prometheus.io/)
2120

@@ -97,11 +96,7 @@ The `grafana` group controls the placement of the grafana service. Load balancin
9796

9897
### Access
9998

100-
The default URL is:
101-
102-
> https://<ip_of_first_node_in_grafana_group>:3000
103-
104-
The port can be controlled with the `grafana_port` variable.
99+
If Open Ondemand is enabled then by default this is used to proxy Grafana, otherwise Grafana is accessed through the first . See `grafana_url` in [environments/common/inventory/group_vars/all/grafana.yml](../environments/common/inventory/group_vars/all/grafana.yml). The port used (variable `grafana_port`) defaults to `3000`.
105100

106101
The default credentials for the admin user are:
107102

@@ -112,7 +107,7 @@ Where `vault_grafana_admin_password` is a variable containing the actual passwor
112107

113108
### grafana dashboards
114109

115-
The appliance ships with a default set of dashboards. The set of dashboards can be configured via the `grafana_dashboards` variable. The dashboards are published to grafana.com and are referenced by URL.
110+
The appliance ships with a default set of dashboards. The set of dashboards can be configured via the `grafana_dashboards` variable. The dashboards are either internal to the [grafana-dashboards role](../ansible/roles/grafana-dashboards/files/) or downloaded from grafana.com.
116111

117112
#### node exporter
118113

@@ -160,33 +155,33 @@ The default configuration configures the following datasources:
160155

161156
This can be customised with the `grafana_datasources` variable.
162157

163-
## opendistro
158+
## opensearch
164159

165-
This section details the configuration of Open Distro.
160+
This section details the configuration of OpenSearch.
166161

167162
### Defaults
168163

169-
The internal `opendistro` role is ued to configure the service. The list of variables that can be customised can found in:
164+
The internal `opensearch` role is ued to configure the service. The list of variables that can be customised can found in:
170165

171-
> [ansible/roles/opendistro/defaults/main.yml](../ansible/roles/opendistro/defaults/main.yml)
166+
> [ansible/roles/opensearch/defaults/main.yml](../ansible/roles/opensearch/defaults/main.yml)
172167
173168
The appliance defaults are in the following file:
174169

175-
> [environments/common/inventory/group_vars/all/opendistro.yml](../environments/common/inventory/group_vars/all/opendistro.yml)
170+
> [environments/common/inventory/group_vars/all/opensearch.yml](../environments/common/inventory/group_vars/all/opensearch.yml)
176171
177172
### Placement
178173

179-
The `opendistro` group determines the placement of the opendistro service. Load balancing is currently unsupported so it is important that you only assign one host to this group.
174+
The `opensearch` group determines the placement of the OpenSearch service. Load balancing is currently unsupported so it is important that you only assign one host to this group.
180175

181176
### Access
182177

183-
By default opendistro only listens on the loopback interface. It should therefore be placed on the same node as `filebeat` which needs to access the opendistro API.
178+
By default, OpenSearch only listens on the loopback interface. It should therefore be placed on the same node as `filebeat` and `grafana` which need to access the OpenSearch API.
184179

185180
### Users
186181

187182
The default set of users is defined in:
188183

189-
> [environments/common/files/opendistro/internal_users.yml](../environments/common/files/opendistro/internal_users.yml)
184+
> [environments/common/files/opensearch/internal_users.yml](../environments/common/files/opensearch/internal_users.yml)
190185
191186
This defines an the following accounts:
192187

@@ -202,12 +197,12 @@ the credentials should be treated with extreme care.
202197

203198
To override the default set of users, you can customize the variable:
204199

205-
> [environments/common/files/opendistro/internal_users.yml](../environments/common/files/opendistro/internal_users.yml)
200+
> [environments/common/files/opensearch/internal_users.yml](../environments/common/files/opensearch/internal_users.yml)
206201
207-
You can change this file by modifying the variable, `opendistro_internal_users_path`, where the default can be
202+
You can change this file by modifying the variable, `opensearch_internal_users_path`, where the default can be
208203
found in:
209204

210-
> [environments/common/inventory/group_vars/all/opendistro.yml](../environments/common/inventory/group_vars/all/opendistro.yml)
205+
> [environments/common/inventory/group_vars/all/opensearch.yml](../environments/common/inventory/group_vars/all/opensearch.yml)
211206
212207
## Prometheus
213208

0 commit comments

Comments
 (0)