Skip to content

Some proposed enhancements #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Some proposed enhancements #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
51c6861
Optionally include msg.topic in log
michaelblight Aug 17, 2019
349dda0
Update documentation
michaelblight Aug 17, 2019
911bc18
Allow msg.rotateNow=true if rotate configured
michaelblight Aug 24, 2019
546354b
Add timestamp format property
Jul 1, 2020
cf96b84
Merge pull request #1 from consense-consulting/master
michaelblight Dec 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
node_modules
package-lock.json
.idea/
34 changes: 31 additions & 3 deletions flogger.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,14 @@
logname: {value:"",required:true},
logdir: {value:"",required:true},
stamp: {value:"utc"},
stampFormat: {value:"YYYY/MM/DD HH:mm:ss"},
logstyle: {value:"plain"},
logrotate: {value:""},
logcompress: {value:""},
logrotatecount: {value: "5"},
logsize: {value: "1000"}
logsize: {value: "1000"},
logtopic: {value: ""},
logsource: {value: "1"},
},
label: function() {
return this.logname
Expand All @@ -23,6 +26,14 @@
$("#node-config-rotate-row").hide()
}
})

$("#node-config-input-logstyle").change(function() {
if ($(this).val() == "plain") {
$("#node-config-plain-row").show()
} else {
$("#node-config-plain-row").hide()
}
})
},
oneditsave: function() {
if ($("#node-config-input-logrotate").is(':checked')) {
Expand Down Expand Up @@ -50,13 +61,27 @@
<option value="local">Local</option>
</select>
</div>
<div class="form-row">
<label for="node-config-input-stampFormat"><i class="fa fa-clock-o"></i> Timestamp Format</label>
<input type="text" id="node-config-input-stampFormat">
</div>
<div class="form-row">
<label for="node-config-input-logstyle"><i class="fa fa-clock-o"></i> Log Style</label>
<select type="text" id="node-config-input-logstyle" placeholder="Log Style">
<option value="plain">Plain Text</option>
<option value="json">Pure JSON</option>
</select>
</div>
<div class="node-config-plain-row">
<div class="form-row">
<label style="width: auto; margin-left: 20px; margin-right: 10px;" for="node-config-input-logtopic"><i class="fa fa-chevron-right"></i> Incl topic</label>
<input type="checkbox" id="node-config-input-logtopic" style="display: inline-block; width: auto; vertical-align: top;">
</div>
<div class="form-row">
<label style="width: auto; margin-left: 20px; margin-right: 10px;" for="node-config-input-logsource"><i class="fa fa-chevron-right"></i> Incl source</label>
<input type="checkbox" id="node-config-input-logsource" style="display: inline-block; width: auto; vertical-align: top;">
</div>
</div>
<div class="form-row">
<label for="node-config-input-logrotate"><i class="fa fa-repeat"></i> Rotate</label>
<input type="checkbox" id="node-config-input-logrotate" style="display: inline-block; width: auto; vertical-align: top;">
Expand Down Expand Up @@ -93,7 +118,7 @@
inputobject: {value:"payload"},
inputobjectType: {value: 'msg'},
inputmoustache: {value: 'Recieved payload {{payload}} and topic {{topic}}'},
loglevel: {value:"INFO", required: true},
loglevel: {value:"INFO", required: false},
logconfig: {type:"config-log"},
sendpane: {value:""},
},
Expand Down Expand Up @@ -156,6 +181,7 @@
<div class="form-row">
<label for="node-input-loglevel"><i class="fa fa-exclamation"></i> Level</label>
<select type="text" id="node-input-loglevel" placeholder="Log Level">
<option value="">(None)</option>
<option value="ERROR">ERROR</option>
<option value="WARN">WARN</option>
<option value="INFO">INFO</option>
Expand Down Expand Up @@ -220,7 +246,9 @@ <h3>Log Config</h3>To setup flogger
<p>In the <code>Timestamp</code> dropdown you can choose if you want to stamp each log line with
either UTC time, local time or no time at all</p>
<p>In the <code>Log Style</code> dropdown you can choose if you want a normal plain logfile similar
to syslog, or if you want a json logfile similar to NLOG</p>
to syslog, or if you want a json logfile similar to NLOG. If plain, 2 more options are shown:</p>
<p><code>Incl topic</code> Include msg.topic in the log if it exist</p>
<p><code>Incl source</code> Include the source of the message such as "msg.payload".</p>
<p>Check <code>Rotate</code> If you want to do automatic log rotation. If checked 3 more options
are shown:</p>
<p><code>Compress</code> Each rotated logfile will be gzip compressed if checked</p>
Expand Down
37 changes: 24 additions & 13 deletions flogger.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,32 +32,42 @@ module.exports = function(RED) {
}

if (node.logconfig.logstyle == "plain") {
if (node.logconfig.stamp == "none") {
logline = loglevel + " [" + logmessage.var + "] " + logmessage.msg + "\n"
} else {
logline = logTimeStamp + " " + loglevel + " [" + logmessage.var + "] " + logmessage.msg + "\n"
}
timeStamp = (node.logconfig.stamp === 'none' ? '' : logTimeStamp + ' ')
level = (loglevel === '' ? '' : loglevel + ' ')
topic = (node.logconfig.logtopic === true && msg.topic ? msg.topic : '')
source = (node.logconfig.logsource === true ? logmessage.var : '')
topicOrSource = (topic !== '' || source !== '')
topicAndSource = (topic !== '' && source !== '')
bracket1 = (topicOrSource ? '[' : '')
bracket2 = (topicOrSource ? '] ' : '')
separator = (topicAndSource ? ':' : '')

logline = timeStamp + level + bracket1 + topic + separator + source + bracket2 + logmessage.msg + '\n'

} else {
logline = GetJSONMsg(logTimeStamp, loglevel, logmessage.var, logmessage.raw)
}

logfile = node.logfile
if (msg.logfile) logfile = msg.logfile // logfile override via msg object if provided
LogRotate(node, logfile, logline.length)
LogRotate(node, logfile, logline.length, msg.rotateNow)
WriteMsgToFile(node, logfile, logline, logTimeStamp)

node.send(msg); // pass through original message
})
}

