https://github.com/dappnode/dappnodepackage-dms

This package privately and locally collects and displays metrics related to your dappnode and its packages. Based on Grafana and Prometheus
https://github.com/dappnode/dappnodepackage-dms

Last synced: 9 days ago
JSON representation

This package privately and locally collects and displays metrics related to your dappnode and its packages. Based on Grafana and Prometheus

• Host: GitHub
• URL: https://github.com/dappnode/dappnodepackage-dms
• Owner: dappnode
• Created: 2020-06-25T16:23:49.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-31T11:50:31.000Z (5 months ago)
• Last Synced: 2024-07-31T12:54:37.385Z (5 months ago)
• Language: TypeScript
• Homepage:
• Size: 276 KB
• Stars: 5
• Watchers: 4
• Forks: 2
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# DMS DAppNode Package

[![DAppNode Available](https://img.shields.io/badge/DAppNode-Available-brightgreen.svg)](http://my.dappnode/#/installer/dms.dnp.dappnode.eth)

**D**AppNode **M**onitoring **S**ervice

This package privately and locally collects and displays metrics related to your dappnode and its packages. Based on Grafana and Prometheus

---

![avatar](avatar.png)

---

## How does it work?

According to the following diagram, the DMS package provides a high level of abstraction, allowing any new DAppNode package developed to easily implement grafana and prometheus.

![diagram](grafana-prometheus.png)

### Instructions to implement Grafana and Prometheus in your DAppNode package:

- **prometheus-targets.json** file: specifying the domain and the port where the data will be published.

- **name-grafana-dashboard.json** file: specifying the grafana dashboard to be used.

If you want to learn more about how do Grafana and Prometheus work, visit this [link](https://prometheus.io/docs/visualization/grafana/)

## How to add a custom prometheus endpoint

In order to add a custom path to prometheus you need to overwrite the `__metrics_path__` label (by default `/metrics`), so that you can define diferent and specific metrics paths per target, like this:

```

[

    {

        "labels": {

            "package": "tg.turbo-geth.dnp.dappnode.eth",

            "service": "tg.turbo-geth.dappnode",

            "__metrics_path__": "/debug/metrics/prometheus"

        },

        "targets": [

            "tg.turbo-geth.dappnode:6060"

        ]

    }

]

```

## Note

This is early stage software and it's just a PoC

## License

This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details