Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 58 lines (37 sloc) 3.189 kb
eda6ad3 Anthony van der Hoorn Github Management - Update - Update to the readme markdown to be more re...
avanderhoorn authored
1 A client side Glimpse into whats going on in your server
2
a7b3b08 Edited README via GitHub
Glimpse authored
3 Overview
4 --------
dafda19 Edited README via GitHub
Glimpse authored
5 At its core Glimpse allows you to debug your Web Service right in the browser. Glimpse allows you to "Glimpse" into what's going on in your web server. In other words what Firebug is to debugging your client side code, Glimpse is to debugging your server within the client.
6
7 Fundamentally Glimpse is made up of 3 different parts, all of which are extensible and customizable for any platform:
96c1a9d Anthony van der Hoorn Github Management - Update - Update to the readme markdown to be more re...
avanderhoorn authored
8
eda6ad3 Anthony van der Hoorn Github Management - Update - Update to the readme markdown to be more re...
avanderhoorn authored
9 * Glimpse Server Module
10 * Glimpse Client Side Viewer
11 * Glimpse Protocol
dafda19 Edited README via GitHub
Glimpse authored
12
13
a7b3b08 Edited README via GitHub
Glimpse authored
14 How it Works
15 ------------
96c1a9d Anthony van der Hoorn Github Management - Update - Update to the readme markdown to be more re...
avanderhoorn authored
16 On the Server:
17
eda6ad3 Anthony van der Hoorn Github Management - Update - Update to the readme markdown to be more re...
avanderhoorn authored
18 1. Server collects all server side information that will aid in debugging (i.e. application settings, routes, session variables, trace data, etc)
19 2. It does this by running through a pipeline of server side data providers that can be dynamically controlled and added to under plugin architecture
20 3. Before the response is send, the server formats this data in accordance with the Glimpse Protocol and serializes it as JSON
21 4. Depending on whether it is a Ajax request or not, the server embeds the JSON in the HTTP Header or in the content of the page
dafda19 Edited README via GitHub
Glimpse authored
22
96c1a9d Anthony van der Hoorn Github Management - Update - Update to the readme markdown to be more re...
avanderhoorn authored
23 On the Client:
24
eda6ad3 Anthony van der Hoorn Github Management - Update - Update to the readme markdown to be more re...
avanderhoorn authored
25 5. Depending on whether it is a Ajax request or not, the picks up the JSON data and to the data set by executing a pipeline of client side data providers that can be dynamically controlled and added to under plugin architecture
26 6. The client side module then dynamically renders a client side UI (similar to Firebug Lite) that lets you view this data
dafda19 Edited README via GitHub
Glimpse authored
27
28 Glimpse can be turned on or off by a series of different mechanistic, but at its core if the Glimpse cookie is present the server will provide the "debug" data - as a security measure, the request for debug data is "authenticated". Via the plugin model, this authentication check can have any logic that is required by the site to ensure that unauthorized users don't have access to sensitive debug data.
29
a7b3b08 Edited README via GitHub
Glimpse authored
30
31 Server Implementations
32 ----------------------
dafda19 Edited README via GitHub
Glimpse authored
33 Given the scope of the project and what it can do, the concept isn't restricted to any one platform. Hence, once mature, Glimpse Server Module will be available on all major web platforms.
34
35 Platforms currently supported:
96c1a9d Anthony van der Hoorn Github Management - Update - Update to the readme markdown to be more re...
avanderhoorn authored
36
eda6ad3 Anthony van der Hoorn Github Management - Update - Update to the readme markdown to be more re...
avanderhoorn authored
37 * ASP.Net Web Forms
38 * ASP.Net MVC
dafda19 Edited README via GitHub
Glimpse authored
39
40 Platforms soon to be supported supported:
96c1a9d Anthony van der Hoorn Github Management - Update - Update to the readme markdown to be more re...
avanderhoorn authored
41
eda6ad3 Anthony van der Hoorn Github Management - Update - Update to the readme markdown to be more re...
avanderhoorn authored
42 * PHP
43 * Ruby on Rails
dafda19 Edited README via GitHub
Glimpse authored
44
45 NOTE - If you would like help develop a Glimpse Server Module for a given platform please let us know.
46
47
a7b3b08 Edited README via GitHub
Glimpse authored
48 Client Implementations
49 ----------------------
dafda19 Edited README via GitHub
Glimpse authored
50 To start with the Glimpse Client Side Viewer is simply a light weight JavaScript "plugin" that understands the Glimpse Protocol and knows how to render the data. From a technology standpoint we currently use jQuery as the client side framework.
51
5cd8636 Edited README via GitHub
Glimpse authored
52 Eventually, we would like to have actual browser plugins that provide richer functionality and experience, but the JavaScript version of the Glimpse Client Side Viewer is surprisingly well featured, intuitive and provides a high fidelity experience. We also hope to have a version for mobile ready soon which customizes the viewing/usage experience when using a mobile device.
dafda19 Edited README via GitHub
Glimpse authored
53
70f27d3 Anthony van der Hoorn Github Management - Update - Update to the readme markdown to be more re...
avanderhoorn authored
54 ![Glimpse Client](/Glimpse/Glimpse/raw/master/Doco/Glimpse.png "Glimpse Client")
dafda19 Edited README via GitHub
Glimpse authored
55
a7b3b08 Edited README via GitHub
Glimpse authored
56 Protocol
d2bb17b Anthony van der Hoorn Github Management - Update - Update to the readme markdown to be more re...
avanderhoorn authored
57 --------
dafda19 Edited README via GitHub
Glimpse authored
58 Details coming soon.
Something went wrong with that request. Please try again.