Skip to content

Latest commit

 

History

History
396 lines (306 loc) · 11.8 KB

README.md

File metadata and controls

396 lines (306 loc) · 11.8 KB
Raw

Scadashboard

Simple framework for building Business or Developer dashboard.

Widgets available

You can check the SampleTickActor if you want to know how to create your own widget. It's easy you will see !

Communication protocol

All commandes are send through a web-socket.

Start a new widget

{
  "action": "start",
  "data": {
    "widget": "Ping",
    "id": "1:ping",
    "config": {
      "url": "http://www.google.fr",
      "interval": 10
    }
  }
}

The id must be unique for all your widgets. You can use $index:$name for example.

Returns a started event to confirm the creation, or an error.

{ "event": "started", "data": { "id": "1:ping" } }

The widgets will regularly send their updates.

{ "event": "update", "data": { "<widget-id<": <widget-data> } }

Stop a widget

{ "action": "stop", "data": "1:ping" }
{ "event": "stopped", "data": { "id": "1:ping" } }

Stop all widgets

{ "action": "stop-all" }

List active widgets

{ "action":  "status" }
{ "event": "status", "data": ["1:ping", "2:weather"] }

Widgets

Ping

Ping an URL, return status and ping.

{"action": "start", "data": {"widget": "Ping", "id": "1:ping", "config": {"url": "http://www.google.fr", "fetchContent": true, "interval": 1}}}

Config :

  • url (required)
  • fetchContent (optional, default=true): Do a GET or just a HEAD?
  • interval (required): Duration in seconds between to refresh
{"event":"update","data":{"1:ping":{"url":"http://www.google.fr","success":true,"ping":98}}}

Weather

Return the weather for the specified city.

Documentation: OpenWeatherMap

{"action": "start", "data": {"widget": "Weather", "id": "1:weather", "config": {"interval": 60, "city": "Montpellier", "country": "fr", "unit": "metric", "language": "fr"}}}

Config:

  • city (required)
  • country (optional)
  • unit (optional): imperial, metrics
  • language (optional): fr, en...
  • interval (required): Duration in seconds between to refresh
{
  "event":"update",
  "data":{
    "1:weather":{
      "coord":{"lon":3.88,"lat":43.61},
      "weather":[{"id":802,"main":"Clouds","description":"partiellement ensoleillé","icon":"03d"}],
      "base":"cmc stations",
      "main":{
        "temp":20.929,
        "temp_min":20.929,
        "temp_max":20.929,
        "pressure":982.6,
        "humidity":69
      },
      "wind":{"speed":1.26,"deg":280.005},
      "clouds":{"all":36}
    }
  }
}

Amazon Cloudwatch metrics

Return the statistics of a cloudwatch metrics

{"action": "start", "data": {"widget": "CloudWatch", "id": "1:cloudwatch", "config": {"interval": 1, "namespace": "AWS/EC2", "metric": "NetworkIn", "instanceId": "i-7fc786d5", "period": 60, "since": 1 }}}

Config:

  • namespace (required): aws-namespace
  • metric (required): aws-metric
  • instanceId (required): Id of the instance to inspect metric
  • period (required): Granularity (in s) of datapoints. Min 60, multiple of 60.
  • since (required): Fetch the datapoints for the N last hours.
  • interval (required): Duration in seconds between to refresh
{"event":"update","data":{"2:cloudwatch":{"1434304320":288318461,"1434302040":288558051,"1434303360":288834271,"1434303540":290506134,"1434304020":287059788,"1434303960":285087595,"1434303900":288596710,"1434300900":288018407,"1434303480":293454792,"1434303420":288138737,"1434303240":289734447,"1434302460":289559817,"1434301680":293763600,"1434302640":289669546,"1434303120":289487857,"1434301440":290510582,"1434303060":292413611,"1434301860":293872165,"1434301020":288144432,"1434302940":290112439,"1434301380":293555723,"1434302580":294265180,"1434301620":287092116,"1434304140":288919045,"1434304200":293733757,"1434302340":290091144,"1434301500":288406488,"1434303840":283264921,"1434302160":288652301,"1434303300":294559430,"1434302220":289853774,"1434300780":288505197,"1434302400":295451706,"1434302700":293270383,"1434302280":295240917,"1434301140":288049709,"1434301200":288458455,"1434301740":291084616,"1434304080":290330646,"1434302100":292291300,"1434303780":299295933,"1434301320":288738105,"1434302760":288186256,"1434303720":291789206,"1434302880":294139651,"1434301080":292955182,"1434300960":292275011,"1434303000":291427933,"1434301800":287729249,"1434301920":287522892,"1434301560":295091110,"1434302820":290415301,"1434302520":288013478,"1434304260":288334542,"1434303600":295374975,"1434300840":292344576,"1434303180":294121771,"1434303660":290316364,"1434301260":293424137,"1434301980":293376282}}}

Amazon Cloudwatch alarms

Return the predefined alarms

{"action": "start", "data": {"widget": "CloudWatchAlarms", "id": "1:cwa", "config": {"all": false, "interval": 60 }}}

Config:

  • all (optional, default=false): If truee, return also OK alarms
  • alarmNames (optional): Filter alarms by ts name
  • interval (required): Duration in seconds between to refresh
{
  "event":"update",
  "data":{
    "1:cwa":[
      {
        "namespace":"AWS/EC2",
        "name":"EC2 All instances CPU",
        "description":null,
        "updatedAt":1434399796065,
        "state":"ALARM",
        "metricName":"CPUUtilization",
        "reason":"Threshold Crossed: 1 datapoint (110.78) was greater than or equal to the threshold (50.0)."
      }
    ]
  }
}

