mirror of
https://github.com/misskey-dev/SyslogPro.git
synced 2025-04-29 02:37:18 +09:00
161 lines
8.3 KiB
HTML
161 lines
8.3 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<title>Home - Documentation</title>
|
|
|
|
|
|
<script src="scripts/prettify/prettify.js"></script>
|
|
<script src="scripts/prettify/lang-css.js"></script>
|
|
<!--[if lt IE 9]>
|
|
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
<![endif]-->
|
|
<link type="text/css" rel="stylesheet" href="styles/prettify.css">
|
|
<link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
</head>
|
|
<body>
|
|
|
|
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
|
<label for="nav-trigger" class="navicon-button x">
|
|
<div class="navicon"></div>
|
|
</label>
|
|
|
|
<label for="nav-trigger" class="overlay"></label>
|
|
|
|
<nav>
|
|
|
|
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="module-SyslogPro-CEF.html">CEF</a><ul class='methods'><li data-type='method'><a href="module-SyslogPro-CEF.html#buildMessage">buildMessage</a></li><li data-type='method'><a href="module-SyslogPro-CEF.html#send">send</a></li><li data-type='method'><a href="module-SyslogPro-CEF.html#validate">validate</a></li></ul></li><li><a href="module-SyslogPro-LEEF.html">LEEF</a><ul class='methods'><li data-type='method'><a href="module-SyslogPro-LEEF.html#buildMessage">buildMessage</a></li><li data-type='method'><a href="module-SyslogPro-LEEF.html#send">send</a></li></ul></li><li><a href="module-SyslogPro-RFC3164.html">RFC3164</a><ul class='methods'><li data-type='method'><a href="module-SyslogPro-RFC3164.html#alert">alert</a></li><li data-type='method'><a href="module-SyslogPro-RFC3164.html#buildMessage">buildMessage</a></li><li data-type='method'><a href="module-SyslogPro-RFC3164.html#crit">crit</a></li><li data-type='method'><a href="module-SyslogPro-RFC3164.html#critical">critical</a></li><li data-type='method'><a href="module-SyslogPro-RFC3164.html#debug">debug</a></li><li data-type='method'><a href="module-SyslogPro-RFC3164.html#emer">emer</a></li><li data-type='method'><a href="module-SyslogPro-RFC3164.html#emergency">emergency</a></li><li data-type='method'><a href="module-SyslogPro-RFC3164.html#err">err</a></li><li data-type='method'><a href="module-SyslogPro-RFC3164.html#error">error</a></li><li data-type='method'><a href="module-SyslogPro-RFC3164.html#info">info</a></li><li data-type='method'><a href="module-SyslogPro-RFC3164.html#informational">informational</a></li><li data-type='method'><a href="module-SyslogPro-RFC3164.html#log">log</a></li><li data-type='method'><a href="module-SyslogPro-RFC3164.html#note">note</a></li><li data-type='method'><a href="module-SyslogPro-RFC3164.html#notice">notice</a></li><li data-type='method'><a href="module-SyslogPro-RFC3164.html#send">send</a></li><li data-type='method'><a href="module-SyslogPro-RFC3164.html#setColor">setColor</a></li><li data-type='method'><a href="module-SyslogPro-RFC3164.html#warn">warn</a></li><li data-type='method'><a href="module-SyslogPro-RFC3164.html#warning">warning</a></li></ul></li><li><a href="module-SyslogPro-RFC5424.html">RFC5424</a><ul class='methods'><li data-type='method'><a href="module-SyslogPro-RFC5424.html#alert">alert</a></li><li data-type='method'><a href="module-SyslogPro-RFC5424.html#buildMessage">buildMessage</a></li><li data-type='method'><a href="module-SyslogPro-RFC5424.html#crit">crit</a></li><li data-type='method'><a href="module-SyslogPro-RFC5424.html#critical">critical</a></li><li data-type='method'><a href="module-SyslogPro-RFC5424.html#debug">debug</a></li><li data-type='method'><a href="module-SyslogPro-RFC5424.html#emer">emer</a></li><li data-type='method'><a href="module-SyslogPro-RFC5424.html#emergency">emergency</a></li><li data-type='method'><a href="module-SyslogPro-RFC5424.html#err">err</a></li><li data-type='method'><a href="module-SyslogPro-RFC5424.html#error">error</a></li><li data-type='method'><a href="module-SyslogPro-RFC5424.html#info">info</a></li><li data-type='method'><a href="module-SyslogPro-RFC5424.html#informational">informational</a></li><li data-type='method'><a href="module-SyslogPro-RFC5424.html#log">log</a></li><li data-type='method'><a href="module-SyslogPro-RFC5424.html#note">note</a></li><li data-type='method'><a href="module-SyslogPro-RFC5424.html#notice">notice</a></li><li data-type='method'><a href="module-SyslogPro-RFC5424.html#send">send</a></li><li data-type='method'><a href="module-SyslogPro-RFC5424.html#setColor">setColor</a></li><li data-type='method'><a href="module-SyslogPro-RFC5424.html#warn">warn</a></li><li data-type='method'><a href="module-SyslogPro-RFC5424.html#warning">warning</a></li></ul></li><li><a href="module-SyslogPro-Syslog.html">Syslog</a><ul class='methods'><li data-type='method'><a href="module-SyslogPro-Syslog.html#addTlsServerCerts">addTlsServerCerts</a></li><li data-type='method'><a href="module-SyslogPro-Syslog.html#send">send</a></li><li data-type='method'><a href="module-SyslogPro-Syslog.html#tcpMessage">tcpMessage</a></li><li data-type='method'><a href="module-SyslogPro-Syslog.html#tlsMessage">tlsMessage</a></li><li data-type='method'><a href="module-SyslogPro-Syslog.html#udpMessage">udpMessage</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-SyslogPro.html">SyslogPro</a><ul class='methods'><li data-type='method'><a href="module-SyslogPro.html#~rgbToAnsi">rgbToAnsi</a></li></ul></li></ul>
|
|
</nav>
|
|
|
|
<div id="main">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section class="readme">
|
|
<article><h1>SyslogPro</h1><p>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 of UDP, TCP, and TLS. TLS includes
|
|
support for Server and Client certificate authrization. For unformatedm and
|
|
RFC messages there is support for Basic and Extended ANSI coloring. RFC5424
|
|
Strucutred Data is also encluded in the module. All 28 standard CEF Extentions
|
|
are included in the defualt CEF class. All 45 standard LEEF Atrabutes are
|
|
included in the defualt LEEF class. It is the goal of this project is for every
|
|
relase to offer full code covrage unit testing and documentation. Please see
|
|
the full documation for usage and options.</p>
|
|
<h2>Installation</h2><p> <code>npm install SyslogPro</code></p>
|
|
<h2>Usage</h2><pre class="prettyprint source"><code>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);
|
|
});</code></pre><h2>Tests</h2><p> <code>npm test</code></p>
|
|
<h2>Contributing</h2><p>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.</p></article>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<br class="clear">
|
|
|
|
<footer>
|
|
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Sep 24 2018 06:41:35 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
|
</footer>
|
|
|
|
<script>prettyPrint();</script>
|
|
<script src="scripts/linenumber.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |