Permalink
Browse files

updated cloudfront collector readme with new format

  • Loading branch information...
Yali Sassoon
Yali Sassoon committed Mar 12, 2013
1 parent 0b4fd41 commit ad0f9acb23cdae4ad2357e3c467f8e05a0a383c7
Showing with 12 additions and 9 deletions.
  1. +12 −9 2-collectors/cloudfront-collector/README.md
@@ -1,20 +1,23 @@
# The Cloudfront collector
-The Cloudfront collector is the simplest SnowPlow collector (because it has no moving parts). For this reason, there is not much source code here! (The only files are the actual tracking pixel served from Cloudfront.)
+## Introduction
-This collector is, however, incredibly robust and scalable, by leveraging Amazon's cloud infrastructure.
+The Cloudfront collector is the simplest SnowPlow collector (because it has no moving parts) and most popular SnowPlow collector. It is incredibly robust and scalable, by leveraging Amazon's cloud infrastructure.
## How it works, in a nutshell
The SnowPlow tracking pixel is served from Cloudfront. The SnowPlow tracker requests the pixel (using a `GET`), and appends the data to be logged in SnowPlow in the query string for the `GET` request. Amazon provides Cloudfront logging: the request (incl. the query string) gets logged to S3 including some additional data provided by Cloudfront. (E.g. requester IP address and URL.) These can then be parsed by the ETL module.
-## Documentation
+## Find out more
-1. [Setting up the Cloudfront collector] [setup]: a step-by-step guide to setting up Cloudfront to use with SnowPlow
-2. [Technical documentation] [tech-docs] include details of the Cloudfront log format
-
-Both sets of documents are published on the [wiki].
+| Technical Docs | Setup Guide | Roadmap & Contributing |
+|-----------------------------|-----------------------|--------------------------------------|
+| ![i1] [techdocs-image] | ![i2] [setup-image] | ![i3] [roadmap-image] |
+| [Technical Docs] [techdocs] | [Setup Guide] [setup] | _coming soon_ |
[setup]: https://github.com/snowplow/snowplow/wiki/Setting-up-the-Cloudfront-collector
-[tech-docs]: https://github.com/snowplow/snowplow/wiki/collectors
-[wiki]: https://github.com/snowplow/snowplow/wiki
+[techdocs]: https://github.com/snowplow/snowplow/wiki/cloudfront-collector
+[wiki]: https://github.com/snowplow/snowplow/wiki
+[techdocs-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/techdocs.png
+[setup-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/setup.png
+[roadmap-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/roadmap.png

0 comments on commit ad0f9ac

Please sign in to comment.