hachiware_server_module_log v1.0.4

hachiware_server_module_log

Log output module of web server package "hachiware_server".

It is a dedicated server module of the web server application "hachiware_server".
To use it, you must first install and configure hachiware_server.

You can install hachiware_server with the following command.

npm i hachiware_server

The server module can be installed with the following npm command.

npm i hachiware_server_module_log

After installation, you will need the hachiware server configuration file. See here for the procedure for using hachiware_server.

# Setting method

Open the configuration file conf/conf.js etc. on the hachiware server and open it. Confirm that hachiware_server_module_log is added in modules.

modules: [
    ...
    "hachiware_server_module_log",
    ...
],

Then specify logs as shown below.
The following is a setting example. Details of the settings will be explained later.

...
logs: {

	// startup write log
	startUp: {
        enable: true,
        path: "logs/startup/startup-{YYYY}.log",
        contents: "[{DATETIME}] {MODE} {HOST}:{PORT} URL= {LISTEN_URI} CONF= {CONF_FILE}",
	},

	// access write log
	access: {
        enable: true,			
        path: "logs/access/access-{YYYY}-{MM}.log",
        contents: "[{DATETIME}] {METHOD} {REQUEST_URL} {REMOTE_IP} {RESPONSE_CODE}",
	},

    // error write log
    error: {
        enable: true,
        path: "logs/error/error-{YYYY}-{MM}.log",
        contents: "[{DATETIME}] {METHOD} {REQUEST_URL} {REMOTE_IP} {RESPONSE_CODE} {ERROR_EXCEPTION} {ERROR_STACK}",
    },
},
...

# Life Cycle

The life cycle of this server module is as follows:

(server listen start)
    |
(request)
    |
load fook access                        <= Output access log.
    |
    ......
        |   * If an error occurs
        |
    load fook error                     <= Output error log.
            |
    error callback action
    ...
    |
    | * Quit the server
    |
(server listen exit)

• "load fook access" executes the access hook of each sserver module.
• "load fook error" executes the error hook of the server module.

# Log output when request is received

If you want to output the log when the request is received by the server, specify access in logs.

logs: {
    ...
    // access write log
    access: {
        enable: true,			
        path: "logs/access/access-{YYYY}-{MM}.log",
        contents: "[{DATETIME}] {METHOD} {REQUEST_URL} {REMOTE_IP} {RESPONSE_CODE}",
	},
    ...
},

# Log output when an error occurs

If you want to output the log when an error occurs in the request from the server, specify error in logs.

logs: {
    ...
    // error write log
    error: {
        enable: true,
        path: "logs/error/error-{YYYY}-{MM}.log",
        contents: "[{DATETIME}] {METHOD} {REQUEST_URL} {REMOTE_IP} {RESPONSE_CODE} {ERROR_EXCEPTION} {ERROR_STACK}",
    },
     ...
},

# Dynamic format placement (DFP)

By embedding the error output path and error content as a short code, log information can be dynamically output to any location.

For example, logs can be divided by month, year, etc., making it easier to organize output logs.
There is no need to prepare the batch program required for log collection.

The shortcodes of each format and their output results are as follows.

hachiware_server_module_log

Log output module of web server package "hachiware_server".

License : MIT License.
Author : Nakatsuji Masato
HP URL : https://hachiware-js.com/
GitHub : https://github.com/masatonakatsuji2021/hachiware_server_module_log
npm : https://www.npmjs.com/package/hachiware_server_module_log