dbca-utils 3.0.9__tar.gz → 3.0.11__tar.gz

{dbca_utils-3.0.9 → dbca_utils-3.0.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dbca-utils
-Version: 3.0.9
+Version: 3.0.11
 Summary: Utilities for DBCA Django apps
 Author-Email: Rocky Chen <rocky.chen@dbca.wa.gov.au>, Ashley Felton <ashley.felton@dbca.wa.gov.au>
 License-Expression: Apache-2.0
@@ -129,185 +129,151 @@ MIDDLEWARE = [
       - Add a location 'location /healthcheck/' and configure it to use basic auth in nginx.
   - Access the url : https://xxx.dbca.wa.gov.au/healthcheck/healthdata to get the health json data
   - The sample data of the health data:
-  {
-   "workload0":{
-      "resources":{
-         "start_time":"2026-07-24T06:10:23",
-         "cpu_total":0.0,
-         "cpu_min":0.0,
-         "cpu_max":0.0,
-         "pmemory_total":292.28125,
-         "pmemory_min":95.53515625,
-         "pmemory_max":100.828125,
-         "vmemory_total":764.12890625,
-         "vmemory_min":207.8671875,
-         "vmemory_max":278.59765625,
-         "processes":3,
-         "process":{
-            "start_time":"2026-07-24T06:10:23",
-            "cmdline":[
-               "/app/.venv/bin/python",
-               "/app/.venv/bin/gunicorn",
-               "authome.wsgi",
-               "--config=gunicorn_gevent.py"
-            ],
-            "cpu_num":0,
-            "cpu_pcent":0.0,
-            "pmemory":100.828125,
-            "vmemory":207.8671875,
-            "children":[
-               {
-                  "start_time":"2026-07-24T06:10:24",
-                  "cmdline":[
-                     "/app/.venv/bin/python",
-                     "/app/.venv/bin/gunicorn",
-                     "authome.wsgi",
-                     "--config=gunicorn_gevent.py"
-                  ],
-                  "cpu_num":1,
-                  "cpu_pcent":0.0,
-                  "pmemory":95.53515625,
-                  "vmemory":277.6640625
-               },
-               {
-                  "start_time":"2026-07-24T06:10:24",
-                  "cmdline":[
-                     "/app/.venv/bin/python",
-                     "/app/.venv/bin/gunicorn",
-                     "authome.wsgi",
-                     "--config=gunicorn_gevent.py"
-                  ],
-                  "cpu_num":3,
-                  "cpu_pcent":0.0,
-                  "pmemory":95.91796875,
-                  "vmemory":278.59765625,
-                  "currentprocess":true
-               }
-            ]
-         }
-      },
-      "system":{
-         "cpu_pcent":0.0,
-         "cpucores_pcent":[
-            0.0,
-            0.0,
-            0.0,
-            0.0
-         ],
-         "memory_total":31.279705047607422,
-         "memory_used":12.220211029052734,
-         "memory_pcent":39.06753919339612,
-         "bytes_sent":9028205,
-         "bytes_recv":9246094
-      },
-      "volumes":{
-         "/app/captcha":{
-            "size":1024,
-            "used":0,
-            "pcent":0.006103515625,
-            "unit":"M"
-         }
-      },
-      "hostname":"auth2-uat11-5b495b67cb-z8vwj"
-   },
-   "workload1":{
-      "resources":{
-         "start_time":"2026-07-24T06:11:45",
-         "cpu_total":0.0,
-         "cpu_min":0.0,
-         "cpu_max":0.0,
-         "pmemory_total":292.02734375,
-         "pmemory_min":95.4140625,
-         "pmemory_max":100.6171875,
-         "vmemory_total":763.84375,
-         "vmemory_min":207.8359375,
-         "vmemory_max":278.546875,
-         "processes":3,
-         "process":{
-            "start_time":"2026-07-24T06:11:45",
-            "cmdline":[
-               "/app/.venv/bin/python",
-               "/app/.venv/bin/gunicorn",
-               "authome.wsgi",
-               "--config=gunicorn_gevent.py"
-            ],
-            "cpu_num":1,
-            "cpu_pcent":0.0,
-            "pmemory":100.6171875,
-            "vmemory":207.8359375,
-            "children":[
-               {
-                  "start_time":"2026-07-24T06:11:46",
-                  "cmdline":[
-                     "/app/.venv/bin/python",
-                     "/app/.venv/bin/gunicorn",
-                     "authome.wsgi",
-                     "--config=gunicorn_gevent.py"
-                  ],
-                  "cpu_num":2,
-                  "cpu_pcent":0.0,
-                  "pmemory":95.4140625,
-                  "vmemory":277.4609375
-               },
-               {
-                  "start_time":"2026-07-24T06:11:46",
-                  "cmdline":[
-                     "/app/.venv/bin/python",
-                     "/app/.venv/bin/gunicorn",
-                     "authome.wsgi",
-                     "--config=gunicorn_gevent.py"
-                  ],
-                  "cpu_num":3,
-                  "cpu_pcent":0.0,
-                  "pmemory":95.99609375,
-                  "vmemory":278.546875,
-                  "currentprocess":true
-               }
-            ]
-         }
-      },
-      "system":{
-         "cpu_pcent":13.1,
-         "cpucores_pcent":[
-            15.4,
-            12.2,
-            12.0,
-            12.7
-         ],
-         "memory_total":31.279705047607422,
-         "memory_used":12.220211029052734,
-         "memory_pcent":39.06753919339612,
-         "bytes_sent":9099207,
-         "bytes_recv":9055029
-      },
-      "volumes":{
-         "/app/captcha":{
-            "size":1024,
-            "used":0,
-            "pcent":0.006103515625,
-            "unit":"M"
-         }
-      },
-      "hostname":"auth2-uat11-5b495b67cb-dpdjp"
-   },
-   "summary":{
-      "cpu_total":0.0,
-      "cpu_min":0.0,
-      "cpu_max":0.0,
-      "process_cpu_min":0.0,
-      "process_cpu_max":0.0,
-      "pmemory_total":584.30859375,
-      "pmemory_min":292.02734375,
-      "pmemory_max":292.28125,
-      "process_pmemory_min":95.4140625,
-      "process_pmemory_max":100.828125,
-      "vmemory_total":1527.97265625,
-      "vmemory_min":763.84375,
-      "vmemory_max":764.12890625,
-      "process_vmemory_min":207.8359375,
-      "process_vmemory_max":278.59765625,
-      "processes_total":6,
-      "workloads_running":2,
-      "workloads_failed":0
-   }
-}
+    
+          {
+           "workload0":{
+              "resources":{
+                 "start_time":"2026-07-24T06:10:23",
+                 "cpu_total":0.0,
+                 "cpu_min":0.0,
+                 "cpu_max":0.0,
+                 "pmemory_total":292.28125,
+                 "pmemory_min":95.53515625,
+                 "pmemory_max":100.828125,
+                 "vmemory_total":764.12890625,
+                 "vmemory_min":207.8671875,
+                 "vmemory_max":278.59765625,
+                 "processes":3,
+                 "process":{
+                    "start_time":"2026-07-24T06:10:23",
+                    "cpu_num":0,
+                    "cpu_pcent":0.0,
+                    "pmemory":100.828125,
+                    "vmemory":207.8671875,
+                    "children":[
+                       {
+                          "start_time":"2026-07-24T06:10:24",
+                          "cpu_num":1,
+                          "cpu_pcent":0.0,
+                          "pmemory":95.53515625,
+                          "vmemory":277.6640625
+                       },
+                       {
+                          "start_time":"2026-07-24T06:10:24",
+                          "cpu_num":3,
+                          "cpu_pcent":0.0,
+                          "pmemory":95.91796875,
+                          "vmemory":278.59765625,
+                          "currentprocess":true
+                       }
+                    ]
+                 }
+              },
+              "system":{
+                 "cpu_pcent":0.0,
+                 "cpucores_pcent":[
+                    0.0,
+                    0.0,
+                    0.0,
+                    0.0
+                 ],
+                 "memory_total":31.279705047607422,
+                 "memory_used":12.220211029052734,
+                 "memory_pcent":39.06753919339612,
+                 "bytes_sent":9028205,
+                 "bytes_recv":9246094
+              },
+              "volumes":{
+                 "/app/captcha":{
+                    "size":1024,
+                    "used":0,
+                    "pcent":0.006103515625,
+                    "unit":"M"
+                 }
+              },
+              "hostname":"auth2-uat11-5b495b67cb-z8vwj"
+           },
+           "workload1":{
+              "resources":{
+                 "start_time":"2026-07-24T06:11:45",
+                 "cpu_total":0.0,
+                 "cpu_min":0.0,
+                 "cpu_max":0.0,
+                 "pmemory_total":292.02734375,
+                 "pmemory_min":95.4140625,
+                 "pmemory_max":100.6171875,
+                 "vmemory_total":763.84375,
+                 "vmemory_min":207.8359375,
+                 "vmemory_max":278.546875,
+                 "processes":3,
+                 "process":{
+                    "start_time":"2026-07-24T06:11:45",
+                    "cpu_num":1,
+                    "cpu_pcent":0.0,
+                    "pmemory":100.6171875,
+                    "vmemory":207.8359375,
+                    "children":[
+                       {
+                          "start_time":"2026-07-24T06:11:46",
+                          "cpu_num":2,
+                          "cpu_pcent":0.0,
+                          "pmemory":95.4140625,
+                          "vmemory":277.4609375
+                       },
+                       {
+                          "start_time":"2026-07-24T06:11:46",
+                          "cpu_num":3,
+                          "cpu_pcent":0.0,
+                          "pmemory":95.99609375,
+                          "vmemory":278.546875,
+                       }
+                    ]
+                 }
+              },
+              "system":{
+                 "cpu_pcent":13.1,
+                 "cpucores_pcent":[
+                    15.4,
+                    12.2,
+                    12.0,
+                    12.7
+                 ],
+                 "memory_total":31.279705047607422,
+                 "memory_used":12.220211029052734,
+                 "memory_pcent":39.06753919339612,
+                 "bytes_sent":9099207,
+                 "bytes_recv":9055029
+              },
+              "volumes":{
+                 "/app/captcha":{
+                    "size":1024,
+                    "used":0,
+                    "pcent":0.006103515625,
+                    "unit":"M"
+                 }
+              },
+              "hostname":"auth2-uat11-5b495b67cb-dpdjp"
+           },
+           "summary":{
+              "cpu_total":0.0,
+              "cpu_min":0.0,
+              "cpu_max":0.0,
+              "process_cpu_min":0.0,
+              "process_cpu_max":0.0,
+              "pmemory_total":584.30859375,
+              "pmemory_min":292.02734375,
+              "pmemory_max":292.28125,
+              "process_pmemory_min":95.4140625,
+              "process_pmemory_max":100.828125,
+              "vmemory_total":1527.97265625,
+              "vmemory_min":763.84375,
+              "vmemory_max":764.12890625,
+              "process_vmemory_min":207.8359375,
+              "process_vmemory_max":278.59765625,
+              "processes_total":6,
+              "workloads_running":2,
+              "workloads_failed":0
+           }
+        }
+    
+        

dbca_utils-3.0.11/README.md

@@ -0,0 +1,251 @@
+# Overview
+
+DBCA Django utility classes and functions.
+
+## Requirements
+
+- Python 3.12 or later
+- Django 5.2 or later
+
+## Development
+
+Dependencies for this project are managed using [uv](https://docs.astral.sh/uv/).
+With uv installed, change into the project directory and run:
+
+    uv sync
+
+Activate the virtualenv like so:
+
+    source .venv/bin/activate
+
+Run unit tests using `pytest` (or `tox`, to test against multiple Python versions):
+
+    pytest -sv
+    tox -v
+
+## Releases
+
+Tagged releases are built and pushed to PyPI automatically using a GitHub
+workflow in the project. Update the project version in `pyproject.toml` and
+tag the required commit with the same value to trigger a release. Packages
+can also be built and uploaded manually to PyPI using [uv](https://docs.astral.sh/uv/guides/publish/#publishing-your-package),
+if required:
+
+    uv build
+    uv publish
+
+## Installation
+
+1. Install via uv/pip/etc.: `pip install dbca-utils`
+
+## SSO Login Middleware
+
+This will automatically login and create users using headers from an upstream proxy (REMOTE_USER and some others).
+The logout view will redirect to a separate logout page which clears the SSO session.
+
+### Usage
+
+Add `dbca_utils.middleware.SSOLoginMiddleware` to `settings.MIDDLEWARE` (after both of
+`django.contrib.sessions.middleware.SessionMiddleware` and
+`django.contrib.auth.middleware.AuthenticationMiddleware`.
+Ensure that `AUTHENTICATION_BACKENDS` contains `django.contrib.auth.backends.ModelBackend`,
+as this middleware depends on it for retrieving the logged in user for a session.
+Note that the middleware will still work without it, but will reauthenticate the session
+on every request, and `request.user.is_authenticated` won't work properly/will be false.
+
+Example:
+
+```python
+MIDDLEWARE = [
+    ...,
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'dbca_utils.middleware.SSOLoginMiddleware'
+    ...,
+]
+```
+
+## Audit model mixin
+
+`AuditMixin` is an extension of `Django.db.model.Model` that adds a number of additional fields:
+
+- `creator` - FK to `AUTH_USER_MODEL`, used to record the object creator
+- `modifier` - FK to `AUTH_USER_MODEL`, used to record who the object was last modified by
+- `created` - a timestamp that is set on initial object save
+- `modified` - an auto-updating timestamp (on each object save)
+  
+## Healthcheck feature
+### Requirements
+  - Django 5.2 or later
+  - Declared the default cache and also the cache is shared by all pod instances
+    
+  ### Usage
+  - Install the app 'dbca_utils' in INSTALLED_APPS
+  - Service Configuration
+      - HEALTHCHECK_ENABLED: Optional. enable/disable the healthcheck service. default is 'true'
+      - CACHE_PREFIX: Optional. used as the prefix of the cache key. default is ''
+      - PORT: Optional. The listening port of the web application. default is '8080', used to send request to peer pod instance to get the resouces usage of the peer pod instance.
+      - WORKLOADS: Optional. Used if the web app has a fixed replicas.
+      - WORKLOAD_DEPLOYMENT: Optional. the workload is deployment if it is true; otherwise it is statefulset. default is 'true'
+      - WORKLOAD_FAILED_THRESHOLD: Optional. The number of continuous failed times to decide that a pod is offline.
+      - WORKLOAD_VOLUMES: Optional. can be 'disabled', 'false','automatic' or "," separated volume mounted point. default is "automatic".
+          - disabled|false: Don't harvest volume usage data
+          - automatic: Detect the persistent volume automatically.
+          - "," separated volume mounted points: the volume list
+      - HEALTHCHECK_SYSTEMDATA_ENABLED: Enable system resource data
+      - HEALTHCHECK_PROCESSDATA_ENABLED: Enable process resource data
+  - Endpoints added by this app
+      - /healthcheck/healthdata: An endpoint for client to harvest the resources usage data. This endpoint should be cofigured to use basic auth in nginx reverse proxy.
+      - /workload/healthcheck/healthdata: An internal endpoint used to get the resource usage of the peer pod instance. This endpoing should not be exposed in nginx reverse proxy.
+  - Nginx Configuration.
+      - Add a location 'location /healthcheck/' and configure it to use basic auth in nginx.
+  - Access the url : https://xxx.dbca.wa.gov.au/healthcheck/healthdata to get the health json data
+  - The sample data of the health data:
+    
+          {
+           "workload0":{
+              "resources":{
+                 "start_time":"2026-07-24T06:10:23",
+                 "cpu_total":0.0,
+                 "cpu_min":0.0,
+                 "cpu_max":0.0,
+                 "pmemory_total":292.28125,
+                 "pmemory_min":95.53515625,
+                 "pmemory_max":100.828125,
+                 "vmemory_total":764.12890625,
+                 "vmemory_min":207.8671875,
+                 "vmemory_max":278.59765625,
+                 "processes":3,
+                 "process":{
+                    "start_time":"2026-07-24T06:10:23",
+                    "cpu_num":0,
+                    "cpu_pcent":0.0,
+                    "pmemory":100.828125,
+                    "vmemory":207.8671875,
+                    "children":[
+                       {
+                          "start_time":"2026-07-24T06:10:24",
+                          "cpu_num":1,
+                          "cpu_pcent":0.0,
+                          "pmemory":95.53515625,
+                          "vmemory":277.6640625
+                       },
+                       {
+                          "start_time":"2026-07-24T06:10:24",
+                          "cpu_num":3,
+                          "cpu_pcent":0.0,
+                          "pmemory":95.91796875,
+                          "vmemory":278.59765625,
+                          "currentprocess":true
+                       }
+                    ]
+                 }
+              },
+              "system":{
+                 "cpu_pcent":0.0,
+                 "cpucores_pcent":[
+                    0.0,
+                    0.0,
+                    0.0,
+                    0.0
+                 ],
+                 "memory_total":31.279705047607422,
+                 "memory_used":12.220211029052734,
+                 "memory_pcent":39.06753919339612,
+                 "bytes_sent":9028205,
+                 "bytes_recv":9246094
+              },
+              "volumes":{
+                 "/app/captcha":{
+                    "size":1024,
+                    "used":0,
+                    "pcent":0.006103515625,
+                    "unit":"M"
+                 }
+              },
+              "hostname":"auth2-uat11-5b495b67cb-z8vwj"
+           },
+           "workload1":{
+              "resources":{
+                 "start_time":"2026-07-24T06:11:45",
+                 "cpu_total":0.0,
+                 "cpu_min":0.0,
+                 "cpu_max":0.0,
+                 "pmemory_total":292.02734375,
+                 "pmemory_min":95.4140625,
+                 "pmemory_max":100.6171875,
+                 "vmemory_total":763.84375,
+                 "vmemory_min":207.8359375,
+                 "vmemory_max":278.546875,
+                 "processes":3,
+                 "process":{
+                    "start_time":"2026-07-24T06:11:45",
+                    "cpu_num":1,
+                    "cpu_pcent":0.0,
+                    "pmemory":100.6171875,
+                    "vmemory":207.8359375,
+                    "children":[
+                       {
+                          "start_time":"2026-07-24T06:11:46",
+                          "cpu_num":2,
+                          "cpu_pcent":0.0,
+                          "pmemory":95.4140625,
+                          "vmemory":277.4609375
+                       },
+                       {
+                          "start_time":"2026-07-24T06:11:46",
+                          "cpu_num":3,
+                          "cpu_pcent":0.0,
+                          "pmemory":95.99609375,
+                          "vmemory":278.546875,
+                       }
+                    ]
+                 }
+              },
+              "system":{
+                 "cpu_pcent":13.1,
+                 "cpucores_pcent":[
+                    15.4,
+                    12.2,
+                    12.0,
+                    12.7
+                 ],
+                 "memory_total":31.279705047607422,
+                 "memory_used":12.220211029052734,
+                 "memory_pcent":39.06753919339612,
+                 "bytes_sent":9099207,
+                 "bytes_recv":9055029
+              },
+              "volumes":{
+                 "/app/captcha":{
+                    "size":1024,
+                    "used":0,
+                    "pcent":0.006103515625,
+                    "unit":"M"
+                 }
+              },
+              "hostname":"auth2-uat11-5b495b67cb-dpdjp"
+           },
+           "summary":{
+              "cpu_total":0.0,
+              "cpu_min":0.0,
+              "cpu_max":0.0,
+              "process_cpu_min":0.0,
+              "process_cpu_max":0.0,
+              "pmemory_total":584.30859375,
+              "pmemory_min":292.02734375,
+              "pmemory_max":292.28125,
+              "process_pmemory_min":95.4140625,
+              "process_pmemory_max":100.828125,
+              "vmemory_total":1527.97265625,
+              "vmemory_min":763.84375,
+              "vmemory_max":764.12890625,
+              "process_vmemory_min":207.8359375,
+              "process_vmemory_max":278.59765625,
+              "processes_total":6,
+              "workloads_running":2,
+              "workloads_failed":0
+           }
+        }
+    
+        

{dbca_utils-3.0.9 → dbca_utils-3.0.11}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "dbca-utils"
-version = "3.0.9"
+version = "3.0.11"
 description = "Utilities for DBCA Django apps"
 authors = [
     { name = "Rocky Chen", email = "rocky.chen@dbca.wa.gov.au" },

{dbca_utils-3.0.9 → dbca_utils-3.0.11}/src/dbca_utils/healthcheck/healthcheck.py

@@ -1,5 +1,6 @@
 import os
 import importlib
+from collections import OrderedDict
 import logging
 import psutil
 import subprocess
@@ -322,17 +323,19 @@ def get_workload_app_healthdata(perprocess=True):
     return result
 
 def get_workload_healthdata():
+    try:
+        result = {
+            "resources": get_workload_app_healthdata(HEALTHCHECK_PROCESSDATA_ENABLED)
+        }
+        if HEALTHCHECK_SYSTEMDATA_ENABLED:
+            result["system"] = get_workload_system_healthdata()
 
-    result = {
-        "resources": get_workload_app_healthdata(HEALTHCHECK_PROCESSDATA_ENABLED)
-    }
-    if HEALTHCHECK_SYSTEMDATA_ENABLED:
-        result["system"] = get_workload_system_healthdata()
-
-    if WORKLOAD_VOLUMES_ENABLED:
-        result["volumes"] = get_volumes_healthdata()
+        if WORKLOAD_VOLUMES_ENABLED:
+            result["volumes"] = get_volumes_healthdata()
 
-    return (200,result)
+        return (200,result)
+    except Exception as ex:
+        return (500,"{}:{}".format(ex.__classs__.__name__,str(ex)))
 
 bearer_token_re = re.compile("^Bearer\\s+(?P<token>\\S+)\\s*$")
 def get_auth_bearer(request):
@@ -458,6 +461,9 @@ def populate_summary_data(datas):
         "workloads_running":0,
         "workloads_failed":0,
     }
+    if settings.DEBUG:
+        summary["currentworkload"] = registerhostname
+
     for servername,serverdata in datas.items():
         if isinstance(serverdata,str):
             summary["workloads_failed"] += 1
@@ -527,8 +533,6 @@ def harvest_healthdata(request):
             continue
         if servername == registerhostname:
             servers_res[servername] = get_workload_healthdata()
-            if settings.DEBUG:
-                servers_res[servername]["currentworkload"] = True
             continue
 
         serverip,port = serverdata[0]
@@ -562,19 +566,25 @@ def harvest_healthdata(request):
                 workloads_changed = True
         elif res.status_code == 599:
             #the server is in good health, add the health data to servers_res
-            data = res.json()
-            if data["status"] == 401:
-                #authentication error, caused by different workload.
+            try:
+                data = res.json()
+                if data["status"] == 401:
+                    #authentication error, caused by different workload.
+                    workloads_changed = True
+                    unreached_servers.append(servername)
+                    servers_res[servername] = (503,"{1}:{2},url={0}".format(url,data["status"],data["message"]))
+                else:
+                    servers_res[servername] = (500,"{1}:{2}. url={0}".format(url,data["status"],data["message"]))
+            except:
                 workloads_changed = True
                 unreached_servers.append(servername)
-                servers_res[servername] = (res.status_code,"{1}:{2},url={0}".format(url,data["status"],data["message"]))
-            else:
-                servers_res[servername] = (res.status_code,"{1}:{2}. url={0}".format(url,data["status"],data["message"]))
+                servers_res[servername] = (503,"Web server is offline.url={0}".format(url))
+
         else:
             #unexpected error, caused by different workload
             workloads_changed = True
             unreached_servers.append(servername)
-            servers_res[servername] = (res.status_code,"{1}:{2},url={0}".format(url,res.status_code,res.text))
+            servers_res[servername] = (500,"{1}:{2},url={0}".format(url,res.status_code,res.text))
 
     for servername in unreached_servers:
         del workloads[servername]
@@ -586,7 +596,7 @@ def harvest_healthdata(request):
 
     return (workloads,servers_res)
 
-OFFLINE_STATUSCODE_LIST = (502,503,504,401,403,-1,-2)
+OFFLINE_STATUSCODE_LIST = (502,503,504,401,403,-1)
 if WORKLOADS > 0 and WORKLOAD_DEPLOYMENT:
     #has a fixed number of workloads and it is a deployment
     WORKLOADNAMES = [get_workloadname(index) for index in range(WORKLOADS)]
@@ -619,6 +629,7 @@ if WORKLOADS > 0 and WORKLOAD_DEPLOYMENT:
 
         assignedworkloads_changed = False
         if len(WORKLOADNAMES) != len(assignedworkloads):
+            #remove the unexisted workloads from assignedworkloads.
             for key in [k for k in assignedworkloads.keys()]:
                 if key == item_version:
                     continue
@@ -640,7 +651,7 @@ if WORKLOADS > 0 and WORKLOAD_DEPLOYMENT:
                         #related server is online.no need to reassign
                         continue
                     elif step == 1:
-                        #step 1 only reassign the assigned workloads
+                        #step 1 only reassign the already assigned workloads
                         if workloadname not in assignedworkloads:
                             continue
                     replacedservername = None
@@ -675,13 +686,20 @@ if WORKLOADS > 0 and WORKLOAD_DEPLOYMENT:
                 save_assignedworkloads(assignedworkloads)
 
         #map the healthdata result to workload. and remove status code
-        result = {}
+        result = OrderedDict()
         for workloadname in WORKLOADNAMES:
             servername = assignedworkloads.get(workloadname)
             if not servername:
-                result[workloadname] = "Can't find an available host for this non-assigned host.registered workloads: {0}, assigned workloads:{1}".format(str_workloads(workloads),assignedworkloads)
+                if settings.DEBUG:
+                    result[workloadname] = "Can't find an available host for this non-assigned host.registered workloads: {0}, assigned workloads:{1}".format(str_workloads(workloads),assignedworkloads)
+                else:
+                    result[workloadname] = "Can't find an available host for this non-assigned host."
             elif servername not in datas:
-                result[workloadname] = "Can't find an available host for this assigned offline host({2}).registered workloads: {0}, assigned workloads:{1}".format(str_workloads(workloads),assignedworkloads,servername)
+                if settings.DEBUG:
+                    result[workloadname] = "Can't find an available host for this assigned offline host({2}).registered workloads: {0}, assigned workloads:{1}".format(str_workloads(workloads),assignedworkloads,servername)
+                else:
+                    result[workloadname] = "Can't find an available host for this assigned offline host({0}).".format(servername)
+
             elif datas[servername][0] == 200:
                 result[workloadname] = datas[servername][1]
                 result[workloadname]["hostname"] = servername
@@ -700,7 +718,7 @@ elif WORKLOADS > 0 and not WORKLOAD_DEPLOYMENT:
     def healthdata_view(request):
         workloads,servers_res = harvest_healthdata(request)
 
-        result = {}
+        result = OrderedDict()
         for servername in WORKLOADNAMES:
             if result in servers_res:
                 result[servername] = servers_res[servername][1]
@@ -710,17 +728,45 @@ elif WORKLOADS > 0 and not WORKLOAD_DEPLOYMENT:
         populate_summary_data(result)
 
         return JsonResponse(result)
-else:
+elif WORKLOAD_DEPLOYMENT:
     def healthdata_view(request):
         workloads,servers_res = harvest_healthdata(request)
 
-        result = {}
+        result = OrderedDict()
         for servername, serverdata in servers_res.items():
+            if serverdata[0] in OFFLINE_STATUSCODE_LIST:
+                continue
             result[servername] = serverdata[1]
 
         populate_summary_data(result)
 
         return JsonResponse(result)
+else:
+    def healthdata_view(request):
+        workloads,servers_res = harvest_healthdata(request)
+
+        #get all workload names
+        workloadnames = [k for k in workloads.keys() if k != item_version ]
+
+        #find the name of the last available workload
+        workloadnames.sort(key=lambda d:int(d[8:]))
+        last_workloadname = next((name for name in reversed(workloadnames) if servers_res.get(name,[503,"Workload is Offline"])[0] not in OFFLINE_STATUSCODE_LSIT ) ,None)
+
+        result = OrderedDict()
+        if last_workloadname:
+            #find the index of the last available workload
+            last_workloadindex = int(last_workloadname[8:])
+
+            #Return the healthdata of the workloads whose index is from 0 to last_workloadindex(include)
+            for i in range(last_workloadindex + 1):
+                servername = get_workloadname(i)
+                serverdata = servers_res.get(servername,[503,"Workload is offline"])
+                result[servername] = serverdata[1]
+
+        populate_summary_data(result)
+
+        return JsonResponse(result)
+
 
 def workload_healthdata_view(request):
     global secret
@@ -742,7 +788,7 @@ def workload_healthdata_view(request):
         if statuscode == 200:
             return JsonResponse(data)
         else:
-            return JsonResponse({"status":500,"message":"Server Error"},status=599)
+            return JsonResponse({"status":statuscode,"message":data},status=599)
     except Exception as ex:
         return JsonResponse({"status":500,"message":"{}:{}".format(ex.__class__.__name__,str(ex))},status=599)
 

dbca_utils-3.0.9/README.md

@@ -1,285 +0,0 @@
-# Overview
-
-DBCA Django utility classes and functions.
-
-## Requirements
-
-- Python 3.12 or later
-- Django 5.2 or later
-
-## Development
-
-Dependencies for this project are managed using [uv](https://docs.astral.sh/uv/).
-With uv installed, change into the project directory and run:
-
-    uv sync
-
-Activate the virtualenv like so:
-
-    source .venv/bin/activate
-
-Run unit tests using `pytest` (or `tox`, to test against multiple Python versions):
-
-    pytest -sv
-    tox -v
-
-## Releases
-
-Tagged releases are built and pushed to PyPI automatically using a GitHub
-workflow in the project. Update the project version in `pyproject.toml` and
-tag the required commit with the same value to trigger a release. Packages
-can also be built and uploaded manually to PyPI using [uv](https://docs.astral.sh/uv/guides/publish/#publishing-your-package),
-if required:
-
-    uv build
-    uv publish
-
-## Installation
-
-1. Install via uv/pip/etc.: `pip install dbca-utils`
-
-## SSO Login Middleware
-
-This will automatically login and create users using headers from an upstream proxy (REMOTE_USER and some others).
-The logout view will redirect to a separate logout page which clears the SSO session.
-
-### Usage
-
-Add `dbca_utils.middleware.SSOLoginMiddleware` to `settings.MIDDLEWARE` (after both of
-`django.contrib.sessions.middleware.SessionMiddleware` and
-`django.contrib.auth.middleware.AuthenticationMiddleware`.
-Ensure that `AUTHENTICATION_BACKENDS` contains `django.contrib.auth.backends.ModelBackend`,
-as this middleware depends on it for retrieving the logged in user for a session.
-Note that the middleware will still work without it, but will reauthenticate the session
-on every request, and `request.user.is_authenticated` won't work properly/will be false.
-
-Example:
-
-```python
-MIDDLEWARE = [
-    ...,
-    'django.contrib.sessions.middleware.SessionMiddleware',
-    'django.contrib.auth.middleware.AuthenticationMiddleware',
-    'dbca_utils.middleware.SSOLoginMiddleware'
-    ...,
-]
-```
-
-## Audit model mixin
-
-`AuditMixin` is an extension of `Django.db.model.Model` that adds a number of additional fields:
-
-- `creator` - FK to `AUTH_USER_MODEL`, used to record the object creator
-- `modifier` - FK to `AUTH_USER_MODEL`, used to record who the object was last modified by
-- `created` - a timestamp that is set on initial object save
-- `modified` - an auto-updating timestamp (on each object save)
-  
-## Healthcheck feature
-### Requirements
-  - Django 5.2 or later
-  - Declared the default cache and also the cache is shared by all pod instances
-    
-  ### Usage
-  - Install the app 'dbca_utils' in INSTALLED_APPS
-  - Service Configuration
-      - HEALTHCHECK_ENABLED: Optional. enable/disable the healthcheck service. default is 'true'
-      - CACHE_PREFIX: Optional. used as the prefix of the cache key. default is ''
-      - PORT: Optional. The listening port of the web application. default is '8080', used to send request to peer pod instance to get the resouces usage of the peer pod instance.
-      - WORKLOADS: Optional. Used if the web app has a fixed replicas.
-      - WORKLOAD_DEPLOYMENT: Optional. the workload is deployment if it is true; otherwise it is statefulset. default is 'true'
-      - WORKLOAD_FAILED_THRESHOLD: Optional. The number of continuous failed times to decide that a pod is offline.
-      - WORKLOAD_VOLUMES: Optional. can be 'disabled', 'false','automatic' or "," separated volume mounted point. default is "automatic".
-          - disabled|false: Don't harvest volume usage data
-          - automatic: Detect the persistent volume automatically.
-          - "," separated volume mounted points: the volume list
-      - HEALTHCHECK_SYSTEMDATA_ENABLED: Enable system resource data
-      - HEALTHCHECK_PROCESSDATA_ENABLED: Enable process resource data
-  - Endpoints added by this app
-      - /healthcheck/healthdata: An endpoint for client to harvest the resources usage data. This endpoint should be cofigured to use basic auth in nginx reverse proxy.
-      - /workload/healthcheck/healthdata: An internal endpoint used to get the resource usage of the peer pod instance. This endpoing should not be exposed in nginx reverse proxy.
-  - Nginx Configuration.
-      - Add a location 'location /healthcheck/' and configure it to use basic auth in nginx.
-  - Access the url : https://xxx.dbca.wa.gov.au/healthcheck/healthdata to get the health json data
-  - The sample data of the health data:
-  {
-   "workload0":{
-      "resources":{
-         "start_time":"2026-07-24T06:10:23",
-         "cpu_total":0.0,
-         "cpu_min":0.0,
-         "cpu_max":0.0,
-         "pmemory_total":292.28125,
-         "pmemory_min":95.53515625,
-         "pmemory_max":100.828125,
-         "vmemory_total":764.12890625,
-         "vmemory_min":207.8671875,
-         "vmemory_max":278.59765625,
-         "processes":3,
-         "process":{
-            "start_time":"2026-07-24T06:10:23",
-            "cmdline":[
-               "/app/.venv/bin/python",
-               "/app/.venv/bin/gunicorn",
-               "authome.wsgi",
-               "--config=gunicorn_gevent.py"
-            ],
-            "cpu_num":0,
-            "cpu_pcent":0.0,
-            "pmemory":100.828125,
-            "vmemory":207.8671875,
-            "children":[
-               {
-                  "start_time":"2026-07-24T06:10:24",
-                  "cmdline":[
-                     "/app/.venv/bin/python",
-                     "/app/.venv/bin/gunicorn",
-                     "authome.wsgi",
-                     "--config=gunicorn_gevent.py"
-                  ],
-                  "cpu_num":1,
-                  "cpu_pcent":0.0,
-                  "pmemory":95.53515625,
-                  "vmemory":277.6640625
-               },
-               {
-                  "start_time":"2026-07-24T06:10:24",
-                  "cmdline":[
-                     "/app/.venv/bin/python",
-                     "/app/.venv/bin/gunicorn",
-                     "authome.wsgi",
-                     "--config=gunicorn_gevent.py"
-                  ],
-                  "cpu_num":3,
-                  "cpu_pcent":0.0,
-                  "pmemory":95.91796875,
-                  "vmemory":278.59765625,
-                  "currentprocess":true
-               }
-            ]
-         }
-      },
-      "system":{
-         "cpu_pcent":0.0,
-         "cpucores_pcent":[
-            0.0,
-            0.0,
-            0.0,
-            0.0
-         ],
-         "memory_total":31.279705047607422,
-         "memory_used":12.220211029052734,
-         "memory_pcent":39.06753919339612,
-         "bytes_sent":9028205,
-         "bytes_recv":9246094
-      },
-      "volumes":{
-         "/app/captcha":{
-            "size":1024,
-            "used":0,
-            "pcent":0.006103515625,
-            "unit":"M"
-         }
-      },
-      "hostname":"auth2-uat11-5b495b67cb-z8vwj"
-   },
-   "workload1":{
-      "resources":{
-         "start_time":"2026-07-24T06:11:45",
-         "cpu_total":0.0,
-         "cpu_min":0.0,
-         "cpu_max":0.0,
-         "pmemory_total":292.02734375,
-         "pmemory_min":95.4140625,
-         "pmemory_max":100.6171875,
-         "vmemory_total":763.84375,
-         "vmemory_min":207.8359375,
-         "vmemory_max":278.546875,
-         "processes":3,
-         "process":{
-            "start_time":"2026-07-24T06:11:45",
-            "cmdline":[
-               "/app/.venv/bin/python",
-               "/app/.venv/bin/gunicorn",
-               "authome.wsgi",
-               "--config=gunicorn_gevent.py"
-            ],
-            "cpu_num":1,
-            "cpu_pcent":0.0,
-            "pmemory":100.6171875,
-            "vmemory":207.8359375,
-            "children":[
-               {
-                  "start_time":"2026-07-24T06:11:46",
-                  "cmdline":[
-                     "/app/.venv/bin/python",
-                     "/app/.venv/bin/gunicorn",
-                     "authome.wsgi",
-                     "--config=gunicorn_gevent.py"
-                  ],
-                  "cpu_num":2,
-                  "cpu_pcent":0.0,
-                  "pmemory":95.4140625,
-                  "vmemory":277.4609375
-               },
-               {
-                  "start_time":"2026-07-24T06:11:46",
-                  "cmdline":[
-                     "/app/.venv/bin/python",
-                     "/app/.venv/bin/gunicorn",
-                     "authome.wsgi",
-                     "--config=gunicorn_gevent.py"
-                  ],
-                  "cpu_num":3,
-                  "cpu_pcent":0.0,
-                  "pmemory":95.99609375,
-                  "vmemory":278.546875,
-                  "currentprocess":true
-               }
-            ]
-         }
-      },
-      "system":{
-         "cpu_pcent":13.1,
-         "cpucores_pcent":[
-            15.4,
-            12.2,
-            12.0,
-            12.7
-         ],
-         "memory_total":31.279705047607422,
-         "memory_used":12.220211029052734,
-         "memory_pcent":39.06753919339612,
-         "bytes_sent":9099207,
-         "bytes_recv":9055029
-      },
-      "volumes":{
-         "/app/captcha":{
-            "size":1024,
-            "used":0,
-            "pcent":0.006103515625,
-            "unit":"M"
-         }
-      },
-      "hostname":"auth2-uat11-5b495b67cb-dpdjp"
-   },
-   "summary":{
-      "cpu_total":0.0,
-      "cpu_min":0.0,
-      "cpu_max":0.0,
-      "process_cpu_min":0.0,
-      "process_cpu_max":0.0,
-      "pmemory_total":584.30859375,
-      "pmemory_min":292.02734375,
-      "pmemory_max":292.28125,
-      "process_pmemory_min":95.4140625,
-      "process_pmemory_max":100.828125,
-      "vmemory_total":1527.97265625,
-      "vmemory_min":763.84375,
-      "vmemory_max":764.12890625,
-      "process_vmemory_min":207.8359375,
-      "process_vmemory_max":278.59765625,
-      "processes_total":6,
-      "workloads_running":2,
-      "workloads_failed":0
-   }
-}