Skip to content

widgets: enhance Live Log widget #10086

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
Greelan wants to merge 2 commits into
base: master
Choose a base branch
from
Open

widgets: enhance Live Log widget #10086

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7577407
widgets: enhance Live Log widget
Greelan Apr 6, 2026
f358831
Tweak for revised breadcrumb format
Greelan Apr 7, 2026
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
3 changes: 2 additions & 1 deletion src/opnsense/mvc/app/controllers/OPNsense/Diagnostics/Api/LogController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,8 @@ public function __call($name, $arguments)
[$offset, $searchPhrase, $module, $scope, $severities],
[
'Content-Type: text/event-stream',
'Cache-Control: no-cache'
'Cache-Control: no-cache',
'X-Accel-Buffering: no' /* disable nginx reverse proxy buffering for SSE streams to ensure real-time delivery */
],
60 /* XXX */
);
Expand Down
12 changes: 12 additions & 0 deletions src/opnsense/www/js/opnsense_widget_manager.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -809,6 +809,15 @@ class WidgetManager {
$option.append($(`<div><b>${value.title}</b></div>`));
$option.append($select);
break;
case 'text':
let $textInput = $(`<input type="text" class="form-control" id="${value.id}">`);
$textInput.val(config[key] ?? '');
if (value.placeholder) {
$textInput.attr('placeholder', value.placeholder);
}
$option.append($(`<div><b>${value.title}</b></div>`));
$option.append($textInput);
break;
case 'textarea':
let $textarea = $(`<textarea
id="${value.id}"
Expand Down Expand Up @@ -854,6 +863,9 @@ class WidgetManager {
values[key] = value.default;
}
break;
case 'text':
values[key] = $(`#${value.id}`).val() ?? value.default;
break;
case 'textarea':
values[key] = $(`#${value.id}`).val() ?? value.default;
break;
Expand Down
243 changes: 213 additions & 30 deletions src/opnsense/www/js/widgets/LiveLog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,46 +27,229 @@
export default class LiveLog extends BaseTableWidget {
constructor(config) {
super(config);
this.configurable = true;
this._hasData = false;
this._severityLevels = [
'Emergency', 'Alert', 'Critical', 'Error',
'Warning', 'Notice', 'Informational', 'Debug'
];
this._sources = {};
this._logPrefix = '/ui/diagnostics/log/core/';
}

getGridOptions() {
return {
sizeToContent: 650
};
}

getMarkup() {
let $container = $('<div></div>');
let $table = this.createTable('live-log-table', {
headerPosition: 'top',
rotation: 5,
headers: [
this.translations.time,
this.translations.severity,
this.translations.process,
this.translations.message
]
});

let $table = this.createTable('live-log-table', {headerPosition: 'none'});
$container.append($table);
return $container;
}

async _fetchSources() {
const sources = {};
const logFilesLabel = $('a[href$="_LogFiles"]').first().text().trim();
for (const item of [...new MenuSystem().walk()].filter((x) => x.href.startsWith(this._logPrefix))) {
const scope = item.href.slice(this._logPrefix.length).split('/')[0];
const parts = item.breadcrumb().split(': ');
if (parts.length > 2 && parts[parts.length - 2] === logFilesLabel) {
sources[scope] = parts[0] + ': ' + parts[parts.length - 1];
} else {
sources[scope] = parts[0] + ': ' + parts[parts.length - 2];
}
}
this._sources = sources;
return sources;
}

async onMarkupRendered() {
const params = new URLSearchParams({
offset: 10,
searchPhrase: '',
severity: ''
}).toString();

super.openEventSource(`/api/diagnostics/log/core/system/${'live?' + params}`, (event) => {
if (!event) {
super.closeEventSource();
const [, config] = await Promise.all([
this._fetchSources(),
this.getWidgetConfig().then(() => this.config?.widget ?? {})
]);
this._startLog(config);
}

_renderRow(entry) {
const meta = [entry.timestamp, entry.severity, entry.process_name]
.filter(v => v && v !== 'null')
.join(' \u00b7 ');
let $row = $('<span></span>');
$row.append($('<span style="font-size:0.85em;color:#888"></span>').text(meta + ' \u00b7 '));
$row.append($('<span></span>').html(entry.line));
return $row;
}

_defaultSource() {
if (this._sources['system']) return 'system';
const keys = Object.keys(this._sources);
return keys.length > 0 ? keys[0] : null;
}

_startLog(config) {
const source = (config.source && this._sources[config.source])
? config.source
: this._defaultSource();
config.source = source;

if (source === null) {
$(`#link-handle-${this.id}`).hide();
super.updateTable('live-log-table', [[this.translations.noaccess]], 'error');
this.config.callbacks.updateGrid();
return;
}

const lineCount = parseInt(config.lineCount ?? '25', 10);
const severity = config.severity ?? 'Notice';
const searchFilter = config.searchFilter ?? '';
const severityFilter = this._severityLevels
.slice(0, this._severityLevels.indexOf(severity) + 1)
.join(',');

$(`#link-handle-${this.id}`).show().find('a').attr('href', `${this._logPrefix}${source}`);

const sourceLabel = this._sources[source];
const severityLabel = this.translations[`severity${severity.toLowerCase()}`] ?? severity;
const filterHtml = searchFilter
? ` &nbsp;|&nbsp; <b>${this.translations.filterlabel}:</b> ${$('<span>').text(searchFilter).html()}`
: '';
const summary =
`<div style="text-align:center">` +
`<b>${this.translations.sourcelabel}:</b> ${$('<span>').text(sourceLabel).html()} &nbsp;|&nbsp; ` +
`<b>${this.translations.thresholdlabel}:</b> ${severityLabel} &nbsp;|&nbsp; ` +
`<b>${this.translations.lineslabel}:</b> ${lineCount}` +
filterHtml +
`</div>`;

super.updateTable('live-log-table', [[summary]], 'summary');
const $summary = $(`#${this.id}_summary`);

const onEntry = (event) => {
let data;
try {
data = JSON.parse(event.data);
} catch (e) {
this.closeEventSource();
$(`#link-handle-${this.id}`).hide();
$(`#${this.id}_summary`).remove();
super.updateTable('live-log-table', [[this.translations.noaccess]], 'error');
this.config.callbacks.updateGrid();
return;
}

$(`#${this.id}_error`).remove();
$summary.after(
$('<div class="flextable-row"></div>')
.append($('<div class="flex-cell"></div>').append(this._renderRow(data)))
);
const rows = $(`#live-log-table .flextable-row:not(#${this.id}_summary)`);
if (rows.length > lineCount) {
rows.last().remove();
} else {
this.config.callbacks.updateGrid();
}
};

this._onData = (event) => {
if (event.type !== 'message') {
this._hasData = true;
}
if (event.type !== 'log' && this._hasData) {
return;
}
onEntry(event);
};

this.openEventSource(
`/api/diagnostics/log/core/${source}/live?offset=${lineCount}&searchPhrase=${encodeURIComponent(searchFilter)}&severity=${encodeURIComponent(severityFilter)}`,
this._onData
);
}

openEventSource(url, onMessage) {
if (!this._hasData) {
$(`#live-log-table .flextable-row`).each((_, el) => {
if (el.id !== `${this.id}_summary` && el.id !== `${this.id}_error`) $(el).remove();
});
}
super.openEventSource(url, onMessage);
if (this.eventSource) {
this.eventSource.addEventListener('log', this._onData);
this.eventSource.addEventListener('keepalive', this._onData);
this.eventSource.addEventListener('error', () => {
if (!this._hasData && this.eventSource === null) {
$(`#link-handle-${this.id}`).hide();
$(`#${this.id}_summary`).remove();
super.updateTable('live-log-table', [[this.translations.noaccess]], 'error');
this.config.callbacks.updateGrid();
}
});
}
}

onVisibilityChanged(visible) {
if (!visible) {
this._hasData = false;
}
super.onVisibilityChanged(visible);
}

async onWidgetOptionsChanged(options) {
this.closeEventSource();
this.eventSourceRetryCount = 0;
this._hasData = false;
$(`#live-log-table .flextable-row`).remove();
this._startLog(options);
}

const data = JSON.parse(event.data);
super.updateTable('live-log-table', [
[
data.timestamp,
data.severity,
data.process_name,
data.line
]
]);
});
async getWidgetOptions() {
return {
source: {
id: 'source',
title: this.translations.source,
type: 'select',
options: Object.keys(this._sources).length > 0
? Object.entries(this._sources).map(([key, label]) => ({
value: key,
label: label
}))
: [{ value: '', label: this.translations.nosources }],
default: this._defaultSource() ?? ''
},
severity: {
id: 'severity',
title: this.translations.severity,
type: 'select',
options: this._severityLevels.map(s => ({
value: s,
label: this.translations[`severity${s.toLowerCase()}`] ?? s
})),
default: 'Notice'
},
lineCount: {
id: 'lineCount',
title: this.translations.linecount,
type: 'select',
options: [
{ value: '5', label: '5' },
{ value: '10', label: '10' },
{ value: '25', label: '25' },
{ value: '50', label: '50' },
{ value: '100', label: '100' }
],
default: '25'
},
searchFilter: {
id: 'searchFilter',
title: this.translations.searchfilter,
type: 'text',
placeholder: this.translations.searchfilterplaceholder,
default: ''
}
};
}
}
25 changes: 20 additions & 5 deletions src/opnsense/www/js/widgets/Metadata/Core.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,15 +228,30 @@
</monit>
<livelog>
<filename>LiveLog.js</filename>
<link>/ui/diagnostics/log/core/system</link>
<endpoints>
<endpoint>/api/diagnostics/log/core/system/*</endpoint>
</endpoints>
<translations>
<title>Live Log</title>
<time>Time</time>
<severity>Severity</severity>
<process>Process</process>
<message>Message</message>
<noaccess>No access</noaccess>
<nosources>No log sources available</nosources>
<source>Log source</source>
<severity>Severity threshold</severity>
<severityemergency>Emergency</severityemergency>
<severityalert>Alert</severityalert>
<severitycritical>Critical</severitycritical>
<severityerror>Error</severityerror>
<severitywarning>Warning</severitywarning>
<severitynotice>Notice</severitynotice>
<severityinformational>Informational</severityinformational>
<severitydebug>Debug</severitydebug>
<searchfilter>Search filter</searchfilter>
<searchfilterplaceholder>dhcp error</searchfilterplaceholder>
<linecount>Lines to show</linecount>
<sourcelabel>Source</sourcelabel>
<thresholdlabel>Threshold</thresholdlabel>
<lineslabel>Lines</lineslabel>
<filterlabel>Filter</filterlabel>
</translations>
</livelog>
<ipsecleases>
Expand Down