adding loki to the quickstart (#1152)

* adding loki to the quickstart

Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>

* pr fixes

Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>

* Update docs/private-networks/tutorials/quickstart.md

Co-authored-by: Nicolas MASSART <NicolasMassart@users.noreply.github.com>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>

* Update docs/private-networks/how-to/monitor/loki.md

Co-authored-by: Nicolas MASSART <NicolasMassart@users.noreply.github.com>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>

* Update docs/private-networks/tutorials/quickstart.md

Co-authored-by: Nicolas MASSART <NicolasMassart@users.noreply.github.com>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>

* Update docs/private-networks/how-to/monitor/loki.md

Co-authored-by: rolandtyler <88206508+rolandtyler@users.noreply.github.com>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>

* Update docs/private-networks/tutorials/quickstart.md

Co-authored-by: Nicolas MASSART <NicolasMassart@users.noreply.github.com>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>

* Update Merge testnet example to longterm networks (#1108)

* Update Merge testnet example to Sepolia

Signed-off-by: Roland Tyler <roland.tyler@consensys.net>

* Change from Sepolia to Goerli

Signed-off-by: Roland Tyler <roland.tyler@consensys.net>

* Markdown fix

Signed-off-by: Roland Tyler <roland.tyler@consensys.net>

* Include both testnets

Signed-off-by: Roland Tyler <roland.tyler@consensys.net>

* update launchpad

Signed-off-by: Roland Tyler <roland.tyler@consensys.net>

* Fix links

Signed-off-by: Roland Tyler <roland.tyler@consensys.net>

Signed-off-by: Roland Tyler <roland.tyler@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>

* Add a new page on understanding some Besu performance metrics. (#1151)

Signed-off-by: Ameziane H <ameziane.hamlat@consensys.net>
Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
Signed-off-by: Nicolas MASSART <NicolasMassart@users.noreply.github.com>
Co-authored-by: Nicolas MASSART <nicolas.massart@consensys.net>
Co-authored-by: Nicolas MASSART <NicolasMassart@users.noreply.github.com>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>

* Correct syntax in config file examples (#1156)

Signed-off-by: Roland Tyler <roland.tyler@consensys.net>

Signed-off-by: Roland Tyler <roland.tyler@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>

* Update architecture diagrams (#1158)

Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>

Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>

* Typo dash (#1159)

* removed extra dash

Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>
Co-authored-by: Alexandra Tran <12214231+alexandratran@users.noreply.github.com>
Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>

Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
Signed-off-by: Roland Tyler <roland.tyler@consensys.net>
Signed-off-by: Ameziane H <ameziane.hamlat@consensys.net>
Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
Signed-off-by: Nicolas MASSART <NicolasMassart@users.noreply.github.com>
Signed-off-by: Alexandra Tran <alexandra.tran@consensys.net>
Signed-off-by: Sally MacFarlane <macfarla.github@gmail.com>
Co-authored-by: Nicolas MASSART <NicolasMassart@users.noreply.github.com>
Co-authored-by: rolandtyler <88206508+rolandtyler@users.noreply.github.com>
Co-authored-by: ahamlat <ameziane.hamlat@consensys.net>
Co-authored-by: Nicolas MASSART <nicolas.massart@consensys.net>
Co-authored-by: Alexandra Tran <12214231+alexandratran@users.noreply.github.com>
Co-authored-by: Sally MacFarlane <macfarla.github@gmail.com>
pull/1164/head
Joshua Fernandes 2 years ago committed by GitHub
parent 3401687746
commit 606cdf3fef
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 1
      CI/vale/vale_styles/Vocab/Besu/accept.txt
  2. BIN
      docs/images/grafana_loki.png
  3. 1
      docs/private-networks/how-to/monitor/index.md
  4. 32
      docs/private-networks/how-to/monitor/loki.md
  5. 13
      docs/private-networks/tutorials/quickstart.md
  6. 1
      mkdocs.navigation.yml

@ -121,6 +121,7 @@ P[oO]W
[pP]recompile(d)?
[pP]reidentif(y|ied)
Prometheus
Promtail
Protobuf
Prysm
Prysmatic

Binary file not shown.

After

Width:  |  Height:  |  Size: 536 KiB

@ -10,6 +10,7 @@ networks.
You can also use the following monitoring tools in private networks:
- [Loki](loki.md)
- [Elastic Stack](elastic-stack.md)
- [Quorum Hibernate](quorum-hibernate.md)
- [Splunk](splunk.md)

@ -0,0 +1,32 @@
---
description: Using Grafana Loki log management platform with Hyperledger Besu
---
# Grafana Loki
[Grafana Loki] is an open-source log management platform that is available when using the
[Developer Quickstart](../../tutorials/quickstart.md).
The [Promtail configuration] ingests logs at regular defined intervals and outputs them to [Loki] for storage.
The `pipeline configuration` in Promtail defines pipeline stages that can collate logs natively or using the JSON format.
!!! note
If using the pipeline regex stage in `Promtail`, configuration must match your log format.
To view the GoQuorum Quickstart network logs in Loki:
1. [Start the Developer Quickstart with Besu](../../tutorials/quickstart.md), selecting Loki monitoring.
1. Open the [`Grafana Loki address`](http://localhost:3000/d/Ak6eXLsPxFemKYKEXfcH/quorum-logs-loki?orgId=1&var-app=besu&var-search=&from=now-15m&to=now) listed
by the sample networks `list.sh` script.
The logs display in Loki.
![Loki logs](../../../images/grafana_loki.png)
<!-- Links -->
[Promtail configuration]: https://github.com/ConsenSys/quorum-dev-quickstart/blob/master/files/common/promtail/promtail.yml
[pipeline configuration]: https://github.com/ConsenSys/quorum-dev-quickstart/blob/master/files/common/promtail/promtail.yml
[Loki]: https://github.com/ConsenSys/quorum-dev-quickstart/blob/master/files/common/loki/loki.yml
[Grafana Loki]: https://grafana.com/oss/loki/

@ -80,6 +80,7 @@ When execution is successfully finished, the process lists the available service
Prometheus address : http://localhost:9090/graph
Grafana address : http://localhost:3000/d/XE4V0WGZz/besu-overview?orgId=1&refresh=10s&from=now-30m&to=now&var-system=All
Kibana logs address : http://localhost:5601/app/kibana#/discover
Collated logs using Grafana Loki : http://localhost:3000/d/Ak6eXLsPxFemKYKEXfcH/quorum-logs-loki?orgId=1&var-app=besu&var-search=
For more information on the endpoints and services, refer to README.md in the installation directory.
****************************************************************
@ -99,6 +100,9 @@ When execution is successfully finished, the process lists the available service
- Use the **Kibana logs address** to access the
[logs in Kibana](http://localhost:5601/app/kibana#/discover).
[Read more about log management](../how-to/monitor/elastic-stack.md).
- Use the **Grafana Loki logs address** to access the
[logs in Grafana](http://localhost:3000/d/Ak6eXLsPxFemKYKEXfcH/quorum-logs-loki?orgId=1&var-app=besu&var-search=).
[Read more about log management](../how-to/monitor/loki.md).
To display the list of endpoints again, run:
@ -133,13 +137,18 @@ You can directly access these tools from your browser at the addresses displayed
- [Prometheus dashboard](http://localhost:9090/graph)
- [Grafana dashboard](http://localhost:3000/d/XE4V0WGZz/besu-overview?orgId=1&refresh=10s&from=now-30m&to=now&var-system=All)
- [Grafana Loki logs dashboard](http://localhost:3000/d/Ak6eXLsPxFemKYKEXfcH/quorum-logs-loki?orgId=1&var-app=quorum&var-search=)
For more details on how to configure and use these tools for your own nodes, see the
[performances monitoring documentation](../../public-networks/how-to/monitor/metrics.md),
[performance monitoring documentation](../../public-networks/how-to/monitor/metrics.md),
[Prometheus documentation](https://prometheus.io/docs/introduction/overview/)
and [Grafana documentation](https://grafana.com/docs/).
![Grafana](../../images/grafana.png)
![Grafana dashboard screenshot](../../images/grafana.png)
and collated logs via Grafana Loki
![Grafana Loki dashboard screenshot](../../images/grafana_loki.png)
## Run JSON-RPC requests

@ -120,6 +120,7 @@ nav:
- Include revert reason: private-networks/how-to/send-transactions/revert-reason.md
- Monitor nodes:
- private-networks/how-to/monitor/index.md
- Use Grafana Loki: private-networks/how-to/monitor/loki.md
- Use Elastic Stack: private-networks/how-to/monitor/elastic-stack.md
- Use Quorum Hibernate: private-networks/how-to/monitor/quorum-hibernate.md
- Use Splunk: private-networks/how-to/monitor/splunk.md

Loading…
Cancel
Save