Added reporter middleware

Signed-off-by: Vishal Rana <[email protected]>

Author: vishr

website/content/middleware/cube.md

@@ -1,5 +1,5 @@
 +++
-date = "2014-09-09"
+title = "Cube Middleware"
 description = "Cube middleware for Echo. It provides HTTP analytics."
 [menu.main]
   name = "Cube"
@@ -26,7 +26,7 @@ import (
 
 ```go
 e := echo.New()
-e.Use(cube.Middleware("<YOUR_API_KEY>"))
+e.Use(cube.Middleware("<ACCOUNT_ID>", "<API_KEY>"))
 ```
 
 ## Custom Configuration
@@ -36,7 +36,8 @@ e.Use(cube.Middleware("<YOUR_API_KEY>"))
 ```go
 e := echo.New()
 e.Use(cube.MiddlewareWithConfig(cube.Config{
-  APIKey: "<YOUR_API_KEY>",
+  AccountID: "<ACCOUNT_ID>",
+  APIKey: "<API_KEY>",
   DispatchInterval: 5 * 60, // 5 minutes
 }))
 ```
@@ -47,13 +48,16 @@ e.Use(cube.MiddlewareWithConfig(cube.Config{
 // Config defines the config for Cube middleware.
 Config struct {
   // Skipper defines a function to skip middleware.
-  Skipper Skipper
+  Skipper middleware.Skipper
 
-  // App ID 
-  AppID string `json:"app_id"`
+  // App ID
+  AppID string
 
-  // App name 
-  AppName string `json:"app_name"`
+  // App name
+  AppName string
+
+  // LabStack Account ID
+  AccountID string `json:"account_id"`
 
   // LabStack API key
   APIKey string `json:"api_key"`
@@ -64,6 +68,7 @@ Config struct {
   // Interval in seconds to dispatch the batch
   DispatchInterval time.Duration `json:"dispatch_interval"`
 
+  // TODO: To be implemented
   ClientLookup string `json:"client_lookup"`
 }
 ```

website/content/middleware/reporter.md

@@ -0,0 +1,98 @@
++++
+title = "Reporter Middleware"
+description = "Reporter middleware for Echo. It provides error reporting using LabStack log service."
+[menu.main]
+  name = "Reporter"
+  parent = "middleware"
++++
+
+
+Reporter provides automatic error reporting and notification using the LabStack platform.
+
+API key: https://labstack.com/signup<br>
+Dashboard access: https://labstack.com/log
+
+> Echo community contribution 
+
+## Dependencies
+
+```go
+import (
+  "github.com/labstack/echo-contrib/reporter"
+)
+```
+
+*Usage*
+
+```go
+e := echo.New()
+e.Use(reporter.Middleware("<ACCOUNT_ID>", "<API_KEY>"))
+```
+
+## Custom Configuration
+
+*Usage*
+
+```go
+e := echo.New()
+e.Use(reporter.MiddlewareWithConfig(reporter.Config{
+  AccountID: "<ACCOUNT_ID>",
+  APIKey: "<API_KEY>",
+  Headers: []string{"User-Agent"}, // Headers to include
+}))
+```
+
+## Configuration
+
+```go
+// Config defines the config for Reporter middleware.
+Config struct {
+  // Skipper defines a function to skip middleware.
+  Skipper middleware.Skipper
+
+  // App ID
+  AppID string
+
+  // App name
+  AppName string
+
+  // LabStack Account ID
+  AccountID string `json:"account_id"`
+
+  // LabStack API key
+  APIKey string `json:"api_key"`
+
+  // Headers to include
+  Headers []string `json:"headers"`
+
+  // TODO: To be implemented
+  ClientLookup string `json:"client_lookup"`
+}
+```
+
+[Learn more](https://labstack.com/docs/log)
+
+*Default Configuration*
+
+```go
+// DefaultConfig is the default Reporter middleware config.
+DefaultConfig = Config{
+  Skipper: middleware.DefaultSkipper,
+}
+```
+
+## Alert Policy
+
+Navigate to https://labstack.com/monitor/new to create an alert policy with the following data:
+
+- Name: <POLICY_NAME>
+- Query String: app_name: <APP_NAME> AND level:FATAL
+- Email: <EMAIL>
+- Message:
+
+```html
+Message: {{ message }}
+Stack Trace: {{ stack_trace }}
+```
+
+> Leave rest of the fields as is.

website/layouts/partials/notice.html

@@ -1,5 +1,10 @@
-<div class="w3-panel w3-pale-green w3-leftbar w3-border-green">
+<!-- <div class="w3-panel w3-pale-green w3-leftbar w3-border-green">
   <p>
     Check out <a href="/middleware/cube">cube middleware</a> for HTTP analytics. Measure server latency, data transfer, discover top endpoints, server errors and much more.
   </p>
+</div> -->
+<div class="w3-panel w3-pale-green w3-leftbar w3-border-green">
+  <p>
+    Check out <a href="/middleware/reporter">reporter middleware</a> for automatic error reporting and notification.
+  </p>
 </div>