moon
/
enigma-bbs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
enigma-bbs/troubleshooting/monitoring-logs.html

2348 lines
21 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/png" sizes="16x16" href="/enigma-bbs/assets/images/favicon-16x16.png">
<link rel="icon" type="image/png" sizes="32x32" href="/enigma-bbs/assets/images/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="32x32" href="/enigma-bbs/assets/images/favicon-32x32.png">
<link rel="stylesheet" href="/enigma-bbs/assets/css/style.css?v=">
<!-- Begin Jekyll SEO tag v2.7.1 -->
<title>Monitoring Logs | ENiGMA½ BBS Software</title>
<meta name="generator" content="Jekyll v4.2.1" />
<meta property="og:title" content="Monitoring Logs" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="Monitoring Logs ENiGMA½ does not produce much to stdout. Logs are produced by Bunyan which outputs each entry as a JSON object." />
<meta property="og:description" content="Monitoring Logs ENiGMA½ does not produce much to stdout. Logs are produced by Bunyan which outputs each entry as a JSON object." />
<meta property="og:site_name" content="ENiGMA½ BBS Software" />
<meta property="og:type" content="article" />
<meta property="article:published_time" content="2022-11-28T04:11:10+00:00" />
<meta name="twitter:card" content="summary" />
<meta property="twitter:title" content="Monitoring Logs" />
<script type="application/ld+json">
{"mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/troubleshooting/monitoring-logs.html"},"description":"Monitoring Logs ENiGMA½ does not produce much to stdout. Logs are produced by Bunyan which outputs each entry as a JSON object.","url":"/enigma-bbs/troubleshooting/monitoring-logs.html","@type":"BlogPosting","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"headline":"Monitoring Logs","dateModified":"2022-11-28T04:11:10+00:00","datePublished":"2022-11-28T04:11:10+00:00","@context":"https://schema.org"}</script>
<!-- End Jekyll SEO tag -->
</head>
<body>
<div id="container">
<div class="sidebar" id="sidebar">
<hr class="mobile-divide" />
<div class="container">
<a href="/enigma-bbs/"><img src="/enigma-bbs/assets/images/enigma-logo.png" class="logo" alt="Enigma logo" /></a>
</div>
<ul>
<li>Installation</li>
<ul>
<li><a href="/enigma-bbs/installation/installation-methods.html">Installation Methods</a></li>
<li><a href="/enigma-bbs/installation/install-script.html">Install Script</a></li>
<li><a href="/enigma-bbs/installation/docker.html">Docker</a></li>
<li><a href="/enigma-bbs/installation/manual.html">Manual Installation</a></li>
<li>OS / Hardware Specific</li>
<ul>
<li><a href="/enigma-bbs/installation/hardware/rpi.html">Raspberry Pi</a></li>
<li><a href="/enigma-bbs/installation/hardware/windows.html">Installation Under Windows</a></li>
</ul>
<li><a href="/enigma-bbs/installation/network.html">Network Setup</a></li>
<li><a href="/enigma-bbs/installation/testing.html">Testing Your Installation</a></li>
<li><a href="/enigma-bbs/installation/production.html">Production Installation</a></li>
</ul>
<li>Configuration</li>
<ul>
<li><a href="/enigma-bbs/configuration/creating-config.html">Creating Initial Config Files</a></li>
<li><a href="/enigma-bbs/configuration/sysop-setup.html">SysOp Setup</a></li>
<li><a href="/enigma-bbs/configuration/config-files.html">Configuration Files</a></li>
<li><a href="/enigma-bbs/configuration/config-hjson.html">System Configuration</a></li>
<li><a href="/enigma-bbs/configuration/hjson.html">HJSON Config Files</a></li>
<li><a href="/enigma-bbs/configuration/menu-hjson.html">Menu HSJON</a></li>
<li><a href="/enigma-bbs/configuration/directory-structure.html">Directory Structure</a></li>
<li><a href="/enigma-bbs/configuration/external-binaries.html">External Support Binaries</a></li>
<li><a href="/enigma-bbs/configuration/archivers.html">Archivers</a></li>
<li><a href="/enigma-bbs/configuration/file-transfer-protocols.html">File Transfer Protocols</a></li>
<li><a href="/enigma-bbs/configuration/email.html">Email</a></li>
<li><a href="/enigma-bbs/configuration/colour-codes.html">Colour Codes</a></li>
<li><a href="/enigma-bbs/configuration/event-scheduler.html">Event Scheduler</a></li>
<li><a href="/enigma-bbs/configuration/acs.html">Access Condition System (ACS)</a></li>
<li><a href="/enigma-bbs/configuration/security.html">Security</a></li>
</ul>
<li>Miscellaneous</li>
<ul>
<li><a href="/enigma-bbs/misc/user-interrupt.html">User Interruptions</a></li>
</ul>
<li>File Base</li>
<ul>
<li><a href="/enigma-bbs/filebase/index.html">About File Areas</a></li>
<li><a href="/enigma-bbs/filebase/first-file-area.html">Configuring a File Base</a></li>
<li><a href="/enigma-bbs/filebase/acs.html">ACS</a></li>
<li><a href="/enigma-bbs/filebase/uploads.html">Uploads</a></li>
<li><a href="/enigma-bbs/filebase/web-access.html">Web Access</a></li>
<li><a href="/enigma-bbs/filebase/tic-support.html">TIC Support</a></li>
<li><a href="/enigma-bbs/filebase/network-mounts-and-symlinks.html">Network Mounts &amp; Symlinks</a></li>
</ul>
<li>Message Areas</li>
<ul>
<li><a href="/enigma-bbs/messageareas/configuring-a-message-area.html">Message Base</a></li>
<li><a href="/enigma-bbs/messageareas/message-networks.html">Message Networks</a></li>
<li><a href="/enigma-bbs/messageareas/bso-import-export.html">BSO Import / Export</a></li>
<li><a href="/enigma-bbs/messageareas/netmail.html">Netmail</a></li>
<li><a href="/enigma-bbs/messageareas/qwk.html">QWK Support</a></li>
<li><a href="/enigma-bbs/messageareas/ftn.html">FidoNet-Style Networks (FTN)</a></li>
</ul>
<li>Art</li>
<ul>
<li><a href="/enigma-bbs/art/general.html">General Art Information</a></li>
<li><a href="/enigma-bbs/art/themes.html">Themes</a></li>
<li><a href="/enigma-bbs/art/mci.html">MCI Codes</a></li>
<li>Views</li>
<ul>
<li><a href="/enigma-bbs/art/views/button_view.html">Button View</a></li>
<li><a href="/enigma-bbs/art/views/edit_text_view.html">Edit Text View</a></li>
<li><a href="/enigma-bbs/art/views/full_menu_view.html">Full Menu View</a></li>
<li><a href="/enigma-bbs/art/views/horizontal_menu_view.html">Horizontal Menu View</a></li>
<li><a href="/enigma-bbs/art/views/mask_edit_text_view.html">Mask Edit Text View</a></li>
<li><a href="/enigma-bbs/art/views/multi_line_edit_text_view.html">Multi Line Edit Text View</a></li>
<li><a href="/enigma-bbs/art/views/spinner_menu_view.html">Spinner Menu View</a></li>
<li><a href="/enigma-bbs/art/views/text_view.html">Text View</a></li>
<li><a href="/enigma-bbs/art/views/toggle_menu_view.html">Toggle Menu View</a></li>
<li><a href="/enigma-bbs/art/views/vertical_menu_view.html">Vertical Menu View</a></li>
</ul>
</ul>
<li>Servers</li>
<ul>
<li>Login Servers</li>
<ul>
<li><a href="/enigma-bbs/servers/loginservers/telnet.html">Telnet Server</a></li>
<li><a href="/enigma-bbs/servers/loginservers/ssh.html">SSH Server</a></li>
<li><a href="/enigma-bbs/servers/loginservers/websocket.html">Web Socket / Web Interface Server</a></li>
</ul>
<li>Content Servers</li>
<ul>
<li><a href="/enigma-bbs/servers/contentservers/web-server.html">Web Server</a></li>
<li><a href="/enigma-bbs/servers/contentservers/gopher.html">Gopher Server</a></li>
<li><a href="/enigma-bbs/servers/contentservers/nntp.html">NNTP Server</a></li>
</ul>
</ul>
<li>Modding</li>
<ul>
<li><a href="/enigma-bbs/modding/local-doors.html">Local Doors</a></li>
<li><a href="/enigma-bbs/modding/door-servers.html">Door Servers</a></li>
<li><a href="/enigma-bbs/modding/telnet-bridge.html">Telnet Bridge</a></li>
<li><a href="/enigma-bbs/modding/existing-mods.html">Existing Mods</a></li>
<li><a href="/enigma-bbs/modding/file-area-list.html">File Area List</a></li>
<li><a href="/enigma-bbs/modding/last-callers.html">Last Callers</a></li>
<li><a href="/enigma-bbs/modding/whos-online.html">Who's Online</a></li>
<li><a href="/enigma-bbs/modding/user-list.html">User List</a></li>
<li><a href="/enigma-bbs/modding/msg-conf-list.html">Message Conference List</a></li>
<li><a href="/enigma-bbs/modding/msg-area-list.html">Message Area List</a></li>
<li><a href="/enigma-bbs/modding/bbs-list.html">BBS List</a></li>
<li><a href="/enigma-bbs/modding/rumorz.html">Rumorz</a></li>
<li><a href="/enigma-bbs/modding/file-transfer-protocol-select.html">File Transfer Protocol Select</a></li>
<li><a href="/enigma-bbs/modding/onelinerz.html">Onelinerz</a></li>
<li><a href="/enigma-bbs/modding/show-art.html">The Show Art Module</a></li>
<li><a href="/enigma-bbs/modding/file-base-download-manager.html">File Base Download Manager</a></li>
<li><a href="/enigma-bbs/modding/file-base-web-download-manager.html">File Base Web Download Manager</a></li>
<li><a href="/enigma-bbs/modding/set-newscan-date.html">Set Newscan Date Module</a></li>
<li><a href="/enigma-bbs/modding/node-msg.html">Node to Node Messaging</a></li>
<li><a href="/enigma-bbs/modding/top-x.html">TopX</a></li>
<li><a href="/enigma-bbs/modding/user-2fa-otp-config.html">2FA/OTP Config</a></li>
<li><a href="/enigma-bbs/modding/autosig-edit.html">Auto Signature Editor</a></li>
<li><a href="/enigma-bbs/modding/menu-modules.html">Menu Modules</a></li>
</ul>
<li>Administration</li>
<ul>
<li><a href="/enigma-bbs/admin/administration.html">Administration</a></li>
</ul>
<li>Modding</li>
<ul>
<li><a href="/enigma-bbs/modding/wfc.html">Waiting For Caller (WFC)</a></li>
</ul>
<li>Administration</li>
<ul>
<li><a href="/enigma-bbs/admin/oputil.html">oputil</a></li>
<li><a href="/enigma-bbs/admin/updating.html">Updating</a></li>
</ul>
<li>Troubleshooting</li>
<ul>
<li class="active-nav">Monitoring Logs</li>
</ul>
</ul>
</div>
<div class="main_area">
<div class="container">
<section id="main_content">
<div class="PageNavigation">
<a class="btn" style="float:left;margin-right: 20px;" href="/enigma-bbs/admin/updating.html">&laquo; Updating</a>
<a href="#sidebar" class="btn menu_button">MENU</a>
<br clear="both" />
</div>
<div class="page">
<h1 class="page-title">Monitoring Logs</h1>
<h2 id="monitoring-logs">Monitoring Logs</h2>
<p>ENiGMA½ does not produce much to stdout. Logs are produced by <a href="https://github.com/trentm/node-bunyan">Bunyan</a> which outputs each entry as a JSON object.</p>
<p>Start by installing bunyan and making it available on your path:</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>npm <span class="nb">install </span>bunyan <span class="nt">-g</span>
</code></pre></div></div>
<p>or via Yarn:</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code>yarn global add bunyan
</code></pre></div></div>
<p>To tail logs in a colorized and pretty format, issue the following command:</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">tail</span> <span class="nt">-F</span> /path/to/enigma-bbs/logs/enigma-bbs.log | bunyan
</code></pre></div></div>
<p>See <code class="language-plaintext highlighter-rouge">bunyan --help</code> for more information on what you can do!</p>
<h3 id="example">Example</h3>
<p>Logs <em>without</em> Bunyan:</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">tail</span> <span class="nt">-F</span> /path/to/enigma-bbs/logs/enigma-bbs.log
<span class="o">{</span><span class="s2">"name"</span>:<span class="s2">"ENiGMA½ BBS"</span>,<span class="s2">"hostname"</span>:<span class="s2">"nu-dev"</span>,<span class="s2">"pid"</span>:25002,<span class="s2">"level"</span>:30,<span class="s2">"eventName"</span>:<span class="s2">"updateFileAreaStats"</span>,<span class="s2">"action"</span>:<span class="o">{</span><span class="s2">"type"</span>:<span class="s2">"method"</span>,<span class="s2">"location"</span>:<span class="s2">"core/file_base_area.js"</span>,<span class="s2">"what"</span>:<span class="s2">"updateAreaStatsScheduledEvent"</span>,<span class="s2">"args"</span>:[]<span class="o">}</span>,<span class="s2">"reason"</span>:<span class="s2">"Schedule"</span>,<span class="s2">"msg"</span>:<span class="s2">"Executing scheduled event action..."</span>,<span class="s2">"time"</span>:<span class="s2">"2018-12-15T16:00:00.001Z"</span>,<span class="s2">"v"</span>:0<span class="o">}</span>
<span class="o">{</span><span class="s2">"name"</span>:<span class="s2">"ENiGMA½ BBS"</span>,<span class="s2">"hostname"</span>:<span class="s2">"nu-dev"</span>,<span class="s2">"pid"</span>:25002,<span class="s2">"level"</span>:30,<span class="s2">"module"</span>:<span class="s2">"FTN BSO"</span>,<span class="s2">"msg"</span>:<span class="s2">"Performing scheduled message import/toss..."</span>,<span class="s2">"time"</span>:<span class="s2">"2018-12-15T16:00:00.002Z"</span>,<span class="s2">"v"</span>:0<span class="o">}</span>
<span class="o">{</span><span class="s2">"name"</span>:<span class="s2">"ENiGMA½ BBS"</span>,<span class="s2">"hostname"</span>:<span class="s2">"nu-dev"</span>,<span class="s2">"pid"</span>:25002,<span class="s2">"level"</span>:30,<span class="s2">"module"</span>:<span class="s2">"FTN BSO"</span>,<span class="s2">"msg"</span>:<span class="s2">"Performing scheduled message import/toss..."</span>,<span class="s2">"time"</span>:<span class="s2">"2018-12-15T16:30:00.008Z"</span>,<span class="s2">"v"</span>:0<span class="o">}</span>
</code></pre></div></div>
<p>Oof!</p>
<p>Logs <em>with</em> Bunyan:</p>
<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nb">tail</span> <span class="nt">-F</span> /path/to/enigma-bbs/logs/enigma-bbs.log | bunyan
<span class="o">[</span>2018-12-15T16:00:00.001Z] INFO: ENiGMA½ BBS/25002 on nu-dev: Executing scheduled event action... <span class="o">(</span><span class="nv">eventName</span><span class="o">=</span>updateFileAreaStats, <span class="nv">reason</span><span class="o">=</span>Schedule<span class="o">)</span>
action: <span class="o">{</span>
<span class="s2">"type"</span>: <span class="s2">"method"</span>,
<span class="s2">"location"</span>: <span class="s2">"core/file_base_area.js"</span>,
<span class="s2">"what"</span>: <span class="s2">"updateAreaStatsScheduledEvent"</span>,
<span class="s2">"args"</span>: <span class="o">[]</span>
<span class="o">}</span>
<span class="o">[</span>2018-12-15T16:00:00.002Z] INFO: ENiGMA½ BBS/25002 on nu-dev: Performing scheduled message import/toss... <span class="o">(</span><span class="nv">module</span><span class="o">=</span><span class="s2">"FTN BSO"</span><span class="o">)</span>
<span class="o">[</span>2018-12-15T16:30:00.008Z] INFO: ENiGMA½ BBS/25002 on nu-dev: Performing scheduled message import/toss... <span class="o">(</span><span class="nv">module</span><span class="o">=</span><span class="s2">"FTN BSO"</span><span class="o">)</span>
</code></pre></div></div>
<p>Much better!</p>
</div>
<div class="PageNavigation">
<a class="btn" style="float:left;margin-right: 20px;" href="/enigma-bbs/admin/updating.html">&laquo; Updating</a>
<br clear="both" />
</div>
</section>
</div>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink