api_analytics 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0cf3498f46f29e07b93bc01d2182cd8daa147614c349559d9ed9dbc84515db4
-  data.tar.gz: 1dff19db20f4b033b48dcc867f27b127618185e10a59239f2d3fc894576a4aea
+  metadata.gz: 3e645b37969365ab4362e1638745aa8cd4620eee12faf229e0f7a80ea4487ceb
+  data.tar.gz: 2dda631a1982214b4d1928b5af24ee79a067dfde0b214ecfdd4e7410a6dd1067
 SHA512:
-  metadata.gz: 42b54e3a6ecdeecc5315b8b67b91e26e3d65b55069c1db84d2987e50b72cb2cd58cb028201953ee39613ccfdd9dbc71899c7885daaaebf7cc84350b6517e091c
-  data.tar.gz: d65e324ac5036b3434bd1b71fd7390458e6aa92388e8ce10b0a30a6eb89d422001d07f405fbf0f9296691c1149015f2f7ed15970fbdaeae2ff7be71769532bdc
+  metadata.gz: c345b31b23c7e66a499a30e1cb49db591880186fc82af7aa5caa1b7ea690b0a54ed655e73c5e01d25c36ee5bff2f891813e5ffe0f62d12c946d4a0b0caa41980
+  data.tar.gz: 0c9374687dd5588b5cf8e735d4d4c27f0dfc42e10392ec4d45d6dcc84cff00eac97ad3e10e64f306ef06af89157b667f087c23cb97045efceacbacf0d2601e18

data/README.md

@@ -31,7 +31,7 @@ module RailsMiddleware
     config.load_defaults 6.1
     config.api_only = true
 
-    config.middleware.use ::Analytics::Rails, <api_key> # Add middleware
+    config.middleware.use ::Analytics::Rails, <API-KEY>  # Add middleware
   end
 end
 ```
@@ -42,7 +42,7 @@ end
 require 'sinatra'
 require 'api_analytics'
 
-use Analytics::Sinatra, <api_key>
+use Analytics::Sinatra, <API-KEY>  # Add middleware
 
 before do
     content_type 'application/json'
@@ -55,4 +55,57 @@ end
 
 ### 3. View your analytics
 
-Your API will log requests on all valid routes. Head over to https://my-api-analytics.vercel.app/dashboard and paste in your API key to view your dashboard.
+Your API will now log and store incoming request data on all valid routes. Your logged data can be viewed using two methods: through visualizations and stats on our dashboard, or accessed directly via our data API.
+
+You can use the same API key across multiple APIs, but all your data will appear in the same dashboard. We recommend generating a new API key for each additional API you want analytics for.
+
+#### Dashboard
+
+Head to https://my-api-analytics.vercel.app/dashboard and paste in your API key to access your dashboard.
+
+Demo: https://my-api-analytics.vercel.app/dashboard/demo
+
+![Dashboard](https://user-images.githubusercontent.com/41476809/208440202-966a6930-3d2e-40c5-afc7-2fd0107d6b4f.png)
+
+#### Data API
+
+Logged data for all requests can be accessed via our API. Simply send a GET request to `https://api-analytics-server.vercel.app/api/data` with your API key set as `API-Key` in headers.
+
+```py
+import requests
+
+headers = {
+ "API-Key": <API-KEY>
+}
+
+response = requests.get("https://api-analytics-server.vercel.app/api/data", headers=headers)
+print(response.json())
+```
+
+## Monitoring (coming soon)
+
+Opt-in active API monitoring is coming soon. Our servers will regularly ping your API endpoints to monitor uptime and response time. Optional email alerts to notify you when your endpoints are down can be subscribed to.
+
+![Monitoring](https://user-images.githubusercontent.com/41476809/208298759-f937b668-2d86-43a2-b615-6b7f0b2bc20c.png)
+
+## Data and Security
+
+All data is stored securely in compliance with The EU General Data Protection Regulation (GDPR).
+
+For any given request to your API, data recorded is limited to:
+ - Path requested by client
+ - Client IP address
+ - Client operating system
+ - Client browser
+ - Request method (GET, POST, PUT, etc.)
+ - Time of request
+ - Status code
+ - Response time
+ - API hostname
+ - API framework (FastAPI, Flask, Express etc.)
+
+Data collected is only ever used to populate your analytics dashboard. Your data is anonymous, with the API key the only link between you and you API's analytics. Should you lose your API key, you will have no method to access your API analytics. Inactive API keys (> 1 year) and its associated API request data may be deleted.
+
+### Delete Data
+
+At any time, you can delete all stored data associated with your API key by going to https://my-api-analytics.vercel.app/delete and entering your API key.

data/api_analytics.gemspec

@@ -7,7 +7,6 @@ Gem::Specification.new do |spec|
   spec.version       = Analytics::VERSION
   spec.authors       = ["Tom Draper"]
   spec.email         = ["tomjdraper1@gmail.com"]
-
   spec.summary       = "Monitoring and analytics for API applications."
   spec.description   = "Monitoring and analytics for API applications."
   spec.homepage      = "https://github.com/tom-draper/api-analytics"

data/lib/api_analytics/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Analytics
-  VERSION = "1.0.5"
+  VERSION = "1.1.0"
 end

data/lib/api_analytics.rb

@@ -9,36 +9,56 @@ module Analytics
     def initialize(app, api_key)
       @app = app
       @api_key = api_key
+      @requests = Array.new
+      @last_posted = Time.now
     end
 
     def call(env)
       start = Time.now
       status, headers, response = @app.call(env)
 
-      data = {
-        api_key: @api_key,
+      request_data = {
         hostname: env['HTTP_HOST'],
         ip_address: env['REMOTE_ADDR'],
         path: env['REQUEST_PATH'],
         user_agent: env['HTTP_USER_AGENT'],
         method: env['REQUEST_METHOD'],
         status: status,
-        framework: @framework,
         response_time: (Time.now - start).to_f.round,
+        created_at: Time.now.utc.iso8601
       }
 
-      Thread.new {
-        log_request(data)
-      }
+      log_request(request_data)
 
       [status, headers, response]
     end
-
+    
     private
 
-    def log_request(data)
-      uri = URI('https://api-analytics-server.vercel.app/api/log-request')
-      res = Net::HTTP.post(uri, data.to_json)
+    def post_requests(api_key, requests, framework)
+      payload = {
+        api_key: api_key,
+        requests: requests,
+        framework: framework
+      }
+      uri = URI('http://213.168.248.206/api/log-request')
+      res = Net::HTTP.post(uri, payload.to_json)
+    end
+    
+    def log_request(request_data)
+      if @api_key.empty?
+        return
+      end
+      now = Time.now
+      @requests.push(request_data)
+      if (now - @last_posted) > 5
+        requests = @requests.dup
+        Thread.new {
+          post_requests(@api_key, requests, @framework)
+        }
+        @requests = Array.new
+        @last_posted = now
+    end
     end
   end
 
@@ -59,5 +79,3 @@ module Analytics
   end
 end
 
-
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_analytics
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Tom Draper
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-02 00:00:00.000000000 Z
+date: 2023-04-03 00:00:00.000000000 Z
 dependencies: []
 description: Monitoring and analytics for API applications.
 email: