Articles in this section

See more

Health API

  • Updated
Follow

Overview

This API returns application health information.

Authentication

None

The API endpoint parameters

  • PATH: /health

EXAMPLE: https://app.etlworks.com/health

  • METHOD: GET
  • HEADER: none
  • REQUEST BODY: none
  • REQUEST CONTENT TYPE: none

Response

The response is a JSON document in the following Format. 

{"status":"UP",
"db":{"status":"UP","version":"13.0,","schema.version":84,"running.flows":0},
"disk":{"status":"UP","free":549674905600,"free.human":"511.9 GiB"},
"ram":{"status":"UP","mem":34092032000,"mem.human":"31.8 GiB",
"mem.free":19785678848,"mem.free.human":"18.4 GiB",
"heap":11185160192,"heap.human":"10.4 GiB",
"heap.committed":1310195712,"heap.committed.human":"1.2 GiB",
"heap.used":553466272,"heap.used.human":"527.8 MiB"},
"cpu":{"status":"UP","processors":16,"systemload.average":-1.0,"threads":41,
"threads.peak":64,"threads.daemon":34},
"redis":{"status":"UP","version":"3.0.504","db.size":641,
"mem.used":3122784,"mem.used.human":"3.0 MiB",
"mem.used.rss":3085016,"mem.used.rss.human":"2.9 MiB"}}

Response codes

  • 200 for success
  • 500 for an internal error
  • 504 for not responding (timeout) 
  • 502 for network gateway error
  • 5xx for network issues

Monitor Etlworks instance health

Read about monitoring Etlworks instance health using this API endpoint.

Related articles

Comments

0 comments

Please sign in to leave a comment.