Open-Source API Management and Microservice Management

Maybe you were looking for the Kong Gateway (Enterprise) documentation instead?

kong.node

Node-level utilities

kong.node.get_id()

Returns the id used by this node to describe itself.

Returns

string The v4 UUID used by this node as its id

Usage

local id = kong.node.get_id()

kong.node.get_memory_stats([unit[, scale]])

Returns memory usage statistics about this node.

Parameters

unit (string, optional): The unit memory should be reported in. Can be either of b/B, k/K, m/M, or g/G for bytes, kibibytes, mebibytes, or gibibytes, respectively. Defaults to b (bytes).
scale (number, optional): The number of digits to the right of the decimal point. Defaults to 2.

Returns

table A table containing memory usage statistics for this node. If unit is b/B (the default) reported values will be Lua numbers. Otherwise, reported values will be a string with the unit as a suffix.

Usage

local res = kong.node.get_memory_stats()
-- res will have the following structure:
{
  lua_shared_dicts = {
    kong = {
      allocated_slabs = 12288,
      capacity = 24576
    },
    kong_db_cache = {
      allocated_slabs = 12288,
      capacity = 12288
    }
  },
  workers_lua_vms = {
    {
      http_allocated_gc = 1102,
      pid = 18004
    },
    {
      http_allocated_gc = 1102,
      pid = 18005
    }
  }
}

local res = kong.node.get_memory_stats("k", 1)
-- res will have the following structure:
{
  lua_shared_dicts = {
    kong = {
      allocated_slabs = "12.0 KiB",
      capacity = "24.0 KiB",
    },
    kong_db_cache = {
      allocated_slabs = "12.0 KiB",
      capacity = "12.0 KiB",
    }
  },
  workers_lua_vms = {
    {
      http_allocated_gc = "1.1 KiB",
      pid = 18004
    },
    {
      http_allocated_gc = "1.1 KiB",
      pid = 18005
    }
  }
}

kong.node.get_hostname()

Returns the name used by the local machine

Returns

string The local machine hostname

Usage

local hostname = kong.node.get_hostname()