README
¶
My Go Application mcms
Build a Simple Metrics Collection and Monitoring System
Overview
This application provides various functionalities including metrics handling, alerting, and visualization.
Download
./bin/mcms
Building locally.
Prerequisite: Define GOPATH & GOBIN
go build
Install locally
go install
Run
Prerequisite: CWD should allow creation of metrics.json file.
Help
mcms --help
mcms
Commands
mcms
The base command for the application.
mcms metrics
Displays metrics at specified interval. ( Units: seconds )
mcms metrics -i 20
mcms api
Runs API service on localhost:1983
Example to override.
mcms metrics -p 127.3.4.5:9999
Fetch data by hitting following endpoints. Default:
mcms alert
Enchancement Handles alerting based on metrics.
mcms visualize
Enhancement Visualizes metrics data.
Package Documentation
In Github, detailed documentation for each package can be found in the sidebar generated content for '.go' files Locally, one can run godoc to display the description of package &/ functions.
Documentation
¶
Overview ¶
Copyright © 2024 Ameya Sathe <ameya.sathe@hotmail.com>
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
Source Files
Directories