Go to file
Dave Hrycyszyn 160ff1aaf3
Merge pull request #36 from nymtech/fix/correct-banner
Corrected swag @title
2020-11-12 11:37:58 +00:00
constants Using remote ip as host information for presence data 2019-09-18 14:53:13 +01:00
docs Corrected swag @title 2020-11-12 11:32:01 +00:00
healthcheck Corrected swag @title 2020-11-12 11:32:01 +00:00
metrics Returning delay until next report 2020-10-29 16:31:12 +00:00
models Corrected swag @title 2020-11-12 11:32:01 +00:00
server unused import 2020-11-12 11:35:05 +00:00
.gitignore Ignoring generated sqlite files 2020-09-23 17:43:26 +01:00
.golangci.yml ci: adding config files 2019-09-25 12:24:34 +01:00
.travis.yml Turning off Travis notifications 2020-10-14 18:04:54 +01:00
LICENSE Initial commit 2019-09-09 15:02:49 +01:00
README.md Update README.md 2020-10-14 10:41:26 +01:00
go.mod Initial work on batch reporting 2020-10-07 12:32:16 +01:00
go.sum Initial work on batch reporting 2020-10-07 12:32:16 +01:00
main.go Corrected swag @title 2020-11-12 11:32:01 +00:00
nym_directory_suite_test.go server: set up empty test bootstrap as a sanity check 2019-09-30 13:02:30 +01:00

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.