Pass through more info from nginx and log it, to help me figure out who's using Spothole and contact them about upcoming API changes. Also an enabler for #101.

2026-06-23 21:25:12 +00:00 · 2026-06-20 12:17:13 +01:00
parent 92121d7953
commit 5c598f91e6
11 changed files with 79 additions and 23 deletions
--- a/README.md
+++ b/README.md
@@ -310,44 +310,80 @@ server {
    
    # SSE endpoints
    location ~ ^/api/v1/(spots|alerts)/stream {
+        proxy_pass http://127.0.0.1:8080;
+        
+        # Allow keep-alive
        proxy_http_version 1.1;
        proxy_set_header Connection "";
-        proxy_pass http://127.0.0.1:8080;
+        
+        # Set correct content type for SSE API calls
+        add_header Content-Type text/event-stream always;
+        
+        # Set remove buffering, remove caching, add suitable timeouts for SSE API calls
        proxy_buffering off;
        proxy_cache off;
        proxy_read_timeout 24h;
        proxy_connect_timeout 10s;
        proxy_send_timeout 24h;
        proxy_set_header X-Accel-Buffering no;
+        add_header Cache-Control no-store always;
+        
+        # Allow cross-origin requests to API
        proxy_hide_header Access-Control-Allow-Origin;
        add_header Access-Control-Allow-Origin * always;
-        add_header Cache-Control no-store always;
-        add_header Content-Type text/event-stream always;
+        
+        # Pass on IP address and host information to Spothole, in case logging this information is required
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header Host $http_host;
+        proxy_set_header X-Forwarded-Proto $scheme;
    }

    # Other API endpoints
    location /api/ {
+        proxy_pass http://127.0.0.1:8080;
+        
+        # Allow keep-alive
        proxy_http_version 1.1;
        proxy_set_header Connection "";
-        proxy_pass http://127.0.0.1:8080;
+        
+        # Set up buffering, remove caching, add suitable timeouts for API calls
        proxy_buffering on;
        proxy_cache off;
        proxy_read_timeout 30s;
        proxy_connect_timeout 10s;
+        add_header Cache-Control no-store always;
+        
+        # Allow cross-origin requests to API
        proxy_hide_header Access-Control-Allow-Origin;
        add_header Access-Control-Allow-Origin * always;
-        add_header Cache-Control no-store always;
+        
+        # Pass on IP address and host information to Spothole, in case logging this information is required
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header Host $http_host;
+        proxy_set_header X-Forwarded-Proto $scheme;
    }

    # Static assets
    location / {
+        proxy_pass http://127.0.0.1:8080;
+        
+        # Allow keep-alive
        proxy_http_version 1.1;
        proxy_set_header Connection "";
-        proxy_pass http://127.0.0.1:8080;
+        
+        # Set up buffering and caching, add suitable timeouts for static asset requests
        proxy_buffering on;
        proxy_read_timeout 30s;
        proxy_connect_timeout 10s;
        add_header Cache-Control "public, max-age=3600, must-revalidate" always;
+        
+        # Pass on IP address and host information to Spothole, in case logging this information is required
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header Host $http_host;
+        proxy_set_header X-Forwarded-Proto $scheme;
    }
 }
 ```
--- a/server/webserver.py
+++ b/server/webserver.py
@@ -108,8 +108,9 @@ class WebServer:

        app = tornado.web.Application(api_routes + ui_routes + misc_routes,
                                      template_path=os.path.join(_HERE, "../templates"),
+                                      log_function=request_log,
                                      debug=False)
-        app.listen(self._port)
+        app.listen(self._port, xheaders=True)
        logging.info("Web server running on port " + str(WEB_SERVER_PORT))
        await self._shutdown_event.wait()

@@ -162,3 +163,22 @@ class WebServer:
                # Probably got deleted already on another thread
                pass
        pass
+
+def request_log(handler):
+    """Custom log function to provide more data about requests."""
+
+    if handler.get_status() < 500:
+        log_method = logging.info
+    else:
+        log_method = logging.warning
+
+    request = handler.request
+    client_ip = request.remote_ip
+    referrer = request.headers.get("Referer", "-")
+    user_agent = request.headers.get("User-Agent", "-")
+
+    log_method(
+        f'{client_ip} - "{request.method} {request.uri}" '
+        f'{handler.get_status()} {request.request_time():.2f}ms | '
+        f'Ref: {referrer} | UA: {user_agent}'
+    )
--- a/templates/about.html
+++ b/templates/about.html
@@ -13,7 +13,7 @@
            href="/apidocs">API documentation</a>. The API delivers spots in a consistent format regardless of the data
        source, freeing developers from needing to know how each individual data source presents its data.</p>
    <p>Spothole itself is also open source, Public Domain licenced code that anyone can take and modify. <a
-            href="https://git.ianrenton.com/ian/metaspot/">The source code is here</a>.</p>
+            href="https://git.ianrenton.com/ian/spothole/">The source code is here</a>.</p>
    <p>The software was written by <a href="https://ianrenton.com">Ian Renton, MØTRT</a> and other contributors. Full
        details are available in the <a href="https://git.ianrenton.com/ian/spothole/src/branch/main/README.md">README
            file</a>.</p>
--- a/templates/add_spot.html
+++ b/templates/add_spot.html
@@ -76,7 +76,7 @@

 </div>

-<script src="/js/add-spot.js?v=1781947165"></script>
+<script src="/js/add-spot.js?v=1781954233"></script>
 <script>$(document).ready(function () {
    $("#nav-link-add-spot").addClass("active");
 }); <!-- highlight active page in nav --></script>
--- a/templates/alerts.html
+++ b/templates/alerts.html
@@ -75,7 +75,7 @@

 </div>

-<script src="/js/alerts.js?v=1781947166"></script>
+<script src="/js/alerts.js?v=1781954233"></script>
 <script>$(document).ready(function () {
    $("#nav-link-alerts").addClass("active");
 }); <!-- highlight active page in nav --></script>
--- a/templates/bands.html
+++ b/templates/bands.html
@@ -77,8 +77,8 @@
 <script>
    let spotProvidersEnabledByDefault = {% raw json_encode(web_ui_options["spot-providers-enabled-by-default"]) %};
 </script>
-<script src="/js/spotsbandsandmap.js?v=1781947165"></script>
-<script src="/js/bands.js?v=1781947165"></script>
+<script src="/js/spotsbandsandmap.js?v=1781954233"></script>
+<script src="/js/bands.js?v=1781954233"></script>
 <script>$(document).ready(function () {
    $("#nav-link-bands").addClass("active");
 }); <!-- highlight active page in nav --></script>
--- a/templates/base.html
+++ b/templates/base.html
@@ -1,6 +1,6 @@
 {% extends "skeleton.html" %}
 {% block head_extra %}
-<link rel="stylesheet" href="/css/style.css?v=1781947165" type="text/css">
+<link rel="stylesheet" href="/css/style.css?v=1781954233" type="text/css">
 <link href="/vendor/css/bootstrap-5.3.8.min.css" rel="stylesheet">
 <link href="/vendor/css/fontawesome-6.7.2.min.css" rel="stylesheet">
 <link href="/vendor/css/solid-6.7.2.min.css" rel="stylesheet">
@@ -10,10 +10,10 @@
 <script src="/vendor/js/bootstrap-5.3.8.bundle.min.js"></script>
 <script src="/vendor/js/tinycolor2-1.6.0.min.js"></script>

-<script src="/js/utils.js?v=1781947165"></script>
-<script src="/js/ui-ham.js?v=1781947165"></script>
-<script src="/js/geo.js?v=1781947165"></script>
-<script src="/js/common.js?v=1781947165"></script>
+<script src="/js/utils.js?v=1781954233"></script>
+<script src="/js/ui-ham.js?v=1781954233"></script>
+<script src="/js/geo.js?v=1781954233"></script>
+<script src="/js/common.js?v=1781954233"></script>
 {% end %}
 {% block body %}
 <div class="container">
--- a/templates/conditions.html
+++ b/templates/conditions.html
@@ -284,7 +284,7 @@
 </div>

 <script src="/vendor/js/chart-4.4.9.umd.min.js"></script>
-<script src="/js/conditions.js?v=1781947165"></script>
+<script src="/js/conditions.js?v=1781954233"></script>
 <script>$(document).ready(function () {
    $("#nav-link-conditions").addClass("active");
 }); <!-- highlight active page in nav --></script>
--- a/templates/map.html
+++ b/templates/map.html
@@ -95,8 +95,8 @@
 <script>
    let spotProvidersEnabledByDefault = {% raw json_encode(web_ui_options["spot-providers-enabled-by-default"]) %};
 </script>
-<script src="/js/spotsbandsandmap.js?v=1781947166"></script>
-<script src="/js/map.js?v=1781947166"></script>
+<script src="/js/spotsbandsandmap.js?v=1781954233"></script>
+<script src="/js/map.js?v=1781954233"></script>
 <script>$(document).ready(function () {
    $("#nav-link-map").addClass("active");
 }); <!-- highlight active page in nav --></script>
--- a/templates/spots.html
+++ b/templates/spots.html
@@ -116,8 +116,8 @@
 <script>
    let spotProvidersEnabledByDefault = {% raw json_encode(web_ui_options["spot-providers-enabled-by-default"]) %};
 </script>
-<script src="/js/spotsbandsandmap.js?v=1781947165"></script>
-<script src="/js/spots.js?v=1781947165"></script>
+<script src="/js/spotsbandsandmap.js?v=1781954233"></script>
+<script src="/js/spots.js?v=1781954233"></script>
 <script>$(document).ready(function () {
    $("#nav-link-spots").addClass("active");
 }); <!-- highlight active page in nav --></script>
--- a/templates/status.html
+++ b/templates/status.html
@@ -59,7 +59,7 @@
    </div>
 </div>

-<script src="/js/status.js?v=1781947165"></script>
+<script src="/js/status.js?v=1781954233"></script>
 <script>
    $(document).ready(function () {
        $("#nav-link-status").addClass("active");