Graylog: Utilizzo con Node.js

Come inviare i log da Node.js a Graylog

👋 Benvenuti nella documentazione di Stackhero!

Stackhero offre una soluzione Graylog cloud pronta all'uso che fornisce numerosi vantaggi, tra cui:

• Server email SMTP illimitato e dedicato incluso.
• Aggiornamenti senza sforzo con un solo clic.
• Nome di dominio personalizzabile sicuro con HTTPS (ad esempio, https://logs.tua-azienda.com).
• Prestazioni ottimali e sicurezza robusta grazie a una VM privata e dedicata.

Risparmia tempo e semplifica la tua vita: bastano 5 minuti per provare la soluzione Graylog cloud hosting di Stackhero!

Inviare i log di Node.js a Graylog con il pacchetto graylog2 (consigliato)

Inviare i log da Node.js a Graylog è molto semplice. In questo esempio, vedrete come utilizzare il pacchetto graylog2 per rendere questo processo immediato.

Per iniziare, è possibile installare il pacchetto eseguendo il seguente comando:

npm install graylog2

Ecco come potete utilizzarlo per registrare i messaggi:

const graylog2 = require('graylog2');
const crypto = require('crypto');

const logger = new graylog2.graylog({
  servers: [{ host: '<XXXXXX>.stackhero-network.com', port: 12201 }] // Assicuratevi di sostituire "host" con il vostro dominio Graylog
});

// Invia un messaggio semplice a Graylog
logger.log('Simple message example');

// Associa dati aggiuntivi a un messaggio
logger.log(
  'Password recovery email', // Messaggio
  // Un oggetto JSON con dettagli aggiuntivi
  {
    subject: 'Password recovery',
    language: 'en_US',
    domain: 'gmail.com'
  }
);

// Esempio avanzato
const ip = '1.2.3.4';
const ipHash = crypto.createHash('md5').update(ip).digest('hex');

const userId = '1234';
const userIdHash = crypto.createHash('md5').update(userId).digest('hex');

logger.log(
  'API request', // Messaggio
  // Un oggetto JSON con ulteriori dettagli
  {
    route: '/v1/messages/1234/',
    method: 'POST',

    responseTime: 12, // ms
    responseCode: 200,

    ipHash,
    userIdHash
  }
);

// Log delle eccezioni non gestite in Node.js
process.on(
  'uncaughtException',
  err => {
    logger.log(
      err,
      { type: 'uncaughtException' }
    );
  }
);

Per ulteriori esempi, potete consultare questo repository GitHub.

warning Non dimenticate di configurare il vostro input Graylog (vedi dettagli sotto).

Utilizzo del pacchetto Winston GELF per inviare i log di Node.js a Graylog

warning È preferibile utilizzare il pacchetto graylog2 a meno che Winston non sia già parte del vostro progetto. In tal caso, potete sostituirlo con winston-gelf.

Per installare il pacchetto Winston GELF, eseguite:

npm install winston-gelf

Se Winston non è già presente nel vostro progetto, potete aggiungerlo con:

npm install winston

Ecco una configurazione di base:

const winston = require('winston');
const winstonGelf = require('winston-gelf');
const process = require('process');

const logger = winston.createLogger({
  transports: [
    new winston.transports.Console(),
    new winstonGelf({
      // Consultate tutte le opzioni di gelfPro qui: https://www.npmjs.com/package/gelf-pro
      gelfPro: {
        fields: {
          env: process.env.NODE_ENV || 'development'
        },
        adapterName: 'udp',
        adapterOptions: {
          host: '<XXXXXX>.stackhero-network.com', // Sostituite con il vostro dominio Graylog
          port: 12201,
        }
      }
    })
  ]
});

// Esempio di log informativo
logger.info('This is a log information');

// Esempio di log di errore
try {
  throw Error('This is an example error');
}
catch(error) {
  logger.warn({ message: 'Error triggered', error });
}

Non dimenticate di configurare il vostro input Graylog (vedi dettagli sotto).

Configurazione dell'input Graylog

Nell'interfaccia Graylog, andate su System/Inputs, create un nuovo input di tipo "GELF UDP" e cliccate su "Launch new input". Nella finestra che appare, selezionate "Global", aggiungete un titolo e confermate senza modificare le altre impostazioni.

Questo è tutto! Graylog è ora pronto a ricevere i log dalla vostra applicazione Node.js.

Per aumentare la sicurezza, considerate di filtrare gli IP autorizzati a inviare dati sulla porta 12201. Potete farlo accedendo alla dashboard di Stackhero, selezionando il vostro servizio Graylog e configurando il "Firewall" per consentire solo i vostri IP.