Updates to status API, re-align status page #10180

jbudz · 2017-02-03T18:51:12Z

snake_case, Discuss casing in the API #5429
share latest metrics instead of samples over time
add concurrent connections, uptime, requests
added config to remove metrics from api response
modify several field names to match elasticsearch, eg buildSha -> version.build_hash
before:

{
  name: "esc1d1",
  version: "5.2.0",
  buildNum: 14695,
  buildSha: "9b0119b706e53fbd67b447381fe80f71b9996893",
  uuid: "a3ed392d-695c-4a3e-998c-bd7724b93124",
  status: {
    overall: {
      state: "green",
      title: "Green",
      nickname: "Looking good",
      icon: "success",
      since: "2017-02-01T03:14:42.000Z"
    },
    statuses: [
      {
        id: "ui settings",
        state: "green",
        icon: "success",
        message: "Ready",
        since: "2017-02-01T03:22:46.773Z"
      },
      {
        id: "plugin:kibana@5.2.0",
        state: "green",
        icon: "success",
        message: "Ready",
        since: "2017-02-01T03:14:42.000Z"
      },
      {
        id: "plugin:elasticsearch@5.2.0",
        state: "green",
        icon: "success",
        message: "Kibana index ready",
        since: "2017-02-01T03:22:46.772Z"
      },
      {
        id: "plugin:console@5.2.0",
        state: "green",
        icon: "success",
        message: "Ready",
        since: "2017-02-01T03:14:42.176Z"
      },
      {
        id: "plugin:timelion@5.2.0",
        state: "green",
        icon: "success",
        message: "Ready",
        since: "2017-02-01T03:14:42.528Z"
      }
    ]
  },
  metrics: {
    heapTotal: [
      [
        1486147535911,
        70504448
      ],
      [
        1486147530910,
        69455872
      ],
      [
        1486147525908,
        69455872
      ],
      [
        1486147520906,
        69455872
      ],
      [
        1486147515904,
        69455872
      ],
      [
        1486147510903,
        69455872
      ],
      [
        1486147505901,
        69455872
      ],
      [
        1486147500898,
        69455872
      ],
      [
        1486147495896,
        69455872
      ],
      [
        1486147490894,
        69455872
      ],
      [
        1486147485891,
        69455872
      ],
      [
        1486147480890,
        69455872
      ]
    ],
    heapUsed: [
      [
        1486147535911,
        61269984
      ],
      [
        1486147530910,
        61552528
      ],
      [
        1486147525908,
        61141568
      ],
      [
        1486147520906,
        61425648
      ],
      [
        1486147515904,
        61014688
      ],
      [
        1486147510903,
        61294040
      ],
      [
        1486147505901,
        60883080
      ],
      [
        1486147500898,
        61164496
      ],
      [
        1486147495896,
        60753536
      ],
      [
        1486147490894,
        61034624
      ],
      [
        1486147485891,
        60626848
      ],
      [
        1486147480890,
        60908728
      ]
    ],
    load: [
      [
        1486147535911,
        [
          0.1181640625,
          0.1103515625,
          0.0908203125
        ]
      ],
      [
        1486147530910,
        [
          0.12890625,
          0.1123046875,
          0.091796875
        ]
      ],
      [
        1486147525908,
        [
          0.140625,
          0.1142578125,
          0.0927734375
        ]
      ],
      [
        1486147520906,
        [
          0.1533203125,
          0.1162109375,
          0.09375
        ]
      ],
      [
        1486147515904,
        [
          0.07958984375,
          0.10107421875,
          0.08837890625
        ]
      ],
      [
        1486147510903,
        [
          0.0869140625,
          0.10302734375,
          0.0888671875
        ]
      ],
      [
        1486147505901,
        [
          0.0947265625,
          0.10498046875,
          0.08935546875
        ]
      ],
      [
        1486147500898,
        [
          0.10302734375,
          0.10693359375,
          0.08984375
        ]
      ],
      [
        1486147495896,
        [
          0.1123046875,
          0.10888671875,
          0.09033203125
        ]
      ],
      [
        1486147490894,
        [
          0.12255859375,
          0.11083984375,
          0.0908203125
        ]
      ],
      [
        1486147485891,
        [
          0.13330078125,
          0.11279296875,
          0.091796875
        ]
      ],
      [
        1486147480890,
        [
          0.14501953125,
          0.11474609375,
          0.0927734375
        ]
      ]
    ],
    responseTimeAvg: [
      [
        1486147535911,
        null
      ],
      [
        1486147530910,
        null
      ],
      [
        1486147525908,
        null
      ],
      [
        1486147520906,
        null
      ],
      [
        1486147515904,
        null
      ],
      [
        1486147510903,
        null
      ],
      [
        1486147505901,
        null
      ],
      [
        1486147500898,
        null
      ],
      [
        1486147495896,
        null
      ],
      [
        1486147490894,
        null
      ],
      [
        1486147485891,
        null
      ],
      [
        1486147480890,
        null
      ]
    ],
    responseTimeMax: [
      [
        1486147535911,
        0
      ],
      [
        1486147530910,
        0
      ],
      [
        1486147525908,
        0
      ],
      [
        1486147520906,
        0
      ],
      [
        1486147515904,
        0
      ],
      [
        1486147510903,
        0
      ],
      [
        1486147505901,
        0
      ],
      [
        1486147500898,
        0
      ],
      [
        1486147495896,
        0
      ],
      [
        1486147490894,
        0
      ],
      [
        1486147485891,
        0
      ],
      [
        1486147480890,
        0
      ]
    ],
    requestsPerSecond: [
      [
        1486147535911,
        0
      ],
      [
        1486147530910,
        0
      ],
      [
        1486147525908,
        0
      ],
      [
        1486147520906,
        0
      ],
      [
        1486147515904,
        0
      ],
      [
        1486147510903,
        0
      ],
      [
        1486147505901,
        0
      ],
      [
        1486147500898,
        0
      ],
      [
        1486147495896,
        0
      ],
      [
        1486147490894,
        0
      ],
      [
        1486147485891,
        0
      ],
      [
        1486147480890,
        0
      ]
    ]
  }
}

