From abedee0ce08ed9d573d91887fcd89aa76d5dcce3 Mon Sep 17 00:00:00 2001 From: Chris Cummer Date: Sat, 16 Jun 2018 14:26:52 -0700 Subject: [PATCH] Add documentation for Logging module --- _site/content/posts/modules/logging.md | 54 ++++++ .../hyde-hyde/layouts/partials/sidebar.html | 1 + docs/404.html | 1 + docs/categories/index.html | 1 + docs/index.html | 1 + docs/index.xml | 16 +- .../posts/configuration/attributes/index.html | 1 + docs/posts/configuration/index.html | 1 + docs/posts/configuration/iterm2/index.html | 1 + docs/posts/glossary/index.html | 1 + docs/posts/index.html | 8 + docs/posts/index.xml | 16 +- docs/posts/installation/index.html | 1 + docs/posts/modules/bamboohr/index.html | 1 + docs/posts/modules/circleci/index.html | 1 + docs/posts/modules/clocks/index.html | 1 + docs/posts/modules/cmdrunner/index.html | 1 + .../cryptocurrencies/bittrex/index.html | 1 + .../cryptocurrencies/blockfolio/index.html | 1 + .../cryptocurrencies/cryptolive/index.html | 1 + docs/posts/modules/gcal/index.html | 1 + docs/posts/modules/git/index.html | 1 + docs/posts/modules/github/index.html | 1 + docs/posts/modules/gitlab/index.html | 1 + docs/posts/modules/gspreadsheet/index.html | 1 + docs/posts/modules/index.html | 1 + docs/posts/modules/ipapi/index.html | 1 + docs/posts/modules/ipinfo/index.html | 1 + docs/posts/modules/jenkins/index.html | 1 + docs/posts/modules/jira/index.html | 1 + docs/posts/modules/logging/index.html | 171 ++++++++++++++++++ docs/posts/modules/newrelic/index.html | 1 + docs/posts/modules/opsgenie/index.html | 1 + docs/posts/modules/power/index.html | 1 + docs/posts/modules/prettyweather/index.html | 1 + docs/posts/modules/security/index.html | 1 + docs/posts/modules/textfile/index.html | 1 + docs/posts/modules/todo/index.html | 1 + docs/posts/modules/weather/index.html | 1 + docs/posts/overview/index.html | 1 + docs/sitemap.xml | 9 +- docs/tags/index.html | 1 + 42 files changed, 306 insertions(+), 4 deletions(-) create mode 100644 _site/content/posts/modules/logging.md create mode 100644 docs/posts/modules/logging/index.html diff --git a/_site/content/posts/modules/logging.md b/_site/content/posts/modules/logging.md new file mode 100644 index 00000000..544cd701 --- /dev/null +++ b/_site/content/posts/modules/logging.md @@ -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`
+Determines whether or not this module is executed and if its data displayed onscreen.
+Values: `true`, `false`. + +`position`
+Defines where in the grid this module's widget will be displayed.
+ +`refreshInterval`
+How often, in seconds, this module will update its data.
+Values: A positive integer, `0..n`. diff --git a/_site/themes/hyde-hyde/layouts/partials/sidebar.html b/_site/themes/hyde-hyde/layouts/partials/sidebar.html index a5b24d6a..9c7e92f2 100644 --- a/_site/themes/hyde-hyde/layouts/partials/sidebar.html +++ b/_site/themes/hyde-hyde/layouts/partials/sidebar.html @@ -38,6 +38,7 @@
  • IPInfo
  • Jenkins
  • Jira
    • +
  • Logging
  • New Relic
  • OpsGenie
  • Power
    • diff --git a/docs/404.html b/docs/404.html index 7ce23127..abc09821 100644 --- a/docs/404.html +++ b/docs/404.html @@ -79,6 +79,7 @@
  • IPInfo
  • Jenkins
  • Jira
    • +
  • Logging
  • New Relic
  • OpsGenie
  • Power
    • diff --git a/docs/categories/index.html b/docs/categories/index.html index a0c96c23..959cb245 100644 --- a/docs/categories/index.html +++ b/docs/categories/index.html @@ -81,6 +81,7 @@
  • IPInfo
  • Jenkins
  • Jira
    • +
  • Logging
  • New Relic
  • OpsGenie
  • Power
    • diff --git a/docs/index.html b/docs/index.html index 62d70dbe..99975824 100644 --- a/docs/index.html +++ b/docs/index.html @@ -80,6 +80,7 @@
  • IPInfo
  • Jenkins
  • Jira
    • +
  • Logging
  • New Relic
  • OpsGenie
  • Power
    • diff --git a/docs/index.xml b/docs/index.xml index d5b16ac5..4249f027 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -6,11 +6,25 @@ Recent content on WTF - A Terminal Dashboard Hugo -- gohugo.io en-us - Wed, 13 Jun 2018 09:29:59 -0700 + Sat, 16 Jun 2018 14:22:18 -0700 + + Logging + https://wtfutil.com/posts/modules/logging/ + Sat, 16 Jun 2018 14:22:18 -0700 + + https://wtfutil.com/posts/modules/logging/ + Displays the contents of the WTF log file. +To log to this file in your own modules: +require "github.com/senorprogrammer/wtf/logging" logging.Log("This is a log entry") Source Code wtf/logging/ Required ENV Variables None. +Keyboard Commands Arrow keys scroll through the log file. +Configuration textfile:enabled:trueposition:top:5left:4height:2width:1refreshInterval:1 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false. +position Defines where in the grid this module’s widget will be displayed. + + Blockfolio https://wtfutil.com/posts/modules/cryptocurrencies/blockfolio/ diff --git a/docs/posts/configuration/attributes/index.html b/docs/posts/configuration/attributes/index.html index a7513494..45f00e4b 100644 --- a/docs/posts/configuration/attributes/index.html +++ b/docs/posts/configuration/attributes/index.html @@ -79,6 +79,7 @@
  • IPInfo
  • Jenkins
  • Jira
    • +
  • Logging
  • New Relic
  • OpsGenie
  • Power
    • diff --git a/docs/posts/configuration/index.html b/docs/posts/configuration/index.html index de751889..24262a30 100644 --- a/docs/posts/configuration/index.html +++ b/docs/posts/configuration/index.html @@ -79,6 +79,7 @@
  • IPInfo
  • Jenkins
  • Jira
    • +
  • Logging
  • New Relic
  • OpsGenie
  • Power
    • diff --git a/docs/posts/configuration/iterm2/index.html b/docs/posts/configuration/iterm2/index.html index c240c3db..ad673ae2 100644 --- a/docs/posts/configuration/iterm2/index.html +++ b/docs/posts/configuration/iterm2/index.html @@ -79,6 +79,7 @@
  • IPInfo
  • Jenkins
  • Jira
    • +
  • Logging
  • New Relic
  • OpsGenie
  • Power
    • diff --git a/docs/posts/glossary/index.html b/docs/posts/glossary/index.html index 192fde00..67d7d7f9 100644 --- a/docs/posts/glossary/index.html +++ b/docs/posts/glossary/index.html @@ -79,6 +79,7 @@
  • IPInfo
  • Jenkins
  • Jira
    • +
  • Logging
  • New Relic
  • OpsGenie
  • Power
    • diff --git a/docs/posts/index.html b/docs/posts/index.html index b7b08c55..f7df2293 100644 --- a/docs/posts/index.html +++ b/docs/posts/index.html @@ -81,6 +81,7 @@
  • IPInfo
  • Jenkins
  • Jira
    • +
  • Logging
  • New Relic
  • OpsGenie
  • Power
    • @@ -105,6 +106,13 @@

    Posts

    • + + Logging + + + + +
    • Blockfolio diff --git a/docs/posts/index.xml b/docs/posts/index.xml index 82b0045a..5c85acd5 100644 --- a/docs/posts/index.xml +++ b/docs/posts/index.xml @@ -6,11 +6,25 @@ Recent content in Posts on WTF - A Terminal Dashboard Hugo -- gohugo.io en-us - Wed, 13 Jun 2018 09:29:59 -0700 + Sat, 16 Jun 2018 14:22:18 -0700 + + Logging + https://wtfutil.com/posts/modules/logging/ + Sat, 16 Jun 2018 14:22:18 -0700 + + https://wtfutil.com/posts/modules/logging/ + Displays the contents of the WTF log file. +To log to this file in your own modules: +require "github.com/senorprogrammer/wtf/logging" logging.Log("This is a log entry") Source Code wtf/logging/ Required ENV Variables None. +Keyboard Commands Arrow keys scroll through the log file. +Configuration textfile:enabled:trueposition:top:5left:4height:2width:1refreshInterval:1 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false. +position Defines where in the grid this module’s widget will be displayed. + + Blockfolio https://wtfutil.com/posts/modules/cryptocurrencies/blockfolio/ diff --git a/docs/posts/installation/index.html b/docs/posts/installation/index.html index 7f06e343..6d389122 100644 --- a/docs/posts/installation/index.html +++ b/docs/posts/installation/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/bamboohr/index.html b/docs/posts/modules/bamboohr/index.html index e5d9613e..45cbb7c8 100644 --- a/docs/posts/modules/bamboohr/index.html +++ b/docs/posts/modules/bamboohr/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/circleci/index.html b/docs/posts/modules/circleci/index.html index ba519853..665c3486 100644 --- a/docs/posts/modules/circleci/index.html +++ b/docs/posts/modules/circleci/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/clocks/index.html b/docs/posts/modules/clocks/index.html index 08f316a5..a72f5d4e 100644 --- a/docs/posts/modules/clocks/index.html +++ b/docs/posts/modules/clocks/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/cmdrunner/index.html b/docs/posts/modules/cmdrunner/index.html index 880401b3..dd014aa4 100644 --- a/docs/posts/modules/cmdrunner/index.html +++ b/docs/posts/modules/cmdrunner/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/cryptocurrencies/bittrex/index.html b/docs/posts/modules/cryptocurrencies/bittrex/index.html index d4bcabef..9a71e071 100644 --- a/docs/posts/modules/cryptocurrencies/bittrex/index.html +++ b/docs/posts/modules/cryptocurrencies/bittrex/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/cryptocurrencies/blockfolio/index.html b/docs/posts/modules/cryptocurrencies/blockfolio/index.html index 387ef88b..26653c38 100644 --- a/docs/posts/modules/cryptocurrencies/blockfolio/index.html +++ b/docs/posts/modules/cryptocurrencies/blockfolio/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/cryptocurrencies/cryptolive/index.html b/docs/posts/modules/cryptocurrencies/cryptolive/index.html index abbbeab4..c187ed6e 100644 --- a/docs/posts/modules/cryptocurrencies/cryptolive/index.html +++ b/docs/posts/modules/cryptocurrencies/cryptolive/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/gcal/index.html b/docs/posts/modules/gcal/index.html index efcfb948..f849337b 100644 --- a/docs/posts/modules/gcal/index.html +++ b/docs/posts/modules/gcal/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/git/index.html b/docs/posts/modules/git/index.html index ddc9736b..3829d892 100644 --- a/docs/posts/modules/git/index.html +++ b/docs/posts/modules/git/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/github/index.html b/docs/posts/modules/github/index.html index c3c90345..bfe3888b 100644 --- a/docs/posts/modules/github/index.html +++ b/docs/posts/modules/github/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/gitlab/index.html b/docs/posts/modules/gitlab/index.html index 5da8c1ef..4bb6912e 100644 --- a/docs/posts/modules/gitlab/index.html +++ b/docs/posts/modules/gitlab/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/gspreadsheet/index.html b/docs/posts/modules/gspreadsheet/index.html index 17e5e82c..ae4be0af 100644 --- a/docs/posts/modules/gspreadsheet/index.html +++ b/docs/posts/modules/gspreadsheet/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/index.html b/docs/posts/modules/index.html index da012a25..8437db77 100644 --- a/docs/posts/modules/index.html +++ b/docs/posts/modules/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/ipapi/index.html b/docs/posts/modules/ipapi/index.html index a4ed8f11..ccabe254 100644 --- a/docs/posts/modules/ipapi/index.html +++ b/docs/posts/modules/ipapi/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/ipinfo/index.html b/docs/posts/modules/ipinfo/index.html index ccb0f4e5..1759df89 100644 --- a/docs/posts/modules/ipinfo/index.html +++ b/docs/posts/modules/ipinfo/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/jenkins/index.html b/docs/posts/modules/jenkins/index.html index 561b0108..83ba6b2c 100644 --- a/docs/posts/modules/jenkins/index.html +++ b/docs/posts/modules/jenkins/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/jira/index.html b/docs/posts/modules/jira/index.html index aa8d189b..129089e5 100644 --- a/docs/posts/modules/jira/index.html +++ b/docs/posts/modules/jira/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/logging/index.html b/docs/posts/modules/logging/index.html new file mode 100644 index 00000000..50587fa2 --- /dev/null +++ b/docs/posts/modules/logging/index.html @@ -0,0 +1,171 @@ + + + + + + + + + + + + +Logging | WTF - A Terminal Dashboard + + + + + + + + + + + + + + + + + + + + + + + + + +
      +
      +
      + + WFT Logo +

      + +

      +
      + + + +

      + © 2018 Chris Cummer. +
      + Some Rights Reserved. + +

      +
      +
      + +
      +
      +

      Logging

      + +
      + + + + Jun 16, 2018 + + + + +
      + +       +
      + + + +

      Displays the contents of the WTF log file.

      + +

      To log to this file in your own modules:

      +
      require "github.com/senorprogrammer/wtf/logging"
+ logging.Log("This is a log entry")
      +

      Source Code

      +
      wtf/logging/
      +

      Required ENV Variables

      + +

      None.

      + +

      Keyboard Commands

      + +

      Arrow keys scroll through the log file.

      + +

      Configuration

      +
      textfile:
+  enabled: true
+  position:
+    top: 5
+    left: 4
+    height: 2
+    width: 1
+  refreshInterval: 1
      +

      Attributes

      + +

      enabled
      +Determines whether or not this module is executed and if its data displayed onscreen.
      +Values: true, false.

      + +

      position
      +Defines where in the grid this module’s widget will be displayed.

      + +

      refreshInterval
      +How often, in seconds, this module will update its data.
      +Values: A positive integer, 0..n.

      + +
      + +
      + + + +
      +
      + + + + diff --git a/docs/posts/modules/newrelic/index.html b/docs/posts/modules/newrelic/index.html index 669c374d..1330419d 100644 --- a/docs/posts/modules/newrelic/index.html +++ b/docs/posts/modules/newrelic/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/opsgenie/index.html b/docs/posts/modules/opsgenie/index.html index 955d28ea..67e5f02f 100644 --- a/docs/posts/modules/opsgenie/index.html +++ b/docs/posts/modules/opsgenie/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/power/index.html b/docs/posts/modules/power/index.html index 4cb003c3..088d69d0 100644 --- a/docs/posts/modules/power/index.html +++ b/docs/posts/modules/power/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/prettyweather/index.html b/docs/posts/modules/prettyweather/index.html index 91b1abe3..703ddad6 100644 --- a/docs/posts/modules/prettyweather/index.html +++ b/docs/posts/modules/prettyweather/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/security/index.html b/docs/posts/modules/security/index.html index 21b12d9b..d53bf968 100644 --- a/docs/posts/modules/security/index.html +++ b/docs/posts/modules/security/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/textfile/index.html b/docs/posts/modules/textfile/index.html index d73fb57d..0f25da96 100644 --- a/docs/posts/modules/textfile/index.html +++ b/docs/posts/modules/textfile/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/todo/index.html b/docs/posts/modules/todo/index.html index 20501206..7cec31de 100644 --- a/docs/posts/modules/todo/index.html +++ b/docs/posts/modules/todo/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/modules/weather/index.html b/docs/posts/modules/weather/index.html index 213ec3cf..4e8af80c 100644 --- a/docs/posts/modules/weather/index.html +++ b/docs/posts/modules/weather/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/posts/overview/index.html b/docs/posts/overview/index.html index bac121e8..05cf5186 100644 --- a/docs/posts/overview/index.html +++ b/docs/posts/overview/index.html @@ -79,6 +79,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power
      • diff --git a/docs/sitemap.xml b/docs/sitemap.xml index dc6caed1..99e7b0f9 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -2,6 +2,11 @@ + + https://wtfutil.com/posts/modules/logging/ + 2018-06-16T14:22:18-07:00 + + https://wtfutil.com/posts/modules/cryptocurrencies/blockfolio/ 2018-06-13T09:29:59-07:00 @@ -164,7 +169,7 @@ https://wtfutil.com/posts/ - 2018-06-13T09:29:59-07:00 + 2018-06-16T14:22:18-07:00 0 @@ -175,7 +180,7 @@ https://wtfutil.com/ - 2018-06-13T09:29:59-07:00 + 2018-06-16T14:22:18-07:00 0 diff --git a/docs/tags/index.html b/docs/tags/index.html index f816472b..9de5bb91 100644 --- a/docs/tags/index.html +++ b/docs/tags/index.html @@ -81,6 +81,7 @@
    • IPInfo
    • Jenkins
    • Jira
      • +
    • Logging
    • New Relic
    • OpsGenie
    • Power