admin

行政

Drop-In Node.js管理员端点可帮助您分析生产问题。

现场演示|用法|常见问题解答|插件|示例项目| ChangElog

---

生产中的运行应用程序可能具有挑战性。应用程序可能会崩溃，陷入错误或变得慢。有多种方法可以解决此类问题。管理员是帮助解决应用程序问题的工具。它旨在提供有关运行node.js应用程序的详细调试信息。

管理员通过HTTP服务器提供调试端点。该服务器提供的功能是可扩展的，因为管理员是插件系统。

与其详细描述这一点，不如在Heroku上查看实时演示系统！

内容

• 安装
• 用法
• 常问问题
  • 当管理UI仅绑定到Localhost时，该如何检查？

安装

要使用管理员，需要安装Admin Node.js软件包和至少一个插件。以下示例显示了典型的设置。

 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

用法

要使用管理员，需要将其配置并从您的应用程序开始。 foring代码列表显示了如何完成。

 const admin = require ( 'admin' ) ;

admin . configure ( {
  http : { // optional
    bindAddress : '127.0.0.1' , // default
    port : 2999 // default
  } ,

  plugins : [
    require ( 'admin-plugin-index' ) ( ) ,
    require ( 'admin-plugin-report' ) ( ) ,
    require ( 'admin-plugin-environment' ) ( ) ,
    require ( 'admin-plugin-profile' ) ( ) ,
    require ( 'admin-plugin-terminate' ) ( ) ,
    require ( 'admin-plugin-config' ) ( {
      config : {
        // An application config goes here. This config object will be
        // visible in the admin UI and via the admin REST endpoints.
        secret : '42' ,
        port : 8080
      }
    } ) ,
    require ( 'admin-plugin-healthcheck' ) ( {
      checks : {
        // Define multiple healthchecks which check critical components
        // in the system. The following example shows valid return values.
        random ( ) {
          const v = Math . random ( ) ;
          if ( v > 0.8 ) {
            throw new Error ( 'Random value >0.8' ) ;
          } else if ( v > 0.3 ) {
            return "Healthy like an application that isn't used." ;
          } else {
            return Promise . reject ( 'Something bad happened here…' ) ;
          }
        }
      }
    } )
  ]
} ) ;

admin . start ( ) ; 

常问问题

当管理UI仅绑定到Localhost时，该如何检查？

最简单的解决方案是将SSH隧道设置为机器：

 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"