after:

{
  name: "Jons-MacBook-Pro-2.local",
  uuid: "5b2de169-2785-441b-ae8c-186a1936b17d",
  version: {
    number: "6.0.0-alpha1",
    build_hash: "6cb7fec4e154faa0a4a3fee4b33dfef91b9870d9",
    build_number: 8467,
    build_snapshot: false
  },
  status: {
    overall: {
      state: "green",
      title: "Green",
      nickname: "Looking good",
      icon: "success",
      since: "2017-02-15T17:11:45.042Z"
    },
    statuses: [
      {
        id: "ui settings",
        state: "green",
        icon: "success",
        message: "Ready",
        since: "2017-02-15T17:11:46.042Z"
      },
      {
        id: "plugin:kibana@6.0.0-alpha1",
        state: "green",
        icon: "success",
        message: "Ready",
        since: "2017-02-15T17:11:45.042Z"
      },
      {
        id: "plugin:elasticsearch@6.0.0-alpha1",
        state: "green",
        icon: "success",
        message: "Kibana index ready",
        since: "2017-02-15T17:11:46.033Z"
      },
      {
        id: "plugin:console@6.0.0-alpha1",
        state: "green",
        icon: "success",
        message: "Ready",
        since: "2017-02-15T17:11:45.125Z"
      },
      {
        id: "plugin:timelion@6.0.0-alpha1",
        state: "green",
        icon: "success",
        message: "Ready",
        since: "2017-02-15T17:11:46.034Z"
      }
    ]
  },
  metrics: {
    last_updated: "2017-02-15T17:21:14.314Z",
    collection_interval_in_millis: 5000,
    uptime_in_millis: 573027,
    process: {
      mem: {
        heap_max_in_bytes: 113516544,
        heap_used_in_bytes: 98240248
      }
    },
    os: {
      cpu: {
        load_average: {
          1m: 1.75634765625,
          5m: 1.755859375,
          15m: 1.755859375
        }
      }
    },
    response_times: {
      avg_in_millis: 74.58333333333333,
      max_in_millis: 802
    },
    requests: {
      total: 12,
      disconnects: 0,
      status_codes: {
        200: 12
      }
    },
    concurrent_connections: 0
  }
}

