kevangel79 / argo-web-api

The ARGO Web API provides the Serving Layer of ARGO. It is comprised of a high performance and scalable datastore and a multi-tenant REST HTTP API, which is used for retrieving the Status, Availability and Reliability reports and the actual raw metric results.

Swagger UI

ARGO Web-API

ARGO is a flexible and scalable framework for monitoring status, availability and reliability of services provided by infrastructures with medium to high complexity. It can generate multiple reports using customer defined profiles (e.g. for SLA management, operations etc) and has built-in multi-tenant support in the core framework.

Description

The ARGO Web API provides the Serving Layer of ARGO. It is comprised of a high performance and scalable datastore and a multi-tenant REST HTTP API, which is used for retrieving the Status, Availability and Reliability reports and the actual raw metric results.

Installation

1. Install Golang and bzr library

2. Install godep tool

    go get github.com/tools/godep
   

3. Create a new work space and setup your environment:

    mkdir ~/go-workspace
    export GOPATH=~/go-workspace
    export PATH=$PATH:GOPATH
   

You may add the export lines into the ~/.bashrc or the ~/.bash_profile file to have the GOPATH and PATH environment variables properly setup upon every login.

4. Get the latest version and all dependencies (Using Godep):

    godep update ...
   

5. To build the service use the following command:

    go build
   

6. To run the service use the following command:

    ./argo-web-api
   

For a list of options use the following command:

    ./argo-web-api -h

7. To run the unit-tests with coverage results:

    gocov test ./... | gocov-xml > coverage.xml
   

8. To generate and serve godoc (@port 6060)

    godoc -http=:6060