mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
Add documentation for Logging module
This commit is contained in:
54
_site/content/posts/modules/logging.md
Normal file
54
_site/content/posts/modules/logging.md
Normal file
@@ -0,0 +1,54 @@
|
||||
---
|
||||
title: "Logging"
|
||||
date: 2018-06-16T14:22:18-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
Displays the contents of the WTF log file.
|
||||
|
||||
To log to this file in your own modules:
|
||||
|
||||
```golang
|
||||
require "github.com/senorprogrammer/wtf/logging"
|
||||
logging.Log("This is a log entry")
|
||||
```
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/logging/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
Arrow keys scroll through the log file.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
textfile:
|
||||
enabled: true
|
||||
position:
|
||||
top: 5
|
||||
left: 4
|
||||
height: 2
|
||||
width: 1
|
||||
refreshInterval: 1
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`position` <br />
|
||||
Defines where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
@@ -38,6 +38,7 @@
|
||||
<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/logging/">Logging</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>
|
||||
|
||||
Reference in New Issue
Block a user