nginstack

Module: @nginstack/engine/lib/monitoring/EngineInfo

Classes

EngineInfo

Type Definitions

CpuInfo

Informações da CPU do servidor do Engine.

Type:
  • Object
Properties:
Name Type Description
modelName string

Nome do modelo da CPU.
vendorId string

Identificação do fabricante da CPU.
family number

Identificação numérica da família da CPU.
model number

Identificação numérica do modelo da CPU.
stepping number

Variação (stepping) da CPU.
physicalCores number

Quantidade de cores físicos da CPU.
logicalCores number

Quantidade de cores lógicos da CPU.
addressWidth number

Tamanho do endereçamento da CPU em bits.

DatabaseConfig

Configuração da conexão do Engine com um banco de dados.

Type:
  • Object
Properties:
Name Type Description
name string

Nome da base de dados servida por este Engine.
type string

Sistema gerenciador de banco de dados objeto relacional utilizado para servir a base de dados. Valores possíveis: 'pgsql', 'oracle' e 'mssql'.
reference string

Configuração de conexão da base de dados.
userName string

Nome do usuário utilizado na conexão com o banco de dados.
maxConnections number

Quantidade máxima de conexões que serão estabelecidas com o SGBD.
enabled boolean

Indica se esta configuração está habilitada no Engine.

DBCacheInfo

Informações e estatísticas do cache local do Engine.

Type:
  • Object
Properties:
Name Type Description
version number

Versão sincronizada pelo cache local.
lastSyncError string

Erro no último sincronismo, caso ele tenha falhado.
lastSyncDuration number

Duração do último sincronismo do cache local.
syncing boolean

Indica se o Engine estava sincronizado o cache no momento da coleta das estatísticas.
size number

Tamanho em bytes do arquivo do banco de dados utilizado pelo cache local.
pageSize number

Tamanho em bytes da página de dados utilizada pelo cache local.
idoCacheSize number

Quantidade de memória reservada para o cache dos dados gerenciados pelo IDO. O IDO é a API interna do Engine responsável por armazenar os dados do Cache Local e dos DataSets temporários.
tableCount number

Quantidade de tabelas no cache local.

EngineAlert

Alerta sobre um Engine gerado pelo monitoramento do sistema.

Type:
  • Object
Properties:
Name Type Description
severity module:@nginstack/engine/lib/monitoring/AlertSeverity~AlertSeverity

Severidade do alerta para o funcionamento do sistema.
code string

Código que permite identificar este alerta programaticamente. A relação dos códigos dos alertas emitidos pelo sistema pode ser obtida em module:@nginstack/engine/lib/monitoring/AlertCodes.
message string

Mensagem descritiva do alerta.
engineId string

Identificador único do Engine que emitiu o alerta.

EngineConfig

Configuração do Engine.

Type:
  • Object
Properties:
Name Type Description
syncToDisk boolean

Indica se o IDO força a gravação dos buffers em memória para disco a cada transação efetivada.
automaticUpgrade boolean

Indica se o Engine está configurado para atualizar automaticamente a partir do servidor a cada reinício.
timeZoneBias number

Diferença em minutos da hora local do Engine para a UTC.

MemoryStats

Estatísticas de consumo de memória do Engine.

Type:
  • Object
Properties:
Name Type Description
usedVirtual number

Quantidade de memória virtual privada alocada pelo Engine, seja ela física ou paginada. A memória virtual privada pode ser eventualmente menor que a alocada, pois essa última considera os recursos compartilhados com outros processos.
usedPhysical number

Quantidade total (privada e compartilhada) de memória física alocada pelo Engine que não pode ser utilizada por outros processos.
totalPhysical number

Quantidade de memória física total instalada no servidor, disponível para o Engine e para os demais processos.
availablePhysical number

Quantidade de memória física não alocada que ainda está livre para ser utilizada pelos processos.
totalPageFile number

Quantidade total de memória do servidor que pode ser utilizada pelo Engine, podendo ser memória física ou paginada em disco.
availablePageFile number

Quantidade total de memória do servidor que ainda pode ser utilizada pelo Engine, podendo ser memória física ou paginada em disco.
statefulSessionsCount number

Quantidade de sessões JavaScript com preservação de estado, utilizadas normalmente por aplicações com interfaces ricas onde há o conceito de usuário logado, como a interface Web padrão do sistema.
statelessSessionsCount number

Quantidade de sessões JavaScript sem preservação de estado. Sessões Stateless são utilizadas por rotinas, agendamento de scripts e APIs HTTP que não precisam manter o estado da sessão após o término do processamento.
standaloneSessionsCount number

Quantidade de sessões JavaScript que são criadas internamente pelo Engine em cenários onde não haverá reaproveitamento da sessão após o término do seu uso. Normalmente são utilizadas para processamentos internos do Engine de curta duração.

PathsConfig

Configuração dos diretórios utilizados pelo Engine para gravar os dados, logs e arquivos temporários.

Type:
  • Object
Properties:
Name Type Description
mainProgram string

Caminho para o executável principal do Engine.
dataDir string

Caminho para o diretório de dados do sistema.
programDir string

Caminho para o diretório onde está o executável principal do sistema.
logDir string

Caminho para o diretório de logs do sistema.
tempDir string

Caminho para o diretório de arquivos temporários do sistema.

PortConfig

Configuração de uma porta HTTP ou HTTPS no Engine.

Type:
  • Object
Properties:
Name Type Description
port number

Porta TCP que está sendo atendida pelo Engine.
protocol string

Protocolo atendido nesta porta. Valores possíveis: 'http' e 'https'.
address string

Endereço IP da interface de rede na qual a porta TCP foi aberta pelo Engine. Um valor vazio indicará que o Engine atenderá o tráfego nesta porta em todas interfaces de rede do servidor.
cipherList string

Lista de algoritmos de criptografia habilitados caso o protocolo seja HTTPS. Um valor vazio indica que a configuração padrão do OpenSSL será adotada. Veja https://www.openssl.org/docs/manmaster/man1/openssl-ciphers.html para mais detalhes do formato dessa lista.
disabledOnStartup boolean

Indica que esta porta deve ser mantida desabilitada pelo Engine enquanto o cache local da base de dados não for inicializado e o Engine não estiver pronto para atender requisições.
enabled boolean

Indica se esta configuração de porta TCP está habilitada no Engine.

SchedulerInfo

Informações e estatísticas do agendador de scripts do Engine.

Type:
  • Object
Properties:
Name Type Description
taskCount number

Quantidade de tarefas agendadas.
runningTaskCount number

Quantidade de tarefas que estão em execução.
failingTaskCount number

Quantidade de tarefas agendadas que falharam na última execução.
maxConcurrentTaskCount number

Quantidade máxima de tarefas que podem ser executadas concorrentemente.

TransactionLoggerInfo

Informações e estatísticas do gerenciador de logs transacionais assíncrono.

Type:
  • Object
Properties:
Name Type Description
pendingLogs number

Quantidade de logs transacionais assíncronos pendentes de gravação no banco de dados.
sendingError number

Erro ocorrido no último envio dos logs transacionais pendentes.