changes of hatch run docs:api

Author: divyabiyani

docs/source/api/jupyter_server.prometheus.rst

@@ -16,6 +16,12 @@ Submodules
    :show-inheritance:
    :undoc-members:
 
+
+.. automodule:: jupyter_server.prometheus.server
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
 Module contents
 ---------------
 

jupyter_server/prometheus/server.py

@@ -162,8 +162,6 @@ def start(self, port: int) -> None:
         port : int
             The port to listen on for metrics requests
         """
-        self.port = port
-
         # Initialize Jupyter metrics
         self.initialize_metrics()
 
@@ -184,9 +182,38 @@ def start(self, port: int) -> None:
         authenticate_metrics = main_app.settings.get("authenticate_prometheus", True)
         auth_info = "with authentication" if authenticate_metrics else "without authentication"
 
-        # Create and start the HTTP server
+        # Create and start the HTTP server with port retry logic
         self.http_server = tornado.httpserver.HTTPServer(metrics_app)
-        self.http_server.listen(port)
+        
+        # Try to bind to the requested port, with fallback to random ports
+        actual_port = port
+        max_retries = 10
+        
+        for attempt in range(max_retries):
+            try:
+                self.http_server.listen(actual_port)
+                self.port = actual_port
+                break
+            except OSError as e:
+                if e.errno == 98:  # Address already in use
+                    if attempt == 0:
+                        # First attempt failed, try random ports
+                        import random
+                        actual_port = random.randint(49152, 65535)  # Use dynamic port range
+                    else:
+                        # Subsequent attempts, try next random port
+                        actual_port = random.randint(49152, 65535)
+                    
+                    if attempt == max_retries - 1:
+                        # Last attempt failed
+                        self.server_app.log.warning(
+                            f"Could not start metrics server on any port after {max_retries} attempts. "
+                            f"Metrics will be available on the main server at /metrics"
+                        )
+                        return
+                else:
+                    # Non-port-related error, re-raise
+                    raise
 
         # Start the IOLoop in a separate thread
         def start_metrics_loop():
@@ -198,7 +225,7 @@ def start_metrics_loop():
         self.thread.start()
 
         self.server_app.log.info(
-            f"Metrics server started on port {port} {auth_info} (using Jupyter Prometheus integration)"
+            f"Metrics server started on port {self.port} {auth_info} (using Jupyter Prometheus integration)"
         )
 
     def stop(self) -> None:

jupyter_server/serverapp.py

@@ -3050,7 +3050,15 @@ def _start_metrics_server(self, port):
         """Start a separate metrics server on the specified port using Jupyter's Prometheus integration."""
         from jupyter_server.prometheus.server import start_metrics_server
 
-        self.metrics_server = start_metrics_server(self, port)
+        try:
+            self.metrics_server = start_metrics_server(self, port)
+            # Check if the metrics server actually started (has a port)
+            if not hasattr(self.metrics_server, 'port') or self.metrics_server.port is None:
+                self.metrics_server = None
+                self.log.warning("Metrics server failed to start. Metrics will be available on the main server at /metrics")
+        except Exception as e:
+            self.metrics_server = None
+            self.log.warning(f"Failed to start metrics server: {e}. Metrics will be available on the main server at /metrics")
 
     def launch_browser(self) -> None:
         """Launch the browser."""
@@ -3127,12 +3135,16 @@ def start_app(self) -> None:
             # with auth info.
 
             # Determine metrics URL based on whether separate metrics server is running
-            if self.metrics_port:
+            if (self.metrics_port and 
+                hasattr(self, 'metrics_server') and 
+                self.metrics_server is not None and 
+                hasattr(self.metrics_server, 'port') and 
+                self.metrics_server.port is not None):
                 # Separate metrics server is running
                 if self.authenticate_prometheus:
-                    metrics_url = f"http://localhost:{self.metrics_port}/metrics?token={self.identity_provider.token}"
+                    metrics_url = f"http://localhost:{self.metrics_server.port}/metrics?token={self.identity_provider.token}"
                 else:
-                    metrics_url = f"http://localhost:{self.metrics_port}/metrics"
+                    metrics_url = f"http://localhost:{self.metrics_server.port}/metrics"
             else:
                 # Metrics are served on main server
                 # Use the connection_url as base and append /metrics