admin

администратор

Drop-in node.js Admin Endpoint, чтобы помочь вам проанализировать проблемы производства.

Живая демонстрация | Использование | FAQ | Плагины | Пример проекта | Изменение

---

Запуск приложений в производстве может быть сложным. Приложения могут потерпеть крах, сталкиваться с ошибками или медленно. Существует множество способов подхода к таким вопросам. Администратор - это инструмент, который поможет решать проблемы применения. Он предназначен для предоставления подробной информации отладки о запуска приложений node.js.

Admin обеспечивает отладку конечных точек через HTTP -сервер. Функциональность, предоставляемая этим сервером, расширяется, поскольку администратор является системой плагина.

Вместо того, чтобы описать это подробно, проверьте живую демонстрационную систему на Heroku!

Содержимое

• Установка
• Использование
• Часто задаваемые вопросы
  • Как я могу осмотреть пользовательский интерфейс только тогда, когда он связывается с Localhost?

Установка

Чтобы использовать Admin, необходимо установить пакет 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

Использование

Чтобы использовать администратор, его необходимо настроить и начать с вашего приложения. Список кода фологу показывает, как это можно сделать.

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

Часто задаваемые вопросы

Как я могу осмотреть пользовательский интерфейс только тогда, когда он связывается с 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"