Skip to content
This repository has been archived by the owner on Nov 11, 2018. It is now read-only.

Latest commit

 

History

History
executable file
·
24 lines (17 loc) · 1.74 KB

README.md

File metadata and controls

executable file
·
24 lines (17 loc) · 1.74 KB

tv Logo

Interactive debug console for hapi

Build Status

The debug console is a simple web page in which developers can subscribe to a debug id (or * for all), and then include that debug id as an extra query parameter with each request. The server will use WebSocket to stream the subscribed request logs to the web page in real-time. To enable the debug console in a hapi application, set the server's debug option to true or to an object with custom configuration as described in the hapi documentation.

Debug

To assist in debugging server events related to specific incoming requests, hapi includes an optional debug console which is turned off by default. The debug console is a simple web page in which developers can subscribe to a debug id, and then include that debug id as an extra query parameter in each request. The server will use WebSocket to stream the subscribed request logs to the web page in real-time. In application using multiple server instances, only one can enable the debug interface using the default port. To enable the debug console set the debug option to true or to an object with custom configuration:

  • websocketPort - the port used by the WebSocket connection. Defaults to 3000.
  • debugEndpoint - the debug console request path added to the server routes. Defaults to '/debug/console'.
  • queryKey - the name or the request query parameter used to mark requests being debugged. Defaults to debug.