mirror of
				https://github.com/taigrr/wtf
				synced 2025-01-18 04:03:14 -08:00 
			
		
		
		
	
		
			
				
	
	
		
			195 lines
		
	
	
		
			9.6 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
			
		
		
	
	
			195 lines
		
	
	
		
			9.6 KiB
		
	
	
	
		
			HTML
		
	
	
	
	
	
| <!DOCTYPE html>
 | |
| <html lang="en-us" class="wf-firasans-n4-active wf-active">
 | |
| 	<head>
 | |
|     <link href="http://gmpg.org/xfn/11" rel="profile">
 | |
| <meta charset="utf-8">
 | |
| <meta http-equiv="X-UA-Compatible" content="IE=edge">
 | |
| <!-- Enable responsiveness on mobile devices -->
 | |
| <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1">
 | |
| 
 | |
| 
 | |
| <meta name="generator" content="Hugo 0.46" />
 | |
| 
 | |
| <title>Logger | WTF - A Terminal Dashboard</title>
 | |
| <meta content="Logger - WTF - A Terminal Dashboard" property="og:title">
 | |
| <meta content=" - " property="og:description">
 | |
| <!-- CSS -->
 | |
| <link rel="stylesheet" href="//cdn.rawgit.com/milligram/milligram/master/dist/milligram.min.css">
 | |
| <link href="https://fonts.googleapis.com/css?family=Fira+Sans:300,300i,400,400i|Roboto+Mono:300,300i,400,400i" rel="stylesheet">
 | |
| <link rel="stylesheet" href="https://wtfutil.com/css/print.css" media="print">
 | |
| <link rel="stylesheet" href="https://wtfutil.com/css/poole.css">
 | |
| <link rel="stylesheet" href="https://wtfutil.com/css/hyde.css">
 | |
| <link rel="stylesheet" href="https://wtfutil.com/css/syntax.css">
 | |
| <link rel="stylesheet" href="https://wtfutil.com/css/wtf.css">
 | |
| <!-- Font-Awesome -->
 | |
| <script defer src="https://use.fontawesome.com/releases/v5.0.9/js/all.js" integrity="sha384-8iPTk2s/jMVj81dnzb/iFR2sdA7u06vHJyyLlAd4snFpCl/SnyUjRrbdJsw1pGIl" crossorigin="anonymous"></script>
 | |
| 
 | |
| <!-- Customised CSS -->
 | |
| <link rel="stylesheet" href="https://wtfutil.com/css/custom.css">
 | |
| <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
 | |
| <!--[if lt IE 9]>
 | |
| <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
 | |
| <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
 | |
| <![endif]-->
 | |
| <!-- Icons -->
 | |
| <link rel="apple-touch-icon-precomposed" sizes="144x144" href="/apple-touch-icon-144-precomposed.png">
 | |
| <link rel="shortcut icon" href="/favicon.png">
 | |
| 
 | |
| <script async defer src="https://buttons.github.io/buttons.js"></script>
 | |
| 
 | |
| 
 | |
| <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
 | |
| new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
 | |
| j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
 | |
| 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
 | |
| })(window,document,'script','dataLayer','GTM-532RMQJ');</script>
 | |
| 
 | |
| 
 | |
| 	</head>
 | |
|     <body>
 | |
| 
 | |
| <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-532RMQJ"
 | |
| height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
 | |
| 
 | |
|         <div class="sidebar">
 | |
| 	<div class="container">
 | |
| 		<div class="sidebar-about text-center">
 | |
| 			
 | |
|       <a href="https://wtfutil.com/"> <img src="/img/wtf.png" alt="WFT Logo" class="" width=""> </a>
 | |
| 			<p class="lead">
 | |
| 				 
 | |
| 			</p>
 | |
| 		</div>
 | |
| 
 | |
|     <div>
 | |
|       <h3 style="color: white;">Content</h3>
 | |
| 
 | |
|       <ul style="list-style-type: none;">
 | |
|         <li class="sidebar-list-item-1"><a href="/posts/overview/">Overview</a></li>
 | |
|         <li class="sidebar-list-item-1"><a href="/posts/installation/">Installation</a></li>
 | |
|         <li class="sidebar-list-item-1"><a href="/posts/configuration/">Configuration</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/configuration/attributes/">Attributes</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/configuration/iterm2/">iTerm2</a></li>
 | |
|         <li class="sidebar-list-item-1"><a href="https://github.com/senorprogrammer/wtf/releases">Releases</a></li>
 | |
|       </ul>
 | |
| 
 | |
|       <ul style="list-style-type: none;">
 | |
