Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docker compose demo for subql node dashboard #1637

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions packages/node/docker/monitoring/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@

# Monitoring

This directory is to use prometheus and grafana to build monitoring for subql node.

## Subql Node Dashboards

### Bootstrap

There is a docker compose file, start a subql node to index data to postgres, and use prometheus to collect indicators and grafana for visual display.

To get started, run this command to launch the containers:
`$ docker compose up`


Until each container is up and running, we can access the web interface of each service.

- `localhost:3000`: subql node(access the path `/metrics` to view current indicators)
- `localhost:5432`: is accessible for postgres connections
- `localhost:9090`: prometheus web ui
- `localhost:3001`: grafana dashboard

### View dashboard

Open a browser to access `ocalhost:3001/dashboards` and select `subql-node-dashboard` to browse the monitoring indicators of subql node
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Open a browser to access `ocalhost:3001/dashboards` and select `subql-node-dashboard` to browse the monitoring indicators of subql node
Open a browser to access `localhost:3001/dashboards` and select `subql-node-dashboard` to browse the monitoring indicators of subql node

![subql node dashbard](imgs/subql-node-dashboard.png?raw=true)

### License

Apache-2.0
1 change: 1 addition & 0 deletions packages/node/docker/monitoring/config/db/init.sql
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
CREATE EXTENSION IF NOT EXISTS btree_gist;
Loading