npmpackage.info

Gathering detailed insights and metrics for @mondomob/winston-splunk-httplogger

@mondomob/winston-splunk-httplogger

A Winston pluggable tranport for Splunks HTTP Event Logger

2.4.0

MIT

JavaScript

195.37 kB

1,284 3.2

Installations

npm install @mondomob/winston-splunk-httplogger

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=8.0

Node Version

14.16.0

NPM Version

6.14.11 Score

65.5

Supply Chain

89.9

Quality

78.1

Maintenance

Vulnerability

97.6

License

Pull Requests

Open

0

Total

112

Closed

19

Merged

93

Issues

Open

0

Total

14

Closed

14

Releases

v3.1.8

Published on 03 Feb 2023

v3.1.7

Published on 05 Jan 2023

v3.1.6

Published on 01 Dec 2022

v3.1.5

Published on 07 Jun 2022

v3.1.4

Published on 07 Jun 2022

v3.1.3

Published on 02 Jun 2022

View all 14 releases

Contributors

Unable to fetch Contributors

View all 8 contributors

Languages

JavaScript

JavaScript (100%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

adrianhall

Download Statistics

Total Downloads

1,284

Last Day

Last Week

Last Month

Last Year

429

GitHub Statistics

15 Stars

155 Commits

22 Forks

5 Watching

1 Branches

8 Contributors

Bundle Size

737.07 kB

Minified

195.37 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

2.4.0

Package Id

@mondomob/winston-splunk-httplogger@2.4.0

Unpacked Size

20.34 kB

Size

5.62 kB

File Count

NPM Version

6.14.11

Node Version

14.16.0

Total Downloads

Cumulative downloads

Total Downloads

1,284

Last day

-50%

Compared to previous day

Last week

-33.3%

Compared to previous week

Last month

85.7%

Compared to previous month

Last year

217.8%

429

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

winston-splunk-httplogger

A Winston transport for logging to Splunk with a HTTP Event Collector.

Compatibility

Winston >= 3.0.0 is required for winston-splunk-httplogger >= 2.0.0. Please use version 1.2.2 for legacy Winston support.

Installation

1npm install --save winston winston-splunk-httplogger

Usage

1var winston = require('winston'),
2    SplunkStreamEvent = require('winston-splunk-httplogger');
3
4var splunkSettings = {
5    token: process.env.SPLUNK_TOKEN,
6    host: process.env.SPLUNK_HOST || 'localhost'
7};
8
9// Now use winston as normal
10var logger = new winston.Logger({
11    transports: [
12        new winston.transports.Console(),
13        new SplunkStreamEvent({ splunk: splunkSettings })
14    ]
15});
16
17logger.info('This is sent to Splunk');

API

splunkTransport = new SplunkStreamEvent(config);

Create a new instance of SplunkStreamEvent. Takes the following configuration:

config: configuration settings for the SplunkStreamEvent instance
config.splunk: the Splunk Logger settings
config.splunk.token: the Splunk HTTP Event Collector token
[config.level=info]: logging level to use, will show up as the severity field of an event
[config.splunk.index=winston-index]: the index for the events sent to Splunk
[config.splunk.source=winston]: the source for the events sent to Splunk
[config.splunk.sourcetype=winston-splunk-logger]: the sourcetype for the events sent to Splunk
[config.splunk.host=localhost]: the Splunk HTTP Event Collector host
[config.splunk.maxRetries=0]: how many times to retry the splunk logger
[config.splunk.port=8088]: the Splunk HTTP Event Collector port
[config.splunk.path=/services/collector/event/1.0]: URL path to use
[config.splunk.protocol=https]: the protocol to use
[config.splunk.url]: URL string to pass to url.parse. This will try to set host, path, protocol, port, url. Any of these values will be overwritten if the corresponding property is set on config
[config.splunk.eventFormatter]: formats events, returning an event as a string, function(message, severity)
[config.batchInterval=0]: automatically flush events after this many milliseconds. When set to a non-positive value, events will be sent one by one. This setting is ignored when non-positive
[config.maxBatchSize=0]: automatically flush events after the size of queued events exceeds this many bytes. This setting is ignored when non-positive
[config.maxBatchCount=1]: automatically flush events after this many events have been queued. Defaults to flush immediately on sending an event. This setting is ignored when non-positive
[config.exitOnError=true]: whether an unexpected request error causes the javascript process to exit. Defaults to true.

Configuring Splunk

Log into your Splunk instance as an Administrator
Go to Settings > Data Inputs
Click on HTTP Event Collector under Local inputs
Click on New Token
Walk through the wizard to configure your new HTTP Event Collector

Splunk will provide you with a token at the end of the wizard. You need to insert that token into the splunk object you use to create the SplunkStreamEvent() object. In the example above, this is done by placing the token in the SPLUNK_TOKEN environment variable.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

7

SAST

Determines if the project uses static code analysis.

4

Security-Policy

Determines if the project has published a security policy.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/adrianhall/winston-splunk-httplogger/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/adrianhall/winston-splunk-httplogger/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/adrianhall/winston-splunk-httplogger/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/adrianhall/winston-splunk-httplogger/codeql-analysis.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pull-request.yaml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/adrianhall/winston-splunk-httplogger/pull-request.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/pull-request.yaml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/adrianhall/winston-splunk-httplogger/pull-request.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/adrianhall/winston-splunk-httplogger/release.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/adrianhall/winston-splunk-httplogger/release.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/adrianhall/winston-splunk-httplogger/release.yaml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yaml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/adrianhall/winston-splunk-httplogger/release.yaml/main?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/pull-request.yaml:20
Warn: npmCommand not pinned by hash: .github/workflows/release.yaml:21
Warn: npmCommand not pinned by hash: .github/workflows/release.yaml:38
Info: 0 out of 10 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 3 npmCommand dependencies pinned

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.2

/10

Last Scanned on 2025-02-03

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

@mondomob/winston-splunk-httplogger

Installations

Developer Guide

No

CommonJS

>=8.0

14.16.0

6.14.11

Score

Pull Requests

0

112

19

93

Issues

0

14

14

Releases

Contributors

Unable to fetch Contributors

Languages

Developer

adrianhall

Download Statistics

GitHub Statistics

Bundle Size

737.07 kB

195.37 kB

Maintainers

Package Meta Information

Total Downloads

1,284

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

winston-splunk-httplogger

Compatibility

Installation

Usage

API

splunkTransport = new SplunkStreamEvent(config);

Configuring Splunk

See Also

10

10

10

7

4

0

0

0

0

0

0

0

0

3.2

/10