screen-monitoring

README

#Screen Monitor project

Installation

1. Install Go 1.7.x or greater, git, setup $GOPATH, and PATH=$PATH:$GOPATH/bin
2. Install nodejs 5.8 or greater
3. Run npm install
4. Run npm run build

cd $GOPATH/src/github.com/maddevsio/screen-monitoring
go get -v && go build -v
./screen-monitoring

Docker

docker build -t screen-monitoring .
docker run -p 8888:8080 -it --rm --name my_screen_monitoring screen-monitoring

###Example Dashboard API

Step 1 (Create page for widgets)

Request:

curl -H "Content-Type: application/json" -X POST -d '{"title":"First page","visible":true}' http://localhost:8080/dashboard/v1/page/new

Response (success):

{"Id":1,"Success":true}

Response (fail):

{"error":"Do: UNIQUE constraint failed: pages.title"}

Step 2 (Register widget)

curl -H "Content-Type: application/json" -X POST -d '{"id": "github_http_agent2", "width": 200, "height": 122, "content": "", "url":"http://www.w3schools.com/html/default.asp"}' http://localhost:8080/dashboard/v1/register

Response (success):

{"Success":true}

Response (fail) (only for invalid data inside JSON):

{"error":"Decode: invalid character 's' looking for beginning of value"}

Step 3 (Register widget on page)

curl -X GET http://localhost:8080/dashboard/v1/register/github_http_agent2/page/1

Note:

http://localhost:8080/dashboard/v1/register/{widgetId}/page/{pageId}

Response (success): {"Success":true}

Response (fail):

{"error":"Do: UNIQUE constraint failed: page_widgets.id_widget, page_widgets.id_page"}

###React sources:

• Install node.js version >= 5.8
• Execute: npm install
• For Development:
  • Execute npm run build
  • Created files index.html, bundle-[hash].js, bundle-[hash].js.map inside public
• For Production:
  • Execute npm run build-production
  • Created files index.html, bundle-[hash].js inside public

###Running Go backend service:

• Execute: go build then ./screen-monitoring
• Open browser and use url http://localhost:8080/
• See dashboard page without widgets

###Agents:

• Every agent should register using dashboard api /dashboard/v1/register
• Make POST request to /dashboard/v1/register with data, for example

{
  "id": "github_http_agent",
  "width": 200,
  "height": 122,
  "content": "",
  "url": "http://IP_OF_AGENT/api/method/for/getting/html/page/with/js/and/css"
}

• Now new parameter url used for fetching agents html page and loading this page inside iframe

###Dashboard

• After agents registration need refresh browser page for displaying all registered agents (because now simple solution realized)

###Migrations

• Automatic
  • When application starts database created automatically and migrations apply to database.
  • If database exists, then only new migrations applied.
• Manual running migrations
  • Install go-migrate using command:

    go get -u github.com/mattes/migrate
    

  • Create db:

    touch screen_monitoring.db
    

  • For migrations run command:

    migrate -url sqlite3://screen_monitoring.db -path ./dashboard/migrations up
    

  • This command will create database file with name screen_monitoring inside root directory of project

URL of monitoring application

• #/unregistered - displays list with unregistered widgets.
• #/pages/list - displays list of pages with ability to add new page
• #/pages/new - displays form for adding new page.