Repository files navigation

lndmon is a drop-in, dockerized monitoring/metric collection solution for yourindividual lnd nodes connected to bitcoin. With this system, you'll be able toclosely monitor the health and status of yourlnd node.

There are three primary components of thelndmon system:

1. lnd built with themonitoringtag, which enables lnd to export metrics about its gRPC performance andusage. These metrics provide insights such as how many bytes lnd istransmitting over gRPC, whether any calls are taking a long time to complete,and other related statistics.

2. lndmon: while lnd provides some information,lndmon by far does the heavylifting with regards to metrics. Withlndmon's data, you can track routingfees over time, track how the channel graph evolves, and have a highlyconfigurable "crystal ball" to forecast and de-escalate potential issues asthe network changes over time. There is also a strong set of metrics forusers who want to keep track of their own node and channels, or just exploreand create their own lightning data visualizations.

3. Last but not least,lndmon usesGrafana as itsprimary dashboard to display all its collected metrics. Grafana is highlyconfigurable and can create beautiful and detailed graphs organized bycategory (i.e., chain-related graphs, fee-related graphs, etc). Users havethe option of making their Grafana dashboards remotely accessible over TLSwith passwords to ensure their data is kept private.

Monitoring can provide crucial insights into the health of large-scaledistributed systems. Without monitoring systems likelndmon, the only viewinto the health of your lnd node and the overall network is (1) fragmented logs,and (2) individually-dispatchedgetinfo and similar commands. By exporting andgraphing interesting metrics, one can get a real-time transparent view of thebehavior of your lnd node and the network. It's also cool to see how this viewchanges over time and how it's affected by events in the larger bitcoinecosystem (i.e., "wow, the dayLightningApp was released coincides withthe addition of 3000 channels to the network!").

Head over toINSTALL.md. Italso includes instructions to set up, access, and password-protect the dashboardthat comes with Prometheus, called the Prometheus expression browser, for thoseinterested in using it.