Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Fix README formatting

  • Loading branch information...
commit 95bd0a2b86f509eaa0b97d6c73889d2a1170b870 1 parent 15ec711
John Pignata authored
Showing with 8 additions and 15 deletions.
  1. +8 −15 README.md
View
23 README.md
@@ -1,18 +1,18 @@
-= About
+# About
Middleware for exposing information about a deployed project for use in debugging.
-= Setup
+# Setup
-== Rails
+## Rails
ActionController::Dispatcher.middleware.use E20::Ops::Middleware::RevisionMiddleware, :logger => Rails.logger
ActionController::Dispatcher.middleware.use E20::Ops::Middleware::HostnameMiddleware, :logger => Rails.logger
ActionController::Dispatcher.middleware.use E20::Ops::Middleware::TransactionIdMiddleware, :logger => Rails.logger
-= Usage
+# Usage
-== Revision Middleware
+## Revision Middleware
Revisions can be queried directly by using the /system/revision endpoint:
@@ -33,7 +33,7 @@ The current revision will also be logged upon application start:
$ grep RevisionMiddleware log/production.log
[E20::Ops::Middleware::RevisionMiddleware] Running: fe09f24b4a927b6eab5db66b6a89fe960e2ff03b
-== Hostname Middleware
+## Hostname Middleware
The hostname of the system that processed the request will be passed as an HTTP header:
@@ -48,7 +48,7 @@ The hostname will also be logged upon application start:
$ grep HostnameMiddleware log/production.log
[E20::Ops::Middleware::HostnameMiddleware] Running on: fulton
-== Transaction ID Middleware
+## Transaction ID Middleware
A transaction ID will be logged for each incoming request:
@@ -61,11 +61,4 @@ The transaction ID will also be passed as an HTTP header:
HTTP/1.1 200 OK
Content-Type: text/html; charset=utf-8
Content-Length: 3304
- X-Transaction-Id: 111d3180-91f4-012d-ce1a-549a20d01d99
-
-
-
-
-
-
-
+ X-Transaction-Id: 111d3180-91f4-012d-ce1a-549a20d01d99
Please sign in to comment.
Something went wrong with that request. Please try again.