Amazon EC2 instances

Return the list of all running EC2 instances.

{"action": "start", "data": {"widget": "EC2", "id": "1:ec2", "config": {"interval": 60 }}}

Config:

  • interval (required): Duration in seconds between to refresh
{
  "event":"update",
  "data":{
    "1:ec2":[
      {
        "instanceId":"i-6c8e6XXX",
        "instanceType":"t2.micro",
        "tags":{"Name":"XXX"},
        "launchTime":1431419870000,
        "publicIpAddress":"52.17.XXX.XXX",
        "privateIpAddress":"172.31.XX.XXX"
      }
    ]
  }
}

Github pull-requests

Return the pull-requests in the organization, or only in one repository.

{"action": "start", "data": {"widget": "GitHubPullRequests", "id": "1:ghpr", "config": {"organization": "tabmo", "repository": "manager-front", "interval": 60}}}

Config:

  • organization (required)
  • repository (optional)
  • interval (required): Duration in seconds between to refresh
{
  "event":"update",
  "data":{
    "1:githubpullrequests":[
      {
        "repository":"manager-front",
        "title":"Removing the use of ui-grid in the orders and lines view because of t…",
        "createdAt":"2015-06-12T14:49:15Z",
        "creator":"audrey-novak",
        "avatar":"https://avatars.githubusercontent.com/u/12810711?v=3"
      }
    ]
  }
}

Github Issues

Return the issues in the organization, or only in one repository.

{"action": "start", "data": {"widget": "GitHubIssues", "id": "1:ghi", "config": {"organization": "tabmo", "repository": "manager-front", "interval": 60}}}

Config:

  • organization (required)
  • repository (optional)
  • interval (required): Duration in seconds between to refresh
TODO

Github repository

{"action": "start", "data": {"widget": "GitHubrepository", "id": "1:ghr", "config": {"owner": "studiodev", "repository": "scadashboard", "interval": 60}}}

Config:

  • owner (required)
  • repository (required)
  • interval (required): Duration in seconds between to refresh

Response: See organization object on Github API documentation.

Codeship build status

Return the build status of a project.

{"action": "start", "data": {"widget": "CodeShip", "id": "1:codeship", "config": {"projectId": "76XXX", "branch": "develop", "interval": 60}}}

Config:

  • projectId (required)
  • branch (optional)
  • interval (required): Duration in seconds between to refresh
{
  "event":"update",
  "data":{
    "1:codeship":{
      "id":00000,
      "uuid":"XXXXXXX-ccab-0132-3442-7299564565fe",
      "repository_name":"orga/name",
      "repository_provider":"github",
      "builds":[
        {
          "id":6248647,
          "uuid":"XXXXXX-f30a-0132-f31e-0283dcdf0169",
          "project_id":00000,
          "status":"success",
          "github_username":"julienlafont",
          "commit_id":"f8449a0fd68480708a4e043865e66e73f404ecde",
          "message":"XXXXXXXXXX",
          "branch":"develop",
          "started_at":"2015-06-12T08:24:34.332Z",
          "finished_at":"2015-06-12T08:27:35.449Z"
        }
      ]
    }
  }
}

Twitter Search tweets

Returns a collection of relevant Tweets matching a specified query.

{"action": "start", "data": {"widget": "TwitterSearch", "id": "1:twitter", "config": {"query": "#hashtag", "resultType": "recent", "count": 1, "interval": 5}}}

Config:

  • query (required): search query (ex: #hashtag, @account, keyword #hashtag lang:fr from:julien_lafont )
  • resultType (optional, default=recent): Specifies what type of search results you would prefer to receive: recent, popular, mixed.
  • count (optional, default=5): Number of tweets to return (max: 100)
  • interval (required): Duration in seconds between to refresh

Response: See the Tweet object on Twitter API documentation.

Twitter limitation: 180 call / 15mn.

Twitter User

Returns a variety of information about the user specified by the required username parameter.

The author’s most recent Tweet will be returned inline when possible.

{"action": "start", "data": {"widget": "TwitterUser", "id": "1:twitter", "config": {"interval": 60, "username": "julien_lafont"}}}

Config:

  • username (required): Twitter username
  • interval (required): Duration in seconds between to refresh

Response: See the User object on Twitter API documentation.

Twitter limitation: 180 call / 15mn.

Generic JSON

This widget is a little special... It's perfect if you already have public web-service which return the data your need in JSON. Just configure the url and the interval, and you will receive updates regulary.

{"action": "start", "data": {"widget": "FetchJson", "id": "1:json", "config": {"interval": 60, "url": "https://api.ipify.org?format=json"}}}

Config:

  • url (required): URL to call
  • method (optional, default=GET): Method used to call the url
  • interval (required): Duration in seconds between to refresh

You can use this widget to fetch data from public services like Stackoverflow :

  • User information: https://api.stackexchange.com/2.2/users/742932?site=stackoverflow
  • Badges: https://api.stackexchange.com/2.2/users/742932/badges?order=desc&sort=rank&site=stackoverflow

Amazon SES

Forward push-notifications send by Amazon SES though Amazon SNS.

{
  "event":"update",
  "data":{
    "ses":{
      "source":"XXXX <[email protected]>",
      "destination":"[email protected]",
      "timestamp":1434305346325,
      "notificationType":"Bounce",
      "delivered":false
    }
  }
}