fix: update docs (#12)

Author: Rehan van der Merwe

README.md

@@ -7,15 +7,18 @@ This solution was designed for multiple websites with low to moderate traffic. I
 possible, but it is not free. The cost is mostly driven by the ingestion API that saves the data to S3 through a
 Kinesis Firehose.
 
-You can see a LIVE DEMO [HERE](https://demo.serverless-website-analytics.com/).
+You can see a LIVE DEMO [HERE](https://demo.serverless-website-analytics.com/) and read about the simulated traffic
+[here](https://github.com/rehanvdm/serverless-website-analytics/blob/main/docs/DEMO-TRAFFIC.md)
 
 ## Objectives
-- Easy to deploy in your AWS account, any *region
-- The target audience is small to medium websites with low to moderate traffic (less than 10M views)
+- Low frequency of dashboard views
+- The target audience is small to medium website(s) with low to moderate page view traffic (equal or less than 10M views)
 - Lowest possible cost
 - KISS
 - No direct server-side state
 - Low maintenance
+- Easy to deploy in your AWS account, any *region
+- Don't store any Personally Identifiable Information (PII)
 
 The main objective is to keep it simple and the operational cost low, keeping true to "scale to 0" tenants of serverless,
 even if it goes against "best practices".

docs/API.md

@@ -7,15 +7,18 @@ This solution was designed for multiple websites with low to moderate traffic. I
 possible, but it is not free. The cost is mostly driven by the ingestion API that saves the data to S3 through a
 Kinesis Firehose.
 
-You can see a LIVE DEMO [HERE](https://demo.serverless-website-analytics.com/).
+You can see a LIVE DEMO [HERE](https://demo.serverless-website-analytics.com/) and read about the simulated traffic
+[here](https://github.com/rehanvdm/serverless-website-analytics/blob/main/docs/DEMO-TRAFFIC.md)
 
 ## Objectives
-- Easy to deploy in your AWS account, any *region
-- The target audience is small to medium websites with low to moderate traffic (less than 10M views)
+- Low frequency of dashboard views
+- The target audience is small to medium website(s) with low to moderate page view traffic (equal or less than 10M views)
 - Lowest possible cost
 - KISS
 - No direct server-side state
 - Low maintenance
+- Easy to deploy in your AWS account, any *region
+- Don't store any Personally Identifiable Information (PII)
 
 The main objective is to keep it simple and the operational cost low, keeping true to "scale to 0" tenants of serverless,
 even if it goes against "best practices".

docs/DEMO-TRAFFIC.md

@@ -0,0 +1,23 @@
+# Demo Site Traffic
+
+The Demo site traffic consists of simulated data and some real data that comes from the page itself.
+
+At some point the simulated data was generating 100 records every 1 minute 24x7 over three sites. This was to test how Firehose, S3 and
+Athena would handle the load. The firehose buffering was also at 1 minute, this was to force the setup to generate S3
+files every minute.
+
+Since this is a schema on read system, I was particularly interested in seeing the costs associated
+with Athena scanning/doing S3 GET requests and weather it can still produce results in a timely manner. The results were
+very good, the system was able to handle the load and produce results in a timely manner.
+
+But the simulated traffic had to be changed to accommodate the high view rate of the dashboard. The simulated traffic
+was changed instead of optimizing the Athena & S3 section of the system because this problem is only inherit to the
+demo site. Ideally you will not have 10k+ users viewing the dashboard all the time. It would be a select few users
+throughout the day.
+
+The simulated traffic was changed to a burst of 10k records every 1 hour. This reduces the amount of buckets Firehose
+creates and also the amount of files written to S3. This in return reduces the amount of S3 GET requests made by Athena
+when querying the data.
+
+**The system is designed for around 1 to 10 million page views. There is a high traffic demo site available that is
+guarded by authentication. Contact me if you wish to have a look at how this solution performs at scale.**

src/src/frontend/src/views/page_stats/index.vue

@@ -164,12 +164,13 @@ async function refresh()
 <template>
   <el-container class="h100" style="display: flex; justify-content: center">
 
-    <div style="width: 1280px; ">
+    <div style="width: 1280px;">
 
       <el-alert v-if="showDemoBanner" class="demo" type="warning" style="margin-top: 10px; width: 100%" >
         <div style="display: flex; justify-content: space-between; width: 100%">
           <div>
-            This is the open source CDK <a style="font-weight: bold; color: inherit" href="https://github.com/rehanvdm/serverless-website-analytics" target="_blank">serverless-website-analytics</a> demo page, it tracks this page and some simulated traffic.
+            This is the open source CDK <a style="font-weight: bold; color: inherit" href="https://github.com/rehanvdm/serverless-website-analytics" target="_blank">serverless-website-analytics</a>
+            demo page, it tracks this page and some <a style="font-weight: bold; color: inherit" href="https://github.com/rehanvdm/serverless-website-analytics/blob/main/docs/DEMO-TRAFFIC.md" target="_blank">simulated traffic.</a>.
           </div>
           <div>
             <a style="margin-left: 20px" href="https://github.com/rehanvdm/serverless-website-analytics" target="_blank">