Skip to content

Commit

Permalink
Fix README formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
John Pignata committed Aug 24, 2010
1 parent 15ec711 commit 95bd0a2
Showing 1 changed file with 8 additions and 15 deletions.
23 changes: 8 additions & 15 deletions 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:

Expand All @@ -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:

Expand All @@ -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:

Expand All @@ -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

0 comments on commit 95bd0a2

Please sign in to comment.