mirror of
https://github.com/misskey-dev/SyslogPro.git
synced 2025-04-29 02:37:18 +09:00
Updated Readme
This commit is contained in:
Craig Yamato
parent
cb8ec74502
commit
b6a4870f1b
121
README.md
Normal file
121
README.md
Normal file
@ -0,0 +1,121 @@
|
|||||||
|
SyslogPro
|
||||||
|
=========
|
||||||
|
[](https://travis-ci.org/cyamato/SyslogPro)
|
||||||
|
[](https://coveralls.io/github/cyamato/SyslogPro?branch=master)
|
||||||
|
|
||||||
|
|
||||||
|
[Site](https://github.com/cyamato/SyslogPro) |
|
||||||
|
[Docs](https://cyamato.github.io/SyslogPro/) |
|
||||||
|
[Wiki](https://github.com/cyamato/SyslogPro/wiki "Changelog, Roadmap, etc.") |
|
||||||
|
[Code of Conduct](https://js.foundation/community/code-of-conduct)
|
||||||
|
|
||||||
|
A pure Javascript Syslog module with support for RFC3164, RFC5424, IBM LEEF
|
||||||
|
(Log Event Extended Format), and HP CEF (Common Event Format) formatted
|
||||||
|
messages. SyslogPro has transport options for UDP, TCP, and TLS. TLS includes
|
||||||
|
support for Server and Client certificate authorization. For unformatted and
|
||||||
|
RFC messages there is support for Basic and Extended ANSI coloring. RFC5424
|
||||||
|
Structured Data is also included in the module. All 28 standard CEF Extensions
|
||||||
|
are included in the default CEF class. All 45 standard LEEF Attributes are
|
||||||
|
included in the default LEEF class. It is the goal of this project is for
|
||||||
|
every release to offer full code coverage unit testing and documentation.
|
||||||
|
[Please see the full documentation for usage and options:
|
||||||
|
https://cyamato.github.io/SyslogPro/](https://cyamato.github.io/SyslogPro/).
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
```shell
|
||||||
|
npm install --save SyslogPro
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
```js
|
||||||
|
const SyslogPro = require('syslogpro');
|
||||||
|
let syslog = new SyslogPro.Syslog({
|
||||||
|
target: 'localhost',
|
||||||
|
protocol: 'udp',
|
||||||
|
format: 'rfc5424'
|
||||||
|
});
|
||||||
|
syslog.rfc5424.info('My Message');
|
||||||
|
```
|
||||||
|
Optionaly you can create each class or class options to pass to SyslogPro
|
||||||
|
to create formated messages or use directly
|
||||||
|
|
||||||
|
**RFC3164**
|
||||||
|
```js
|
||||||
|
let rfc3164 = new SyslogPro.RFC3164({
|
||||||
|
applacationName: 'MyApp',
|
||||||
|
color: true,
|
||||||
|
extendedColor: true,
|
||||||
|
server: {
|
||||||
|
target: 'myServer.fqdn'
|
||||||
|
}
|
||||||
|
});
|
||||||
|
rfc3164.info('My Message');
|
||||||
|
```
|
||||||
|
|
||||||
|
**RFC5424**
|
||||||
|
```js
|
||||||
|
let rfc5424 = new SyslogPro.RFC5424({
|
||||||
|
applacationName: 'MyApp',
|
||||||
|
timestamp: true,
|
||||||
|
encludeStructuredData: true
|
||||||
|
color: true,
|
||||||
|
extendedColor: true,
|
||||||
|
server: {
|
||||||
|
target: 'myServer.fqdn'
|
||||||
|
}
|
||||||
|
});
|
||||||
|
rfc5424.info('My Message');
|
||||||
|
```
|
||||||
|
|
||||||
|
**LEEF (Log Event Extended Format)**
|
||||||
|
```js
|
||||||
|
let leef = new SyslogPro.LEEF({
|
||||||
|
vendor: 'acme',
|
||||||
|
product: 'doohickey1000',
|
||||||
|
version: 'alpha',
|
||||||
|
eventId: 'hack',
|
||||||
|
attrabutes: {
|
||||||
|
cat: 'CC Databreach'
|
||||||
|
},
|
||||||
|
server: {
|
||||||
|
target: 'myServer.fqdn'
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.send()
|
||||||
|
.then((result) => {})
|
||||||
|
.catch((error) => {
|
||||||
|
console.log(error);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
**CEF (Common Event Format)**
|
||||||
|
```js
|
||||||
|
let cef = new SyslogPro.CEF({
|
||||||
|
deviceVendor: 'acme',
|
||||||
|
deviceProduct: 'doohickey1000',
|
||||||
|
deviceVersion: 'alpha',
|
||||||
|
deviceEventClassId: 'hack',
|
||||||
|
name: 'My Reporting Service',
|
||||||
|
severity: 'High',
|
||||||
|
extensions: {
|
||||||
|
rawEvent: 'CC Databreach'
|
||||||
|
},
|
||||||
|
server: {
|
||||||
|
target: 'myServer.fqdn'
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.send()
|
||||||
|
.then((result) => {})
|
||||||
|
.catch((error) => {
|
||||||
|
console.log(error);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
## Test
|
||||||
|
```shell
|
||||||
|
npm test
|
||||||
|
```
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Please try to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.
|
||||||
24
package.json
24
package.json
@ -16,15 +16,18 @@
|
|||||||
"Common Event Format",
|
"Common Event Format",
|
||||||
"Log Event Extended Format"
|
"Log Event Extended Format"
|
||||||
],
|
],
|
||||||
"repository": {
|
|
||||||
"type": "git",
|
|
||||||
"url": "https://github.com/cyamato/SyslogPro.git"
|
|
||||||
},
|
|
||||||
"author": {
|
"author": {
|
||||||
"name": "Craig Yamato",
|
"name": "Craig Yamato",
|
||||||
"email": "craig.yamato2@gmail.com",
|
"email": "craig.yamato2@gmail.com",
|
||||||
"url": "http://linkedin.com/in/cyamato"
|
"url": "http://linkedin.com/in/cyamato"
|
||||||
},
|
},
|
||||||
|
"maintainers": [
|
||||||
|
{
|
||||||
|
"name": "Craig Yamato",
|
||||||
|
"email": "craig.yamato2@gmail.com",
|
||||||
|
"url": "http://linkedin.com/in/cyamato"
|
||||||
|
}
|
||||||
|
],
|
||||||
"contributors": [
|
"contributors": [
|
||||||
{
|
{
|
||||||
"name": "Craig Yamato",
|
"name": "Craig Yamato",
|
||||||
@ -32,7 +35,20 @@
|
|||||||
"url": "http://linkedin.com/in/cyamato"
|
"url": "http://linkedin.com/in/cyamato"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
|
"homepage": "https://cyamato.github.io/SyslogPro/",
|
||||||
|
"bugs": {
|
||||||
|
"url" : "https://github.com/cyamato/SyslogPro/issues"
|
||||||
|
},
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "https://github.com/cyamato/SyslogPro.git"
|
||||||
|
},
|
||||||
|
"directories": {
|
||||||
|
"doc": "./docs",
|
||||||
|
"example": "./example",
|
||||||
|
"test": "./test"
|
||||||
|
}
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=10.0.0"
|
"node": ">=10.0.0"
|
||||||
|
|||||||
94
readme.md
94
readme.md
@ -1,94 +0,0 @@
|
|||||||
SyslogPro
|
|
||||||
=========
|
|
||||||
[](https://travis-ci.org/cyamato/SyslogPro) [](https://coveralls.io/github/cyamato/SyslogPro?branch=master)
|
|
||||||
|
|
||||||
A pure Javascript Syslog module with support for RFC3164, RFC5424, IBM LEEF (Log Event Extended Format), and HP CEF (Common Event Format) formatted messages. SyslogPro has transport options for UDP, TCP, and TLS. TLS includes support for Server and Client certificate authorization. For unformatted and RFC messages there is support for Basic and Extended ANSI coloring. RFC5424 Structured Data is also included in the module. All 28 standard CEF Extensions are included in the default CEF class. All 45 standard LEEF Attributes are included in the default LEEF class. It is the goal of this project is for every release to offer full code coverage unit testing and documentation. [Please see the full documentation for usage and options: https://cyamato.github.io/SyslogPro/](https://cyamato.github.io/SyslogPro/).
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
`npm install SyslogPro`
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
const SyslogPro = require('syslogpro');
|
|
||||||
|
|
||||||
let syslog = new SyslogPro.Syslog({
|
|
||||||
target: 'localhost',
|
|
||||||
protocol: 'udp',
|
|
||||||
format: 'rfc5424'
|
|
||||||
});
|
|
||||||
|
|
||||||
syslog.rfc5424.info('My Message');
|
|
||||||
|
|
||||||
// Optionaly you can create each class or class options to pass to SyslogPro
|
|
||||||
// to create formated messages or use directly
|
|
||||||
|
|
||||||
let rfc3164 = new SyslogPro.RFC3164({
|
|
||||||
applacationName: 'MyApp',
|
|
||||||
color: true,
|
|
||||||
extendedColor: true,
|
|
||||||
server: {
|
|
||||||
target: 'myServer.fqdn'
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
rfc3164.info('My Message');
|
|
||||||
|
|
||||||
let rfc5424 = new SyslogPro.RFC5424({
|
|
||||||
applacationName: 'MyApp',
|
|
||||||
timestamp: true,
|
|
||||||
encludeStructuredData: true
|
|
||||||
color: true,
|
|
||||||
extendedColor: true,
|
|
||||||
server: {
|
|
||||||
target: 'myServer.fqdn'
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
rfc5424.info('My Message');
|
|
||||||
|
|
||||||
let leef = new SyslogPro.LEEF({
|
|
||||||
vendor: 'acme',
|
|
||||||
product: 'doohickey1000',
|
|
||||||
version: 'alpha',
|
|
||||||
eventId: 'hack',
|
|
||||||
attrabutes: {
|
|
||||||
cat: 'CC Databreach'
|
|
||||||
},
|
|
||||||
server: {
|
|
||||||
target: 'myServer.fqdn'
|
|
||||||
}
|
|
||||||
})
|
|
||||||
.send()
|
|
||||||
.then((result) => {})
|
|
||||||
.catch((error) => {
|
|
||||||
console.log(error);
|
|
||||||
});
|
|
||||||
|
|
||||||
let cef = new SyslogPro.CEF({
|
|
||||||
deviceVendor: 'acme',
|
|
||||||
deviceProduct: 'doohickey1000',
|
|
||||||
deviceVersion: 'alpha',
|
|
||||||
deviceEventClassId: 'hack',
|
|
||||||
name: 'My Reporting Service',
|
|
||||||
severity: 'High',
|
|
||||||
extensions: {
|
|
||||||
rawEvent: 'CC Databreach'
|
|
||||||
},
|
|
||||||
server: {
|
|
||||||
target: 'myServer.fqdn'
|
|
||||||
}
|
|
||||||
})
|
|
||||||
.send()
|
|
||||||
.then((result) => {})
|
|
||||||
.catch((error) => {
|
|
||||||
console.log(error);
|
|
||||||
});
|
|
||||||
|
|
||||||
## Tests
|
|
||||||
|
|
||||||
`npm test`
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Please try to stay close to the Google JS Style Guid, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.
|
|
||||||
Loading…
x
Reference in New Issue
Block a user