https://github.com/nymtech/nym-metrics-server

A metrics server showing mixnode mixing performance in near-realtime.
https://github.com/nymtech/nym-metrics-server

Last synced: about 2 months ago
JSON representation

A metrics server showing mixnode mixing performance in near-realtime.

• Host: GitHub
• URL: https://github.com/nymtech/nym-metrics-server
• Owner: nymtech
• License: apache-2.0
• Created: 2019-09-09T14:02:48.000Z (over 5 years ago)
• Default Branch: develop
• Last Pushed: 2020-11-12T11:38:00.000Z (about 4 years ago)
• Last Synced: 2024-06-20T13:32:54.228Z (6 months ago)
• Language: Go
• Homepage: https://nymtech.net
• Size: 425 KB
• Stars: 13
• Watchers: 7
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Nym Metrics Server

A central metrics server which keeps track of the current mixing state of the network. 

## Dependencies

* Go 1.12 or later

## Building and running

`go run main.go` builds and runs the metrics server

## Usage

Nym nodes periodically send metrics information (how many Sphinx packets they've sent and received in a given interval). These metrics allow us to easily build visualizations of the network for demonstration, education, and debugging purposes during development and testnet.

To see documentation of the server's capabilities, go to http://localhost:8080/swagger/index.html in your browser. All methods are runnable through the Swagger docs interface, so you can poke at the server to see what it does. 

## Developing

`go test ./...` will run the test suite.

`swag init` rebuilds the Swagger docs if you've changed anything there. Otherwise it should not be needed.

If you update any of the HTML assets, `go-assets-builder server/html/index.html -o server/html/index.go` will put it in the correct place to be built into the binary.