tylersmalley · 2017-02-06T05:26:59Z

src/server/status/metrics.js

+      collection_time_in_millis: config.get('ops.interval'),
+      uptime_in_millis: process.uptime() * 1000,
+      process: {
+        heap: {


Do we want to nest this under memory as monitoring has done?

tylersmalley · 2017-02-06T05:28:55Z

src/server/status/metrics.js

+    const timestamp = new Date().toISOString();
+    kbnServer.metrics = {
+      last_updated: timestamp,
+      collection_time_in_millis: config.get('ops.interval'),


I really dislike shorthand, but it appears this is the standard set in ES. Thoughts on collection_interval_in_millis? I feel like we can make it a bit more descriptive.

tylersmalley · 2017-02-06T05:39:12Z

src/server/status/index.js

+        status: kbnServer.status.toJSON()
+      };
+
+      if (config.get('status.metrics')) {


Is there a time which we would not want to return the metrics? This could cause problems with beats consuming it if they can't rely on it being returned.

In 5.x we will need to provide a config to toggle the format introduced in this PR.

tylersmalley

LGTM

epixa · 2017-02-10T16:39:13Z

Tests failed on this

epixa · 2017-02-13T22:02:06Z

I'm getting this error in browser console when I visit the status page:

TypeError: Cannot read property 'length' of undefined
    at formatNumber (http://zero:5601/bundles/status_page.bundle.js?v=8467:433:37)
    at formatNumeral (http://zero:5601/bundles/status_page.bundle.js?v=8467:127:23)
    at Numeral.format (http://zero:5601/bundles/status_page.bundle.js?v=8467:660:21)
    at formatNumber (http://zero:5601/bundles/status_page.bundle.js?v=8467:1139:39)
    at http://zero:5601/bundles/status_page.bundle.js?v=8467:1092:43
    at Array.map (native)
    at http://zero:5601/bundles/status_page.bundle.js?v=8467:1091:21
    at fn (eval at compile (http://zero:5601/bundles/commons.bundle.js?v=8467:35087:16), <anonymous>:4:333)
    at regularInterceptedExpression (http://zero:5601/bundles/commons.bundle.js?v=8467:36167:22)
    at Object.expressionInputsWatch [as get] (http://zero:5601/bundles/commons.bundle.js?v=8467:36095:25)

epixa

This is looking good other than the bug in the console log.

tylersmalley · 2017-02-15T17:04:50Z

src/server/status/metrics.js

+    },
+    os: {
+      cpu: {
+        load: {


Can we change this to load_average to align with ES?

tylersmalley · 2017-02-15T17:05:33Z

src/server/status/metrics.js

+    process: {
+      mem: {
+        heap: {
+          total_in_bytes: _.get(event, 'psmem.heapTotal'),


Can we change this to heap_max_in_bytes and nest under mem to align with ES?

tylersmalley · 2017-02-15T17:05:53Z

src/server/status/metrics.js

+      mem: {
+        heap: {
+          total_in_bytes: _.get(event, 'psmem.heapTotal'),
+          used_in_bytes:  _.get(event, 'psmem.heapUsed')


Can we change this to heap_used_in_bytes and nest under mem to align with ES?

tylersmalley · 2017-02-15T19:31:49Z

@epixa, this is ready for another look.

epixa · 2017-02-15T22:01:51Z

If you're both comfortable with this, I am. I gave it a pretty thorough review before, and the recent changes are minimal.

epixa · 2017-02-15T22:02:09Z

@ruflin Do you want to look at this API response before we merge it?

tylersmalley · 2017-02-15T22:06:59Z

Here is an example output of /api/status

{
  "name":"tsmalley",
  "uuid":"43469b79-7cfa-46fb-a187-387f2d1252d3",
  "version":{
    "number":"6.0.0-alpha1",
    "build_hash":"6cb7fec4e154faa0a4a3fee4b33dfef91b9870d9",
    "build_number":8467,
    "build_snapshot":false
  },
  "status":{
    "overall":{
      "state":"red",
      "title":"Red",
      "nickname":"Danger Will Robinson! Danger!",
      "icon":"danger",
      "since":"2017-02-15T22:05:09.916Z"
    },
    "statuses":[
      {
        "id":"ui settings",
        "state":"red",
        "icon":"danger",
        "message":"Elasticsearch plugin is red",
        "since":"2017-02-15T22:05:10.198Z"
      },
      {
        "id":"plugin:kibana@6.0.0-alpha1",
        "state":"green",
        "icon":"success",
        "message":"Ready",
        "since":"2017-02-15T22:05:09.820Z"
      },
      {
        "id":"plugin:elasticsearch@6.0.0-alpha1",
        "state":"red",
        "icon":"danger",
        "message":"Unable to connect to Elasticsearch at http://localhost:9200.",
        "since":"2017-02-15T22:05:09.916Z"
      },
      {
        "id":"plugin:console@6.0.0-alpha1",
        "state":"green",
        "icon":"success",
        "message":"Ready",
        "since":"2017-02-15T22:05:09.907Z"
      },
      {
        "id":"plugin:timelion@6.0.0-alpha1",
        "state":"green",
        "icon":"success",
        "message":"Ready",
        "since":"2017-02-15T22:05:10.189Z"
      }
    ]
  },
  "metrics":{
    "last_updated":"2017-02-15T22:05:23.605Z",
    "collection_interval_in_millis":5000,
    "uptime_in_millis":19416,
    "process":{
      "mem":{
        "heap_max_in_bytes":201592832,
        "heap_used_in_bytes":174029824
      }
    },
    "os":{
      "cpu":{
        "load_average":{
          "1m":4.51513671875,
          "5m":3.46142578125,
          "15m":3.46142578125
        }
      }
    },
    "response_times":{
      "avg_in_millis":null,
      "max_in_millis":0
    },
    "requests":{
      "total":0,
      "disconnects":0,
      "status_codes":{

      }
    },
    "concurrent_connections":2
  }
}

ruflin · 2017-02-16T14:11:37Z

@epixa @tylersmalley LGTM. Most important part for me is that there are no arrays (beside the statuses one) and only one set of values. That is the case here.

Thanks for all the work on this one.

jbudz added release_note:breaking tests_needed review v6.0.0 labels Feb 3, 2017

jbudz requested review from tylersmalley and epixa February 3, 2017 18:51

jbudz mentioned this pull request Feb 3, 2017

Add node stats api #9925

Closed

ruflin approved these changes Feb 5, 2017

View reviewed changes

tylersmalley suggested changes Feb 6, 2017

View reviewed changes

jbudz force-pushed the status-api branch 2 times, most recently from aaf4cc0 to f2239b3 Compare February 6, 2017 14:17

tbragin added the Team:Operations Team label for Operations Team label Feb 6, 2017

jbudz removed the tests_needed label Feb 6, 2017

tylersmalley approved these changes Feb 7, 2017

View reviewed changes

jbudz force-pushed the status-api branch from 19b3bee to 501ff37 Compare February 8, 2017 15:38

jbudz force-pushed the status-api branch from 501ff37 to ac1c21a Compare February 10, 2017 16:46

epixa self-assigned this Feb 13, 2017

epixa suggested changes Feb 13, 2017

View reviewed changes

jbudz added 10 commits February 15, 2017 07:58

[status] Only provide latest metrics

736b2e2

[status] Snake case requests object

df3cf91

[status] Add build snapshot flag, last updated time

a0500cf

[status] Re-add requests per second

44374ae

[status] Add uptime

9b85a3b

[status] collection_time -> collection_interval, add memory object

f259a05

[status] Add api tests

09c5dae

[status] Add breaking changes docs

33c40c2

[status] Remove metrics config

5ff7d94

[status] nest load under cpu, shorten memory and average

d4110a2

[status] collection_time -> collection_interval

a27d0bc

jbudz force-pushed the status-api branch from 894d7bf to a27d0bc Compare February 15, 2017 13:58

tylersmalley reviewed Feb 15, 2017

View reviewed changes

src/server/status/metrics.js Outdated

},

os: {

cpu: {

load: {

Copy link

Contributor

tylersmalley Feb 15, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we change this to load_average to align with ES?

tylersmalley reviewed Feb 15, 2017

View reviewed changes

[status api] Unnest heap, rename load to load average

e3fca52

tylersmalley approved these changes Feb 15, 2017

View reviewed changes

epixa approved these changes Feb 15, 2017

View reviewed changes

jbudz merged commit 9bc4d91 into elastic:master Feb 16, 2017

epixa added v5.3.0 v5.4.0 and removed v5.3.0 v5.4.0 labels Feb 16, 2017

jbudz mentioned this pull request Feb 21, 2017

[5.x][status api] opt in to v6 metrics #10481

Merged

tbragin mentioned this pull request Mar 2, 2017

[Design] Format of the Status page seems off #6636

Closed

tylersmalley mentioned this pull request May 18, 2017

Stats api POC #11828

Closed

jimgoodwin added the v6.0.0-rc1 label Sep 28, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updates to status API, re-align status page #10180

Updates to status API, re-align status page #10180

jbudz commented Feb 3, 2017 •

edited

Loading

tylersmalley Feb 6, 2017

tylersmalley Feb 6, 2017

tylersmalley Feb 6, 2017

tylersmalley left a comment

epixa commented Feb 10, 2017

epixa commented Feb 13, 2017

epixa left a comment

tylersmalley Feb 15, 2017

tylersmalley Feb 15, 2017

tylersmalley Feb 15, 2017

tylersmalley commented Feb 15, 2017

epixa commented Feb 15, 2017

epixa commented Feb 15, 2017 •

edited

Loading

tylersmalley commented Feb 15, 2017

ruflin commented Feb 16, 2017

Updates to status API, re-align status page #10180

Updates to status API, re-align status page #10180

Conversation

jbudz commented Feb 3, 2017 • edited Loading

tylersmalley Feb 6, 2017

Choose a reason for hiding this comment

tylersmalley Feb 6, 2017

Choose a reason for hiding this comment

tylersmalley Feb 6, 2017

Choose a reason for hiding this comment

tylersmalley left a comment

Choose a reason for hiding this comment

epixa commented Feb 10, 2017

epixa commented Feb 13, 2017

epixa left a comment

Choose a reason for hiding this comment

tylersmalley Feb 15, 2017

Choose a reason for hiding this comment

tylersmalley Feb 15, 2017

Choose a reason for hiding this comment

tylersmalley Feb 15, 2017

Choose a reason for hiding this comment

tylersmalley commented Feb 15, 2017

epixa commented Feb 15, 2017

epixa commented Feb 15, 2017 • edited Loading

tylersmalley commented Feb 15, 2017

ruflin commented Feb 16, 2017

jbudz commented Feb 3, 2017 •

edited

Loading

epixa commented Feb 15, 2017 •

edited

Loading