|         <li class="sidebar-list-item-1"><a href="/posts/modules/">Modules</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/bamboohr/">BambooHR</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/cryptocurrencies/bittrex/">Bittrex</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/cryptocurrencies/blockfolio/">Blockfolio</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/circleci/">CircleCI</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/clocks/">Clocks</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/cryptocurrencies/cryptolive/">CryptoLive</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/cmdrunner/">CmdRunner</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/hackernews/">Hacker News</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/gerrit/">Gerrit</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/git/">Git</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/github/">GitHub</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/gitlab/">GitLab</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/gitter/">Gitter</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/gcal/">Google Calendar</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/gspreadsheet">Google Spreadsheet</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/ipapi/">IP-API</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/ipinfo/">IPInfo</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/jenkins/">Jenkins</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/jira/">Jira</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/logger/">Logger</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/newrelic/">New Relic</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/power/">Power</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/prettyweather/">PrettyWeather</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/textfile/">Text File</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/todo/">Todo</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/todoist/">Todoist</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/travisci/">Travis CI</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/trello/">Trello</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/weather/">Weather</a></li>
 | |
|         <li class="sidebar-list-item-2"><a href="/posts/modules/zendesk/">Zendesk</a></li>
 | |
|       </ul>
 | |
|     </div>
 | |
| 
 | |
|     <p class="copyright">
 | |
|       © 2018 Chris Cummer.
 | |
|       <br />
 | |
|       <a href="https://creativecommons.org/licenses/by/4.0">Some Rights Reserved</a>.
 | |
|       
 | |
|     </p>
 | |
| 	</div>
 | |
| </div>
 | |
| 
 | |
|         <div class="content container">
 | |
|             <div class="post">
 | |
|   <h1>Logger</h1>
 | |
|   
 | |
|   <div class="col-sm-12 col-md-12">
 | |
|     <span class="text-left post-date meta">
 | |
|       
 | |
|       
 | |
|         Jun 16, 2018
 | |
|       
 | |
|       
 | |
|       
 | |
|       
 | |
|       <br/>
 | |
|       
 | |
|       </span>
 | |
|   </div>
 | |
|   
 | |
|   
 | |
| 
 | |
| <p>Displays the contents of the WTF log file.</p>
 | |
| 
 | |
| <p>To log to this file in your own modules:</p>
 | |
| <div class="highlight"><pre class="chroma"><code class="language-golang" data-lang="golang"><span class="nx">require</span> <span class="s">"github.com/senorprogrammer/wtf/logger"</span>
 | |
|  <span class="nx">logger</span><span class="p">.</span><span class="nx">Log</span><span class="p">(</span><span class="s">"This is a log entry"</span><span class="p">)</span></code></pre></div>
 | |
| <h2 id="source-code">Source Code</h2>
 | |
| <div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/logger/</code></pre></div>
 | |
| <h2 id="required-env-variables">Required ENV Variables</h2>
 | |
| 
 | |
| <p>None.</p>
 | |
| 
 | |
| <h2 id="keyboard-commands">Keyboard Commands</h2>
 | |
| 
 | |
| <p>Arrow keys scroll through the log file.</p>
 | |
| 
 | |
| <h2 id="configuration">Configuration</h2>
 | |
| <div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">logger<span class="p">:</span><span class="w">
 | |
| </span><span class="w">  </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
 | |
| </span><span class="w">  </span>position<span class="p">:</span><span class="w">
 | |
| </span><span class="w">    </span>top<span class="p">:</span><span class="w"> </span><span class="m">5</span><span class="w">
 | |
| </span><span class="w">    </span>left<span class="p">:</span><span class="w"> </span><span class="m">4</span><span class="w">
 | |
| </span><span class="w">    </span>height<span class="p">:</span><span class="w"> </span><span class="m">2</span><span class="w">
 | |
| </span><span class="w">    </span>width<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
 | |
| </span><span class="w">  </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">1</span></code></pre></div>
 | |
| <h3 id="attributes">Attributes</h3>
 | |
| 
 | |
| <p><code>enabled</code> <br />
 | |
| Determines whether or not this module is executed and if its data displayed onscreen. <br />
 | |
| <strong>Note:</strong> If you’re using logging and logging is <em>disabled</em>, your logs
 | |
| will still be written to file, the widget just won’t be shown onscreen.
 | |
| If you have <code>logger.Log</code> calls in your code, regardless of this setting,
 | |
| they will be written out. <br />
 | |
| Values: <code>true</code>, <code>false</code>.</p>
 | |
| 
 | |
| <p><code>position</code> <br />
 | |
| Defines where in the grid this module’s widget will be displayed. <br /></p>
 | |
| 
 | |
| <p><code>refreshInterval</code> <br />
 | |
| How often, in seconds, this module will update its data. <br />
 | |
| Values: A positive integer, <code>0..n</code>.</p>
 | |
| 
 | |
| </div>
 | |
| 
 | |
|             <div class="footer">
 | |
|                 
 | |
| 
 | |
| 
 | |
|             </div>
 | |
|         </div>
 | |
|         
 | |
|         
 | |
|     </body>
 | |
| </html>
 |