Pyctuator should allow adding arbitrary details to the "Info" section

See examples at #50.

The actual "Info" section in SBA (retreived from the `/pyctuator/info` URI
is includes explicit parameters such as `app_name` and anything provided in
the `additional_app_info` parameter.

Author: michael.yak

README.md

@@ -204,6 +204,33 @@ Once you configure build and git info, you should see them in the Details tab of
 
 ![Detailed Build Info](examples/images/Main_Details_BuildInfo.png)
 
+### Additional Application Info
+In addition to adding build and git info, Pyctuator allows adding arbitrary application details to the "Info" section in SBA.
+
+This is done by initializing the `additional_app_info` parameter with an arbitrary dictionary.
+For example, you can provide links to your application's metrics:
+```python
+Pyctuator(
+  app,
+  "Flask Pyctuator",
+  app_url=f"http://172.18.0.1:5000",
+  pyctuator_endpoint_url=f"http://172.18.0.1:5000/pyctuator",
+  registration_url=f"http://localhost:8080/instances",
+  app_description="Demonstrate Spring Boot Admin Integration with Flask",
+  additional_app_info=dict(
+    serviceLinks=dict(
+      metrics="http://xyz/service/metrics"
+    ),
+    podLinks=dict(
+      metrics=["http://xyz/pod/metrics/memory", "http://xyz/pod/metrics/cpu"]
+    )
+  )
+)
+```
+
+This will result with the following Info page in SBA:
+![img.png](examples/images/Additional_App_Info.png)
+
 ### DB Health
 For services that use SQL database via SQLAlchemy, Pyctuator can easily monitor and expose the connection's health 
 using the DbHealthProvider class as demonstrated below:

examples/images/Additional_App_Info.png

@@ -34,7 +34,7 @@ async def get_environment(request: web.Request) -> web.Response:
             return web.json_response(pyctuator_impl.get_environment(), dumps=custom_dumps)
 
         async def get_info(request: web.Request) -> web.Response:
-            return web.json_response(pyctuator_impl.app_info, dumps=custom_dumps)
+            return web.json_response(pyctuator_impl.get_app_info(), dumps=custom_dumps)
 
         async def get_health(request: web.Request) -> web.Response:
             return web.json_response(pyctuator_impl.get_health(), dumps=custom_dumps)

pyctuator/impl/aiohttp_pyctuator.py

@@ -15,7 +15,7 @@
 from pyctuator.httptrace import TraceRecord, TraceRequest, TraceResponse
 from pyctuator.httptrace.http_tracer import Traces
 from pyctuator.impl import SBA_V2_CONTENT_TYPE
-from pyctuator.impl.pyctuator_impl import PyctuatorImpl, AppInfo
+from pyctuator.impl.pyctuator_impl import PyctuatorImpl
 from pyctuator.impl.pyctuator_router import PyctuatorRouter, EndpointsData
 from pyctuator.logging.pyctuator_logging import LoggersData, LoggerLevels
 from pyctuator.metrics.metrics_provider import Metric, MetricNames
@@ -67,8 +67,8 @@ def get_environment() -> EnvironmentData:
             return pyctuator_impl.get_environment()
 
         @router.get("/info", include_in_schema=include_in_openapi_schema, tags=["pyctuator"])
-        def get_info() -> AppInfo:
-            return pyctuator_impl.app_info
+        def get_info() -> Dict:
+            return pyctuator_impl.get_app_info()
 
         @router.get("/health", include_in_schema=include_in_openapi_schema, tags=["pyctuator"])
         def get_health() -> HealthSummary:

pyctuator/impl/fastapi_pyctuator.py

@@ -81,7 +81,7 @@ def get_environment() -> Any:
 
         @flask_blueprint.route("/info")
         def get_info() -> Any:
-            return jsonify(pyctuator_impl.app_info)
+            return jsonify(pyctuator_impl.get_app_info())
 
         @flask_blueprint.route("/health")
         def get_health() -> Any:

pyctuator/impl/flask_pyctuator.py

@@ -1,8 +1,7 @@
+import dataclasses
 from dataclasses import dataclass
 from datetime import datetime
-from typing import List
-from typing import Mapping
-from typing import Optional
+from typing import List, Dict, Mapping, Optional
 from urllib.parse import urlparse
 
 from pyctuator.environment.environment_provider import EnvironmentData, EnvironmentProvider
@@ -56,9 +55,11 @@ def __init__(
             pyctuator_endpoint_url: str,
             logfile_max_size: int,
             logfile_formatter: str,
+            additional_app_info: Optional[dict],
     ):
         self.app_info = app_info
         self.pyctuator_endpoint_url = pyctuator_endpoint_url
+        self.additional_app_info = additional_app_info
 
         self.metrics_providers: List[MetricsProvider] = []
         self.health_providers: List[HealthProvider] = []
@@ -135,3 +136,11 @@ def get_metric_measurement(self, metric_name: str) -> Metric:
 
     def get_thread_dump(self) -> ThreadDump:
         return self.thread_dump_provider.get_thread_dump()
+
+    def get_app_info(self) -> Dict:
+        app_info_dict = {k: v for (k, v) in dataclasses.asdict(self.app_info).items() if v}
+
+        if self.additional_app_info:
+            app_info_dict = {**app_info_dict, **self.additional_app_info}
+
+        return app_info_dict

pyctuator/impl/pyctuator_impl.py

@@ -50,7 +50,7 @@ class InfoHandler(AbstractPyctuatorHandler):
     def get(self) -> None:
         assert self.pyctuator_router is not None
         assert self.dumps is not None
-        self.write(self.dumps(self.pyctuator_router.pyctuator_impl.app_info))
+        self.write(self.dumps(self.pyctuator_router.pyctuator_impl.get_app_info()))
 
 
 # GET /health

pyctuator/impl/tornado_pyctuator.py

@@ -38,7 +38,8 @@ def __init__(
             logfile_max_size: int = 10000,
             logfile_formatter: str = default_logfile_format,
             auto_deregister: bool = True,
-            metadata: Optional[dict] = None
+            metadata: Optional[dict] = None,
+            additional_app_info: Optional[dict] = None,
     ) -> None:
         """The entry point for integrating pyctuator with a web-frameworks such as FastAPI and Flask.
 
@@ -74,6 +75,7 @@ def __init__(
         example when running in k8s so every time a new pod is created it is assigned a different IP address, resulting
         with SBA showing "offline" instances
         :param metadata: optional metadata key-value pairs that are displayed in SBA main page of an instance
+        :param additional_app_info: additional arbitrary information to add to the application's "Info" section
         """
 
         self.auto_deregister = auto_deregister
@@ -85,6 +87,7 @@ def __init__(
             pyctuator_endpoint_url,
             logfile_max_size,
             logfile_formatter,
+            additional_app_info,
         )
 
         # Register default health/metrics/environment providers

pyctuator/pyctuator.py

@@ -25,6 +25,7 @@ def __init__(self) -> None:
             "http://localhost:8001/register",
             registration_interval_sec=1,
             metadata=self.metadata,
+            additional_app_info=self.additional_app_info,
         )
 
         @self.routes.get("/logfile_test_repeater")

tests/aiohttp_test_server.py

@@ -157,6 +157,14 @@ def endpoints(registration_tracker: RegistrationTrackerFixture) -> Endpoints:
 
 class PyctuatorServer(ABC):
     metadata: Optional[dict] = {f"k{i}": f"v{i}" for i in range(random.randrange(10))}
+    additional_app_info = dict(
+        serviceLinks=dict(
+            metrics="http://xyz/service/metrics",
+        ),
+        podLinks=dict(
+            metrics=["http://xyz/pod/metrics/memory", "http://xyz/pod/metrics/cpu"],
+        )
+    )
 
     @abstractmethod
     def start(self) -> None: