Express-Standardprotokollkomponente nach Morgans Methode

Morgan ist die Standard-Protokollierungs-Middleware von Express. Jetzt werde ich sie mit Ihnen teilen und eine Referenz geben.

Kapitelübersicht

Morgan ist die Standardprotokollierungs-Middleware von Express und kann auch von Express getrennt und als node.js verwendet werden Protokollierungskomponente Allein verwenden. Dieser Artikel geht von oberflächlich bis tiefgründig und der Inhalt umfasst hauptsächlich:

1. Einführungsbeispiele für die Verwendung von Morgan

2. So speichern Sie Protokolle in lokalen Dateien

3. Anweisungen und Beispiele zur Verwendung der Kern-API

4. Erweiterte Verwendung: 1. Protokollaufteilung 2. Protokolle in die Datenbank schreiben

5. Quellcode-Analyse: Protokollformat und Vorkompilierung von Morgan

Beispiel für den ersten Schritt

Initialisieren Sie zunächst das Projekt.

npm install express morgan

Fügen Sie dann den folgenden Code in basic.js hinzu.

var express = require('express');
var app = express();
var morgan = require('morgan');

app.use(morgan('short'));
app.use(function(req, res, next){
 res.send('ok');
});

app.listen(3000);

node basic.jsFühren Sie das Programm aus und greifen Sie im Browser auf http://127.0.0.1:3000 zu. Das Druckprotokoll sieht wie folgt aus

➜ 2016.12.11-advanced-morgan git:(master) ✗ node basic.js
::ffff:127.0.0.1 - GET / HTTP/1.1 304 - - 3.019 ms
::ffff:127.0. 0.1 – GET /favicon.ico HTTP/1.1 200 2 – 0,984 ms

Protokoll in eine lokale Datei drucken

Morgan unterstützt Stream-Konfigurationselemente, die kann verwendet werden Um den Effekt der Protokollimplementierung zu erzielen, lautet der Code wie folgt:

var express = require('express');
var app = express();
var morgan = require('morgan');
var fs = require('fs');
var path = require('path');
var accessLogStream = fs.createWriteStream(path.join(__dirname, 'access.log'), {flags: 'a'});
app.use(morgan('short', {stream: accessLogStream}));
app.use(function(req, res, next){
 res.send('ok');
});
app.listen(3000);

Verwendungserklärung

Kern-API

Morgan verfügt über sehr wenige APIs. Die am häufigsten verwendete ist morgan(), die eine Express-Log-Middleware zurückgibt.

morgan(format, options)

Die Parameterbeschreibung lautet wie folgt:

1. Format: optional, Morgan und definiert Es gibt mehrere Protokollformate. Jedes Format hat einen entsprechenden Namen, z. B. kombiniert, kurz usw. Der Standardwert ist Standard. Die Unterschiede zwischen verschiedenen Formaten finden Sie hier. Im Folgenden wird erläutert, wie Sie das Protokollformat anpassen.

2. Optionen: Optional, Konfigurationselemente, einschließlich Stream (häufig verwendet), Überspringen und Sofort.

3. stream: Konfiguration des Protokollausgabestreams, der Standardwert ist process.stdout.

4. Überspringen: Ob die Protokollierung übersprungen werden soll, erfahren Sie hier zur Verwendung.

5. sofort: Boolescher Wert, Standard ist falsch. Bei „true“ wird das Protokoll protokolliert, sobald die Anfrage eingeht; bei „false“ wird das Protokoll protokolliert, nachdem die Anfrage zurückgegeben wurde.
   

Benutzerdefiniertes Protokollformat

Verstehen Sie zunächst die beiden Konzepte in Morgan: Format und Token. Ganz einfach:

1. Format: Protokollformat, das im Wesentlichen eine Zeichenfolge ist, die das Protokollformat darstellt, wie zum Beispiel: method :url :status :res[content-length] - : Reaktionszeit ms.

2. Token: Komponente des Formats, wie z. B. :method und :url oben sind sogenannte Token.

Nachdem Sie den Unterschied zwischen Format und Token geklärt haben, können Sie einen Blick auf die wichtigsten APIs zum Anpassen von Protokollformaten in Morgan werfen.

morgan.format(name, format); // 自定义日志格式
morgan.token(name, fn); // 自定义token

Benutzerdefiniertes Format

Es ist ganz einfach, führen Sie zuerst morgan.format() durch Definieren Sie das Protokollformat mit dem Namen joke und rufen Sie es dann über morgan('joke') auf.

var express = require('express');
var app = express();
var morgan = require('morgan');
morgan.format('joke', '[joke] :method :url :status');
app.use(morgan('joke'));
app.use(function(req, res, next){
 res.send('ok');
});
app.listen(3000);

Werfen wir einen Blick auf die Laufergebnisse

➜ 2016.12.11-advanced-morgan git:(master) ✗ node morgan .format.js
[Witz] GET / 304
[Witz] GET /favicon.ico 200

Benutzerdefiniertes Token

Code: Passen Sie das Token wie folgt über morgan.token() an und fügen Sie dann das angepasste Token dem angepassten Format hinzu.

var express = require('express');
var app = express();
var morgan = require('morgan');
// 自定义token
morgan.token('from', function(req, res){
 return req.query.from || '-';
});
// 自定义format，其中包含自定义的token
morgan.format('joke', '[joke] :method :url :status :from');

