Drop-in Node.js admin endpoint to help you analyze production issues.
Running apps in production can be challenging. Applications may crash, run into bugs or get slow. There are a variety of ways to approach such issues. Admin is a tool to help troubleshoot application issues. It is designed to provide detailed debugging information about running Node.js apps.
Admin provides debugging endpoints via an HTTP server. The functionality provided by this server is extensible as admin is a plugin system.
Instead of describing this at length, check out the live demo system on Heroku!
npm install --save admin \ admin-plugin-config \ admin-plugin-healthcheck \ admin-plugin-environment \ admin-plugin-index \ admin-plugin-profile \ admin-plugin-report \ admin-plugin-terminate
To use admin, it needs to be configured and started with your application. The folowing code listing shows how this can be done.
const admin = ;admin;adminstart;
How do I inspect the admin UI when it only binds to localhost?
The easiest solution is to setup an SSH tunnel to the machine:
SSH_KEY="~/.ssh/<my_key>" REMOTE_USER="<user>" REMOTE_HOST="<host>" ADMIN_PORT="<port>" ssh -i "$SSH_KEY" -Nf -L "$ADMIN_PORT:localhost:$ADMIN_PORT" "$REMOTE_USER@$REMOTE_HOST" curl "localhost:$ADMIN_PORT"