hydra-dashboard's Introduction

hydra-dashboard

Hydra cluster dashboard/router application.

Usage

npm start

HTTP endpoints:

  [GET]/srvs/:service/routes
  [GET]/srvs
  [GET]/srvs/:service/health
  [GET]/nodes
  [GET|DELETE|POST|HEAD|PUT|PATCH|OPTIONS]/*

List all services

[GET]/srvs

[
    {
        "serviceName": "hydra-dashboard",
        "type": "restana",
        "available": true
    }
]

List service routes

[GET]/srvs/:service/routes

[
  "[GET]/srvs/:service/routes",
  "[GET]/srvs",
  "[GET]/srvs/:service/health",
  "[GET]/nodes"
]

List service health entries

[GET]/srvs/:service/health

[
  {
    "updatedOn": "2017-05-21T08:21:33.456Z",
    "serviceName": "hydra-dashboard",
    "instanceID": "73909f8c96a9d08e876411c0a212a1f4",
    "sampledOn": "2017-05-21T08:21:33.456Z",
    "processID": 50441,
    "architecture": "x64",
    "platform": "darwin",
    "nodeVersion": "v7.10.0",
    "memory": {
      "rss": 43618304,
      "heapTotal": 19316736,
      "heapUsed": 16732064,
      "external": 59848
    },
    "uptimeSeconds": 320.534
  }
]

List cluster nodes

[GET]/nodes

[
  {
    "serviceName": "hydra-dashboard",
    "serviceDescription": "Hydra cluster dashboard application.",
    "version": "1.0.0",
    "instanceID": "73909f8c96a9d08e876411c0a212a1f4",
    "updatedOn": "2017-05-25T15:30:32.395Z",
    "processID": 2758,
    "ip": "127.0.0.1",
    "port": "5000",
    "elapsed": 0
  }
]

REST query any of your connected services

The hydra-dashboard application also acts as a proxy/router for all your connected services. This means that you can request through it any of your HTTP endpoints.

For example:

[GET|DELETE|POST|HEAD|PUT|PATCH|OPTIONS] http://api-dashboard.example.com/:endpoint
[GET|DELETE|POST|HEAD|PUT|PATCH|OPTIONS] http://api-dashboard.example.com/[:service-name]/:endpoint