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"