// 使用自定义的format
app.use(morgan('joke'));
app.use(function(req, res, next){
 res.send('ok');
});
app.listen(3000);

Führen Sie das Programm aus und besuchen Sie http://127.0.0.1:3000/hello?from=app und http://127.0.0.1 :3000/hello?from=pc

➜ 2016.12.11-advanced-morgan git:(master) ✗ node morgan.token.js
[joke] GET / hello?from=app 200 App
[Witz] GET /favicon.ico 304 -
[Witz] GET /hello?from=pc 200 PC
[Witz] GET /favicon.ico 304 -

Erweiterte Verwendung

Holzschnitt

Eine Online-Anwendung, wenn alle Protokolle im selben gespeichert sind Mit der Zeit wird die Datei sehr groß, was die Leistung beeinträchtigt und die Anzeige erschwert. Zu diesem Zeitpunkt müssen Sie die Protokollsegmentierung verwenden.

Mit dem File-Stream-Rotator-Plug-in kann die Protokollaufteilung einfach durchgeführt werden. Mit Ausnahme des Konfigurationscodes für File-Stream-Rotator ähnelt der Rest dem vorherigen Beispiel, sodass ich hier nicht auf Details eingehen werde.

var FileStreamRotator = require('file-stream-rotator')
var express = require('express')
var fs = require('fs')
var morgan = require('morgan')
var path = require('path')

var app = express()
var logDirectory = path.join(__dirname, 'log')

// ensure log directory exists
fs.existsSync(logDirectory) || fs.mkdirSync(logDirectory)

// create a rotating write stream
var accessLogStream = FileStreamRotator.getStream({
 date_format: 'YYYYMMDD',
 filename: path.join(logDirectory, 'access-%DATE%.log'),
 frequency: 'daily',
 verbose: false
})

// setup the logger
app.use(morgan('combined', {stream: accessLogStream}))

app.get('/', function (req, res) {
 res.send('hello, world!')
})

Protokolle in die Datenbank schreiben

Manchmal haben wir einen solchen Bedarf, auf Protokolle zuzugreifen in die Datenbank geschrieben. Diese Anforderung ist in Protokollsystemen üblich, die Abfragestatistiken in Echtzeit erfordern.

在morgan里该如何实现呢？从文档上，并没有看到适合的扩展接口。于是查阅了下morgan的源码，发现实现起来非常简单。

回顾下之前日志写入本地文件的例子，最关键的两行代码如下。通过stream指定日志的输出流。

var accessLogStream = fs.createWriteStream(path.join(__dirname, 'access.log'), {flags: 'a'});
app.use(morgan('short', {stream: accessLogStream}));

在morgan内部，大致实现是这样的（简化后）。

// opt为配置文件
var stream = opts.stream || process.stdout;
var logString = createLogString(); // 伪代码，根据format、token的定义，生成日志
stream.write(logString);

于是，可以用比较取巧的方式来实现目的：声明一个带write方法的对象，并作为stream配置传入。

var express = require('express');
var app = express();
var morgan = require('morgan');

// 带write方法的对象
var dbStream = {
 write: function(line){
 saveToDatabase(line); // 伪代码，保存到数据库
 }
};

// 将 dbStream 作为 stream 配置项的值
app.use(morgan('short', {stream: dbStream}));
app.use(function(req, res, next){
 res.send('ok');
});

app.listen(3000);

深入剖析

morgan的代码非常简洁，从设计上来说，morgan的生命周期包含：

token定义 --> 日志格式定义 -> 日志格式预编译 --> 请求达到/返回 --> 写日志

其中，token定义、日志格式定义前面已经讲到，这里就只讲下 日志格式预编译 的细节。

跟模板引擎预编译一样，日志格式预编译，也是为了提升性能。源码如下，最关键的代码就是compile(fmt)。

 function getFormatFunction (name) {
 // lookup format
 var fmt = morgan[name] || name || morgan.default

 // return compiled format
 return typeof fmt !== 'function'
 ? compile(fmt)
 : fmt
}

compile()方法的实现细节这里不赘述，着重看下compile(fmt)返回的内容：

var morgan = require('morgan');
var format = morgan['tiny'];
var fn = morgan.compile(format);

console.log(fn.toString());

运行上面程序，输出内容如下，其中tokens其实就是morgan。 

function anonymous(tokens, req, res
/**/) {
 return ""
 + (tokens["method"](req, res, undefined) || "-") + " "
 + (tokens["url"](req, res, undefined) || "-") + " "
 + (tokens["status"](req, res, undefined) || "-") + " "
 + (tokens["res"](req, res, "content-length") || "-") + " - "
 + (tokens["response-time"](req, res, undefined) || "-") + " ms";
}

看下morgan.token()的定义，就很清晰了

function token (name, fn) {
 morgan[name] = fn
 return this
}

上面是我整理给大家的，希望今后会对大家有帮助。

相关文章：

ajax请求之返回数据的顺序问题分析

解决ajax返回验证的时候总是弹出error错误的方法

防止重复发送Ajax请求的解决方案

Das obige ist der detaillierte Inhalt vonExpress-Standardprotokollkomponente nach Morgans Methode. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!