RED.nodes.registerType("flogger",FloggerNode)

function FloggerConfigNode(n) {
RED.nodes.createNode(this,n)
this.logdir = n.logdir
this.logname = n.logname
this.stamp = n.stamp
this.stampFormat = n.stampFormat;
this.logstyle = n.logstyle
this.logtopic = n.logtopic
this.logsource = n.logsource

this.logrotate = n.logrotate
this.logcompress = n.logcompress
Expand Down Expand Up @@ -144,13 +154,14 @@ module.exports = function(RED) {
Allowed time formats: none, utc, local
*/
function GetLogTime(node) {
now = new Date()
now = new Date();
const format = node.logconfig.stampFormat||"YYYY/MM/DD HH:mm:ss";
if (node.logconfig.stamp == "none") {
logtime = ""
} else if (node.logconfig.stamp == "utc") {
logtime = moment(now).utc().format("YYYY/MM/DD HH:mm:ss") + "Z"
logtime = moment(now).utc().format(format) + "Z"
} else if (node.logconfig.stamp == "local") {
logtime = moment(now).parseZone().local().format("YYYY/MM/DD HH:mm:ss")
logtime = moment(now).parseZone().local().format(format)
}
return (logtime)
}
Expand Down Expand Up @@ -186,13 +197,13 @@ module.exports = function(RED) {
There will be maximum node.logconfig.rotatecount files in the directory.
If compression is set in node.logconfig.compress then the rotated files will be gzipped
*/
function LogRotate(node, filename, addlength) {
function LogRotate(node, filename, addlength, rotateNow) {
if (node.logconfig.logrotate && filename) {
fullpath = node.logconfig.logdir + "/" + filename
if (fs.existsSync(fullpath)) {
stats = fs.statSync(fullpath)
fileSizeInBytes = stats["size"]
if (fileSizeInBytes + addlength + 1 >= node.logconfig.logsize * 1000 ) {
if ((rotateNow === true) || (fileSizeInBytes + addlength + 1 >= node.logconfig.logsize * 1000 )) {
rotate(fullpath, { count: node.logconfig.logrotatecount, compress: (node.logconfig.logcompress==true)}, function(err) {
if (err) {
node.warn("Could not rotate logfiles: " + err)
Expand Down