NGINX · Schema

Worker processes

nginx worker processes object.

API GatewayCachingCloud NativeLoad BalancerOpen SourceReverse ProxyWeb Server
View JSON Schema on GitHub

JSON Schema

plus-http-api-nginx-workers-map-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/nginx/refs/heads/main/json-schema/plus-http-api-nginx-workers-map-schema.json",
  "title": "Worker processes",
  "description": "nginx worker processes object.",
  "type": "object",
  "additionalProperties": {
    "title": "Worker process",
    "description": "Statistics per each worker process.\n",
    "properties": {
      "id": {
        "type": "integer",
        "description": "The ID of the worker process.",
        "example": 0
      },
      "pid": {
        "type": "integer",
        "description": "The PID identifier of the worker process used by the operating system.",
        "example": 4521
      },
      "connections": {
        "type": "object",
        "description": "The number of accepted, dropped, active, and idle connections\nper worker process.\n",
        "properties": {
          "accepted": {
            "type": "integer",
            "description": "The total number of client connections\naccepted by the worker process.\n",
            "example": 4968119
          },
          "dropped": {
            "type": "integer",
            "description": "The total number of client connections\ndropped by the worker process.\n",
            "example": 0
          },
          "active": {
            "type": "integer",
            "description": "The current number of active client connections\nthat are currently being handled by the worker process.\n",
            "example": 5
          },
          "idle": {
            "type": "integer",
            "description": "The number of idle client connections\nthat are currently being handled by the worker process.\n",
            "example": 117
          }
        },
        "example": {}
      },
      "http": {
        "type": "object",
        "properties": {
          "requests": {
            "type": "object",
            "description": "The total number of client requests handled by the worker process.",
            "properties": {
              "total": {
                "type": "integer",
                "description": "The total number of client requests received by the worker process.",
                "example": 98765
              },
              "current": {
                "type": "integer",
                "description": "The current number of client requests that are currently being processed by the worker process.",
                "example": 3
              }
            },
            "example": 31070465
          }
        },
        "example": {}
      }
    },
    "example": {
      "id": 0,
      "pid": 32212,
      "connections": {
        "accepted": 1,
        "dropped": 0,
        "active": 1,
        "idle": 0
      },
      "http": {
        "requests": {
          "total": 15,
          "current": 1
        }
      }
    }
  },
  "example": [
    {
      "id": 0,
      "pid": 32212,
      "connections": {
        "accepted": 1,
        "dropped": 0,
        "active": 1,
        "idle": 0
      },
      "http": {
        "requests": {
          "total": 19,
          "current": 1
        }
      }
    },
    {
      "id": 1,
      "pid": 32214,
      "connections": {
        "accepted": 1,
        "dropped": 0,
        "active": 1,
        "idle": 0
      },
      "http": {
        "requests": {
          "total": 15,
          "current": 0
        }
      }
    }
  ]
}