Module: Kongkit::Client::Node

Included in:

Kongkit::Client

Defined in:

lib/kongkit/client/node.rb

Instance Method Summary

• #node_information ⇒ Kongkit::Client::Resource

  Retrieve node information.

• #node_status ⇒ Kongkit::Client::Resource

  Retrieve node status.

Instance Method Details

#node_information ⇒ Kongkit::Client::Resource

Retrieve node information

Retrieve generic details about a node.

Returns:

• (Kongkit::Client::Resource) —

  Node information

See Also:

• https://getkong.org/docs/0.8.x/admin-api/#retrieve-node-information

# File 'lib/kongkit/client/node.rb', line 10

def node_information
  get('/')
end

#node_status ⇒ Kongkit::Client::Resource

Retrieve node status

Retrieve usage information about a node, with some basic information about the connections being processed by the underlying nginx process, and the number of entities stored in the datastore collections (including plugin’s collections).

If you want to monitor the Kong process, since Kong is built on top of nginx, every existing nginx monitoring tool or agent can be used.

Returns:

• (Kongkit::Client::Resource) —

  Node status

See Also:

• https://getkong.org/docs/0.8.x/admin-api/#retrieve-node-status

# File 'lib/kongkit/client/node.rb', line 26

def node_status
  get('/status')
end