From a1692b211f66148a42665eb6f3b4e378eec5d7ee Mon Sep 17 00:00:00 2001
From: Eric Crooks <eric.crooks@gmail.com>
Date: Thu, 26 Dec 2019 23:05:27 -0500
Subject: [PATCH] [cb-#99] working on logging

---
 .../{ => logging}/logging_to_files/app.ts     |  0
 .../logging_to_files/folder_structure.txt     |  0
 .../{ => logging}/logging_to_files/run.sh     |  0
 .../logging_to_the_terminal/app.ts            |  0
 .../folder_structure.txt                      |  0
 .../logging_to_the_terminal/run.sh            |  0
 .../logging_using_log_from_deno_std/app.ts    |  0
 .../logging_using_log_from_deno_std/run.sh    |  0
 .../tutorials/logging/logging_to_files.vue    | 54 ++++++++++++++
 .../logging/logging_to_the_terminal.vue       | 60 ++++++++++++++++
 .../logging_using_log_from_deno_std.vue       | 59 +++++++++++++++
 .../pages/tutorials/logging_to_files.vue      | 10 +--
 .../tutorials/logging_to_the_terminal.vue     | 72 -------------------
 .../logging_using_log_from_deno_std.vue       | 66 -----------------
 docs/src/vue/components/sidebar.vue           |  6 +-
 15 files changed, 181 insertions(+), 146 deletions(-)
 rename docs/src/example_code/tutorials/{ => logging}/logging_to_files/app.ts (100%)
 rename docs/src/example_code/tutorials/{ => logging}/logging_to_files/folder_structure.txt (100%)
 rename docs/src/example_code/tutorials/{ => logging}/logging_to_files/run.sh (100%)
 rename docs/src/example_code/tutorials/{ => logging}/logging_to_the_terminal/app.ts (100%)
 rename docs/src/example_code/tutorials/{ => logging}/logging_to_the_terminal/folder_structure.txt (100%)
 rename docs/src/example_code/tutorials/{ => logging}/logging_to_the_terminal/run.sh (100%)
 rename docs/src/example_code/tutorials/{ => logging}/logging_using_log_from_deno_std/app.ts (100%)
 rename docs/src/example_code/tutorials/{ => logging}/logging_using_log_from_deno_std/run.sh (100%)
 create mode 100644 docs/src/vue/components/pages/tutorials/logging/logging_to_files.vue
 create mode 100644 docs/src/vue/components/pages/tutorials/logging/logging_to_the_terminal.vue
 create mode 100644 docs/src/vue/components/pages/tutorials/logging/logging_using_log_from_deno_std.vue
 delete mode 100644 docs/src/vue/components/pages/tutorials/logging_to_the_terminal.vue
 delete mode 100644 docs/src/vue/components/pages/tutorials/logging_using_log_from_deno_std.vue

diff --git a/docs/src/example_code/tutorials/logging_to_files/app.ts b/docs/src/example_code/tutorials/logging/logging_to_files/app.ts
similarity index 100%
rename from docs/src/example_code/tutorials/logging_to_files/app.ts
rename to docs/src/example_code/tutorials/logging/logging_to_files/app.ts
diff --git a/docs/src/example_code/tutorials/logging_to_files/folder_structure.txt b/docs/src/example_code/tutorials/logging/logging_to_files/folder_structure.txt
similarity index 100%
rename from docs/src/example_code/tutorials/logging_to_files/folder_structure.txt
rename to docs/src/example_code/tutorials/logging/logging_to_files/folder_structure.txt
diff --git a/docs/src/example_code/tutorials/logging_to_files/run.sh b/docs/src/example_code/tutorials/logging/logging_to_files/run.sh
similarity index 100%
rename from docs/src/example_code/tutorials/logging_to_files/run.sh
rename to docs/src/example_code/tutorials/logging/logging_to_files/run.sh
diff --git a/docs/src/example_code/tutorials/logging_to_the_terminal/app.ts b/docs/src/example_code/tutorials/logging/logging_to_the_terminal/app.ts
similarity index 100%
rename from docs/src/example_code/tutorials/logging_to_the_terminal/app.ts
rename to docs/src/example_code/tutorials/logging/logging_to_the_terminal/app.ts
diff --git a/docs/src/example_code/tutorials/logging_to_the_terminal/folder_structure.txt b/docs/src/example_code/tutorials/logging/logging_to_the_terminal/folder_structure.txt
similarity index 100%
rename from docs/src/example_code/tutorials/logging_to_the_terminal/folder_structure.txt
rename to docs/src/example_code/tutorials/logging/logging_to_the_terminal/folder_structure.txt
diff --git a/docs/src/example_code/tutorials/logging_to_the_terminal/run.sh b/docs/src/example_code/tutorials/logging/logging_to_the_terminal/run.sh
similarity index 100%
rename from docs/src/example_code/tutorials/logging_to_the_terminal/run.sh
rename to docs/src/example_code/tutorials/logging/logging_to_the_terminal/run.sh
diff --git a/docs/src/example_code/tutorials/logging_using_log_from_deno_std/app.ts b/docs/src/example_code/tutorials/logging/logging_using_log_from_deno_std/app.ts
similarity index 100%
rename from docs/src/example_code/tutorials/logging_using_log_from_deno_std/app.ts
rename to docs/src/example_code/tutorials/logging/logging_using_log_from_deno_std/app.ts
diff --git a/docs/src/example_code/tutorials/logging_using_log_from_deno_std/run.sh b/docs/src/example_code/tutorials/logging/logging_using_log_from_deno_std/run.sh
similarity index 100%
rename from docs/src/example_code/tutorials/logging_using_log_from_deno_std/run.sh
rename to docs/src/example_code/tutorials/logging/logging_using_log_from_deno_std/run.sh
diff --git a/docs/src/vue/components/pages/tutorials/logging/logging_to_files.vue b/docs/src/vue/components/pages/tutorials/logging/logging_to_files.vue
new file mode 100644
index 000000000..edab7ef3a
--- /dev/null
+++ b/docs/src/vue/components/pages/tutorials/logging/logging_to_files.vue
@@ -0,0 +1,54 @@
+<template lang="pug">
+page-tutorial(
+  :toc="toc"
+)
+  div.row
+    div.col
+      hr
+      h2-hash Before You Get Started
+      ul
+        list-item-download-source-code(:source_code_uri="$route.meta.source_code_uri")
+  div.row
+    div.col
+      hr
+      h2-hash Steps
+      ol
+        li Create your app file.
+          code-block(:data="example_code.app")
+        li Run your app.
+          code-block(:data="example_code.run")
+        li Check the terminal you used to start <code>app.ts</code>. The log messages in <code>HomeResource</code> will be written in the terminal. The other log messages come from the <code>Drash.Http.Server</code> class.
+          code-block-slotted
+            template(v-slot:title) /path/to/your/project/server.log
+            template(v-slot:code)
+              | 2019-04-20 02:54:13.467Z | INFO |  Request received: GET /
+              | 2019-04-20 02:54:13.468Z | DEBUG |  Calling HomeResource.GET() method.
+              | 2019-04-20 02:54:13.468Z | FATAL |  This is a FATAL log message.
+              | 2019-04-20 02:54:13.468Z | ERROR |  This is an ERROR log message
+              | 2019-04-20 02:54:13.468Z | WARN |  This is a WARN log message
+              | 2019-04-20 02:54:13.468Z | INFO |  This is an INFO log message
+              | 2019-04-20 02:54:13.468Z | DEBUG |  This is a DEBUG log message
+              | 2019-04-20 02:54:13.468Z | TRACE |  This is a TRACE log message
+              | 2019-04-20 02:54:13.468Z | INFO |  Sending response. Content-Type: application/json. Status: 200 (OK).
+              | 2019-04-20 02:54:13.485Z | DEBUG |  /favicon.ico requested.
+              | 2019-04-20 02:54:13.485Z | DEBUG |  All future log messages for /favicon.ico will be muted.
+</template>
+
+<script>
+export const resource = {
+  paths: ["/tutorials/logging/logging-to-files"],
+  meta: {
+    title: "Logging: Logging To Files",
+    tutorial_title: "Logging To Files",
+    source_code_uri: "/tutorials/logging/logging_to_files"
+  }
+}
+
+export default {
+  data() {
+    return {
+        example_code: this.$app_data.example_code['/docs/src/example_code/tutorials/logging_to_files']
+    };
+  },
+}
+</script>
diff --git a/docs/src/vue/components/pages/tutorials/logging/logging_to_the_terminal.vue b/docs/src/vue/components/pages/tutorials/logging/logging_to_the_terminal.vue
new file mode 100644
index 000000000..43fb8d568
--- /dev/null
+++ b/docs/src/vue/components/pages/tutorials/logging/logging_to_the_terminal.vue
@@ -0,0 +1,60 @@
+<template lang="pug">
+page-tutorial(
+  :toc="toc"
+)
+  div.row
+    div.col
+      hr
+      h2-hash Before You Get Started
+      list-item-download-source-code(:source_code_uri="$route.meta.source_code_uri")
+  div.row
+    div.col
+      hr
+      h2-hash Steps
+      ol
+        li Create your app file.
+          code-block(:data="example_code.app")
+        li Run your app.
+          code-block(:data="example_code.run")
+        li Check the terminal you used to start <code>app.ts</code>. The log messages in <code>HomeResource</code> will be written in the terminal. The other log messages come from the <code>Drash.Http.Server</code> class.
+          code-block-slotted
+            template(v-slot:title) Terminal
+            template(v-slot:code)
+              | 2019-04-20 02:54:13.467Z | INFO |  Request received: GET /
+              | 2019-04-20 02:54:13.468Z | DEBUG |  Calling HomeResource.GET() method.
+              | 2019-04-20 02:54:13.468Z | FATAL |  This is a FATAL log message.
+              | 2019-04-20 02:54:13.468Z | ERROR |  This is an ERROR log message
+              | 2019-04-20 02:54:13.468Z | WARN |  This is a WARN log message
+              | 2019-04-20 02:54:13.468Z | INFO |  This is an INFO log message
+              | 2019-04-20 02:54:13.468Z | DEBUG |  This is a DEBUG log message
+              | 2019-04-20 02:54:13.468Z | TRACE |  This is a TRACE log message
+              | 2019-04-20 02:54:13.468Z | INFO |  Sending response. Content-Type: application/json. Status: 200 (OK).
+              | 2019-04-20 02:54:13.485Z | DEBUG |  /favicon.ico requested.
+              | 2019-04-20 02:54:13.485Z | DEBUG |  All future log messages for /favicon.ico will be muted.
+</template>
+
+<script>
+export const resource = {
+  paths: ["/tutorials/logging/logging-to-the-terminal"],
+  meta: {
+    title: "Logging: Logging To The Terminal",
+    tutorial_title: "Logging To The Terminal",
+    source_code_uri: "/tutorials/logging/logging_to_the_terminal"
+  },
+  toc: {
+    items: [
+      "Before You Get Started",
+      "Steps",
+      "Verification",
+    ]
+  }
+}
+
+export default {
+  data() {
+    return {
+      example_code: this.$app_data.example_code['/docs/src/example_code/tutorials/logging/logging_to_the_terminal']
+    };
+  },
+}
+</script>
diff --git a/docs/src/vue/components/pages/tutorials/logging/logging_using_log_from_deno_std.vue b/docs/src/vue/components/pages/tutorials/logging/logging_using_log_from_deno_std.vue
new file mode 100644
index 000000000..3fbc4230f
--- /dev/null
+++ b/docs/src/vue/components/pages/tutorials/logging/logging_using_log_from_deno_std.vue
@@ -0,0 +1,59 @@
+<template lang="pug">
+page-tutorial-default
+  div.row
+    div.col
+      hr
+      h2#before-you-get-started Before You Get Started
+      ul
+        li <a href="https://github.com/denoland/deno_std" target="_BLANK">deno_std</a> has a <a href="https://github.com/denoland/deno_std/tree/master/log" target="_BLANK">Log</a> module that is readily available and you can use it as your logger of choice.
+        li Drash uses deno_std v{{ $conf.deno_std_version }}.
+        list-item-download-source-code(:source_code_uri="$route.meta.source_code_uri")
+  div.row
+    div.col
+      hr
+      h2#steps Steps
+      ol
+        li Create your app file.
+          code-block(:data="example_code.app")
+  div.row
+    div.col
+      hr
+      ul
+        li Run your app.
+          code-block(:data="example_code.run")
+        li Enter the following URL in your browser:
+          code-block-slotted(:header="false")
+            template(#code)
+              | localhost:1337
+        li Check the terminal you started your app with and you should see the following output:
+          code-block-slotted
+            template(#title) Terminal
+            template(#code)
+              | Deno server started at localhost:1337.
+              |
+              | INFO Setting a response.
+</template>
+
+<script>
+export const resource = {
+  paths: ["/tutorials/logging/logging-using-log-from-deno-std"],
+  meta: {
+    title: "Logging Using Log From deno_std",
+    source_code_uri: "/tutorials/logging/logging_using_log_from_deno_std"
+  }
+}
+
+export default {
+  data() {
+    return {
+      example_code: this.$app_data.example_code['/docs/src/example_code/tutorials/logging/logging_using_log_from_deno_std'],
+      toc: {
+        items: [
+          "Before You Get Started",
+          "Steps",
+        ]
+      }
+    };
+  },
+}
+</script>
diff --git a/docs/src/vue/components/pages/tutorials/logging_to_files.vue b/docs/src/vue/components/pages/tutorials/logging_to_files.vue
index c99ec3a38..3e1328b2d 100644
--- a/docs/src/vue/components/pages/tutorials/logging_to_files.vue
+++ b/docs/src/vue/components/pages/tutorials/logging_to_files.vue
@@ -3,9 +3,9 @@ page-tutorial-logging(:data="data")
     template(v-slot:steps)
         ol
             li Create your app file.
-                code-block(:data="data.example_code.app")
+                code-block(:data="example_code.app")
             li Run your app.
-                code-block(:data="data.example_code.run")
+                code-block(:data="example_code.run")
             li Check the terminal you used to start <code>app.ts</code>. The log messages in <code>HomeResource</code> will be written in the terminal. The other log messages come from the <code>Drash.Http.Server</code> class.
                 code-block-slotted
                     template(v-slot:title) /path/to/your/project/server.log
@@ -55,11 +55,11 @@ page-tutorial-logging(:data="data")
 
 <script>
 export const resource = {
-    paths: ["/tutorials/logging-to-files"],
+    paths: ["/tutorials/logging/logging-to-files"],
     meta: {
         title: "Logging: Logging To Files",
         tutorial_title: "Logging To Files",
-        source_code_uri: "/tutorials/logging_to_files"
+        source_code_uri: "/tutorials/logging/logging_to_files"
     }
 }
 
@@ -67,7 +67,7 @@ export default {
     data() {
         return {
             data: {
-                example_code: this.$app_data.example_code['/docs/src/example_code/tutorials/logging_to_files']
+                example_code: this.$app_data.example_code['/docs/src/example_code/tutorials/logging/logging_to_files']
             }
         };
     },
diff --git a/docs/src/vue/components/pages/tutorials/logging_to_the_terminal.vue b/docs/src/vue/components/pages/tutorials/logging_to_the_terminal.vue
deleted file mode 100644
index 6be1e9b1f..000000000
--- a/docs/src/vue/components/pages/tutorials/logging_to_the_terminal.vue
+++ /dev/null
@@ -1,72 +0,0 @@
-<template lang="pug">
-page-tutorial-logging(:data="data")
-    template(v-slot:steps)
-        ol
-            li Create your app file.
-                code-block(:data="data.example_code.app")
-            li Run your app.
-                code-block(:data="data.example_code.run")
-            li Check the terminal you used to start <code>app.ts</code>. The log messages in <code>HomeResource</code> will be written in the terminal. The other log messages come from the <code>Drash.Http.Server</code> class.
-                code-block-slotted
-                    template(v-slot:title) Terminal
-                    template(v-slot:code)
-                        | 2019-04-20 02:54:13.467Z | INFO |  Request received: GET /
-                        | 2019-04-20 02:54:13.468Z | DEBUG |  Calling HomeResource.GET() method.
-                        | 2019-04-20 02:54:13.468Z | FATAL |  This is a FATAL log message.
-                        | 2019-04-20 02:54:13.468Z | ERROR |  This is an ERROR log message
-                        | 2019-04-20 02:54:13.468Z | WARN |  This is a WARN log message
-                        | 2019-04-20 02:54:13.468Z | INFO |  This is an INFO log message
-                        | 2019-04-20 02:54:13.468Z | DEBUG |  This is a DEBUG log message
-                        | 2019-04-20 02:54:13.468Z | TRACE |  This is a TRACE log message
-                        | 2019-04-20 02:54:13.468Z | INFO |  Sending response. Content-Type: application/json. Status: 200 (OK).
-                        | 2019-04-20 02:54:13.485Z | DEBUG |  /favicon.ico requested.
-                        | 2019-04-20 02:54:13.485Z | DEBUG |  All future log messages for /favicon.ico will be muted.
-    template(v-slot:what-is-the-code-doing)
-        h3 <code>app.ts</code>
-        ol
-            li Drash is imported so that all subsequent lines in the file have access to the <code>Drash</code> namespace.
-            li A resource class named <code>HomeResource</code> is created.
-                ul
-                    li The path (a.k.a. URI) that <code>HomeResource</code> opens up to clients is <code>/</code> (in the <code>static paths</code> property). This means clients can only access <code>HomeResource</code> through the <code>/</code> URI.
-                    li <code>HomeResource</code> contains a <code>GET()</code> method. This method will handle all <code>GET</code> requests to <code>HomeResource</code>. When a client makes a <code>GET</code> request to <code>HomeResource</code>, log messages will be written to the terminal.
-            li The Drash server is created.
-                ul
-                    li The address for the server is set to <code>localhost:1337</code>. This means the full address to <code>HomeResource</code> is <code>localhost:1337/</code>.
-                    li The default response output is set to <code>application/json</code>. This means all responses from the server will default to the <code>application/json</code> MIME type. By default, Drash servers can handle the following types: <code>text/html</code>, <code>application/json</code>, <code>application/xml</code>, and <code>text/xml</code>. Drash servers can handle more content types, but you have to add that code. Read <a :href="$conf.base_url + '/#/tutorials/adding-content-types'">Adding Content Types</a> for more information.
-                    li The Drash server is given one resource: <code>HomeResource</code>.
-                    li The server's <code>logger</code> config is used to add a <code>Drash.Loggers.ConsoleLogger</code> object.
-                        ul
-                            li The logger is set to be enabled (this option exists so that message output can be turned off during unit tests) when the server runs; and the logger's log message level is <code>all</code>. This means all log messages will be displayed.
-                            li The logger's <code>tag_string</code> config is used to define a tag string that is prepended to the log message. All tags must be surrounded by the left <code>{</code> and the right <code>}</code>.
-                            li Each tag is mapped to a member in the logger's <code>tag_string_fns</code> config. For example, the <code>{datetime}</code> tag will get its data using the <code>datetime()</code> function. The <code>{level}</code> tag is a reserved tag and will always output the level of the current log message being written to the log. If a tag is defined in the <code>tag_string</code> config and can't be mapped to a member in the <code>tag_string_fns</code> config, then the tag will show as its written.
-            li The Drash server's <code>run()</code> method is invoked so that when <code>app.ts</code> is passed to the <code>deno</code> command in the terminal, the Drash server is started.
-        h3 <code>deno</code> (in the terminal)
-        ol
-            li Deno runs <code>app.ts</code> and:
-                ol
-                    li Allows network access via <code>--allow-net</code> flag.
-                    li Allows environment access via <code>--allow-env</code> flag.
-                p The <code>--allow-net</code> flag is added so that the server will work.
-                p The <code>--allow-env</code> flag is added because <code>Drash.Http.Response</code> objects require environment access if they're setup to serve static paths. Serving static paths isn't setup in this tutorial, but the <code>Drash.Http.Response</code> class compiles with the code that requires access to the environment. This means the <code>--allow-env</code> flag is always required.
-</template>
-
-<script>
-export const resource = {
-    paths: ["/tutorials/logging-to-the-terminal"],
-    meta: {
-        title: "Logging: Logging To The Terminal",
-        tutorial_title: "Logging To The Terminal",
-        source_code_uri: "/tutorials/logging_to_the_terminal"
-    }
-}
-
-export default {
-    data() {
-        return {
-            data: {
-                example_code: this.$app_data.example_code['/docs/src/example_code/tutorials/logging_to_the_terminal']
-            }
-        };
-    },
-}
-</script>
diff --git a/docs/src/vue/components/pages/tutorials/logging_using_log_from_deno_std.vue b/docs/src/vue/components/pages/tutorials/logging_using_log_from_deno_std.vue
deleted file mode 100644
index 4e0139e27..000000000
--- a/docs/src/vue/components/pages/tutorials/logging_using_log_from_deno_std.vue
+++ /dev/null
@@ -1,66 +0,0 @@
-<template lang="pug">
-page-tutorial-default(
-    :data="data"
-    :custom="true"
-)
-    template(v-slot:custom)
-        div.row
-            div.col
-                hr
-                h2 Table Of Contents
-                ul-toc(:data="data.toc")
-        div.row
-            div.col
-                hr
-                h2#before-you-get-started Before You Get Started
-                ul
-                    li <a href="https://github.com/denoland/deno_std" target="_BLANK">deno_std</a> has a <a href="https://github.com/denoland/deno_std/tree/master/log" target="_BLANK">Log</a> module that is readily available and you can use it as your logger of choice.
-                    li Drash uses deno_std v{{ $conf.deno_std_version }}.
-                    list-item-download-source-code(:source_code_uri="$route.meta.source_code_uri")
-        div.row
-            div.col
-                hr
-                h2#steps Steps
-                ol
-                    li Create your app file.
-                        code-block(:data="data.example_code.app")
-                    li Start your app.
-                        code-block(:data="data.example_code.run")
-                    li Enter the following URL in your browser:
-                        code-block-slotted(:header="false")
-                            template(#code)
-                                | localhost:1337
-                    li Check the terminal you started your app with and you should see the following output:
-                        code-block-slotted
-                            template(#title) Terminal
-                            template(#code)
-                                | Deno server started at localhost:1337.
-                                |
-                                | INFO Setting a response.
-</template>
-
-<script>
-export const resource = {
-    paths: ["/tutorials/logging-using-log-from-deno-std"],
-    meta: {
-        title: "Logging Using Log From deno_std",
-        source_code_uri: "/tutorials/logging_using_log_from_deno_std"
-    }
-}
-
-export default {
-    data() {
-        return {
-            data: {
-                example_code: this.$app_data.example_code['/docs/src/example_code/tutorials/logging_using_log_from_deno_std'],
-                toc: {
-                    items: [
-                        "Before You Get Started",
-                        "Steps",
-                    ]
-                }
-            }
-        };
-    },
-}
-</script>
diff --git a/docs/src/vue/components/sidebar.vue b/docs/src/vue/components/sidebar.vue
index a10e5b9a1..74b5a9e2e 100644
--- a/docs/src/vue/components/sidebar.vue
+++ b/docs/src/vue/components/sidebar.vue
@@ -42,9 +42,9 @@ div.c-sidebar
                     a(:href="$conf.base_url + '/#/tutorials/middleware/adding-resource-level-middleware'") Adding Resource-Level Middleware
                 a Logging
                 div.l-submenu-1
-                    a(:href="$conf.base_url + '/#/tutorials/logging-to-the-terminal'") Logging To The Terminal
-                    a(:href="$conf.base_url + '/#/tutorials/logging-to-files'") Logging To Files
-                    router-link(href="/tutorials/logging-using-log-from-deno-std") Logging Using Log From deno_std
+                    a(:href="$conf.base_url + '/#/tutorials/logging/logging-to-the-terminal'") Logging To The Terminal
+                    a(:href="$conf.base_url + '/#/tutorials/logging/logging-to-files'") Logging To Files
+                    router-link(href="/tutorials/logging/logging-using-log-from-deno-std") Logging Using Log From deno_std
                 a Misc
                 div.l-submenu-1
                     a(:href="$conf.base_url + '/#/tutorials/adding-global-members'") Adding Global Members