Gathering detailed insights and metrics for winston-logzio
Gathering detailed insights and metrics for winston-logzio
Gathering detailed insights and metrics for winston-logzio
Gathering detailed insights and metrics for winston-logzio
a winston transport wrapper for logzio
npm install winston-logzio
Typescript
Module System
Min. Node Version
Node Version
NPM Version
90.8
Supply Chain
96.1
Quality
80.4
Maintenance
100
Vulnerability
99.6
License
JavaScript (100%)
Total Downloads
79,606,296
Last Day
2,303
Last Week
37,407
Last Month
144,185
Last Year
2,468,677
Apache-2.0 License
18 Stars
114 Commits
24 Forks
19 Watchers
21 Branches
38 Contributors
Updated on Dec 25, 2024
Minified
Minified + Gzipped
Latest Version
5.2.0
Package Id
winston-logzio@5.2.0
Unpacked Size
35.91 kB
Size
11.66 kB
File Count
21
NPM Version
10.8.2
Node Version
20.18.1
Published on
Dec 25, 2024
Cumulative downloads
Total Downloads
Last Day
-20.6%
2,303
Compared to previous day
Last Week
2.3%
37,407
Compared to previous week
Last Month
7%
144,185
Compared to previous month
Last Year
-95.2%
2,468,677
Compared to previous year
winston-logzio is a winston plugin and wrapper for the logzio-nodejs appender. With winston-logzio, you can take advantage of the winston logger framework with your Node.js app.
Supports Winston 3, If you want to use Winston 2 - Checkout v1.0.8
1npm install winston-logzio --save
Use the samples in the code block below as a starting point, and replace the sample with a configuration that matches your needs.
To run with Typescript click here.
1const winston = require('winston'); 2const LogzioWinstonTransport = require('winston-logzio'); 3 4const logzioWinstonTransport = new LogzioWinstonTransport({ 5 level: 'info', 6 name: 'winston_logzio', 7 token: '<<SHIPPING-TOKEN>>', 8 host: '<<LISTENER-HOST>>', 9}); 10 11const logger = winston.createLogger({ 12 format: winston.format.simple(), 13 transports: [logzioWinstonTransport], 14}); 15 16logger.log('warn', 'Just a test message');
Replace <<SHIPPING-TOKEN>>
with your own logz.io logs shipping token.
Replace <<LISTENER-HOST>>
with your region’s listener host (for example, listener.logz.io).
For more parameters for LogzioWinstonTransport and configuration options see our docs.
If you do not have a Logz.io account, you can sign up for a free trial here
http
, https
or udp
. Default: http
listener.logz.io
udp
default port is 5050
, for http
is 8070
and 8071
is for https
2000
(2 sec)100
.3
false
@timestamp_nano
Default: false
trace_id
, span_id
, service_name
fields to logs when opentelemetry context is available. Default: true
false
false
to send logs without the user-agent field in the request header. Default:true
. If you want to send data from Firefox browser, set that option to false
.extraFields : { field_1: "val_1", field_2: "val_2" , ... }
.This winston plugin, basically just wraps our nodejs logzio shipper.
If you want to configure the nodejs logger, any parameters sent to winston when initializing the transport
(what is held in the variable LogzioWinstonTransport
in the sample above) will be passed to the logzio nodejs logger itself.
The winston logger by default sends all logs to the console.
You can easily disable this by adding this line to your code :
1winston.remove(winston.transports.Console);
If you don't have a 'tsconfig.json' file start by running:
tsc --init
On your 'tsconfig' file, under 'compilerOptions' make sure you have 'esModuleInterop' flag with the value 'true' or add it this way:
"compilerOptions": {
...
"esModuleInterop": true
}
Code sample:
import winston from 'winston';
import LogzioWinstonTransport from 'winston-logzio';
const logzioWinstonTransport = new LogzioWinstonTransport({
level: 'info',
name: 'winston_logzio',
token: '<<SHIPPING-TOKEN>>',
host: '<<LISTENER-HOST>>',
});
const logger = winston.createLogger({
format: winston.format.simple(),
transports: [logzioWinstonTransport],
});
logger.log('warn', 'Just a test message');
Replace <<SHIPPING-TOKEN>>
with your own logz.io logs shipping token.
Replace <<LISTENER-HOST>>
with your region’s listener host (for example, listener.logz.io).
For more parameters for LogzioWinstonTransport and configuration options see our docs.
For trouble shooting press here.
If you do not have a Logz.io account, you can sign up for a free trial here.
Note: If winston-logzio is used as part of a serverless service (AWS Lambda, Azure Functions, Google Cloud Functions, etc.), add logger.close()
at the end of the run.
This winston plugin, basically just wraps our nodejs logzio shipper.
If you want to configure the nodejs logger, any parameters sent to winston when initializing the transport
(what is held in the variable LogzioWinstonTransport
in the sample above) will be passed to the logzio nodejs logger itself.
The winston logger by default sends all logs to the console.
You can easily disable this by adding this line to your code :
1winston.remove(winston.transports.Console);
To fix errors related to "esModuleInterop" flag make sure you run the relavent 'tsconfig' file. These might help:
tsc <file-name>.ts --esModuleInterop
or
tsc --project tsconfig.json
If you're sending traces with OpenTelemetry instrumentation (auto or manual), you can correlate your logs with the trace context. That way, your logs will have traces data in it, such as service name, span id and trace id (version >= 5.2.0
).
This feature is enabled by default, To disable it, set the AddOtelContext
param in your handler configuration to false
, like in this example:
1const winston = require('winston'); 2const LogzioWinstonTransport = require('winston-logzio'); 3 4const logzioWinstonTransport = new LogzioWinstonTransport({ 5 level: 'info', 6 name: 'winston_logzio', 7 token: '<<SHIPPING-TOKEN>>', 8 host: '<<LISTENER-HOST>>', 9 addOtelCotext: false, 10}); 11 12const logger = winston.createLogger({ 13 format: winston.format.simple(), 14 transports: [logzioWinstonTransport], 15});
1git clone https://github.com/logzio/winston-logzio.git 2cd winston-logzio
1npm install 2npm test
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
Reason
Found 11/16 approved changesets -- score normalized to 6
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
Reason
project is not fuzzed
Details
Reason
16 existing vulnerabilities detected
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Score
Last Scanned on 2025-06-23
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More