admin

管理者

Drop-in node.js管理エンドポイントは、生産の問題を分析するのに役立ちます。

ライブデモ|使用法| FAQ |プラグイン|プロジェクトの例| Changelog

---

制作中にアプリを実行するのは困難です。アプリケーションがクラッシュしたり、バグに遭遇したり、遅くなったりする場合があります。このような問題にアプローチするには、さまざまな方法があります。管理者は、アプリケーションの問題のトラブルシューティングを支援するツールです。 Node.jsアプリの実行に関する詳細なデバッグ情報を提供するように設計されています。

管理者は、HTTPサーバーを介してデバッグエンドポイントを提供します。管理者はプラグインシステムであるため、このサーバーが提供する機能は拡張可能です。

これを長々と説明する代わりに、Herokuのライブデモシステムをチェックしてください！

コンテンツ

• インストール
• 使用法
• よくある質問
  • Admin UIがLocalHostにのみバインドした場合、AdminUIを検査するにはどうすればよいですか？

インストール

adminを使用するには、admin node.jsパッケージと少なくとも1つのプラグインをインストールする必要があります。次の例は、典型的なセットアップを示しています。

 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

使用法

管理者を使用するには、アプリケーションを設定して開始する必要があります。従来のコードリストは、これがどのように行われるかを示しています。

 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 ( ) ; 

よくある質問

Admin UIがLocalHostにのみバインドした場合、AdminUIを検査するにはどうすればよいですか？

最も簡単な解決策は、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"