added support for metrics

Author: amazy

orthanc_api_client/api_client.py

@@ -35,6 +35,19 @@ def __init__(self, json_stats):
         self.total_uncompressed_size = int(json_stats['TotalUncompressedSize'])
         self.total_uncompressed_size_mb = json_stats['TotalUncompressedSizeMB']
 
+class Metrics:
+    
+    def __init__(self, metricsPrometheusText: str):
+        # mm = self.o.get_binary("/tools/metrics-prometheus").decode("utf-8")
+        self.metrics = {}
+        mm = [x.split(" ") for x in metricsPrometheusText.split("\n")]
+        for m in mm:
+            if len(m) >= 3:
+                self.metrics[m[0]] = m[1]
+
+    def get(self, metric_name: str) -> Optional[str]:
+        return self.metrics.get(metric_name)
+
 
 class OrthancApiClient(HttpClient):
 
@@ -113,6 +126,9 @@ def get_system(self) -> object:
     def get_statistics(self) -> SystemStatistics:
         return SystemStatistics(json_stats=self.get_json('statistics'))
 
+    def get_metrics(self) -> Metrics:
+        return Metrics(metricsPrometheusText=self.get_binary("/tools/metrics-prometheus").decode("utf-8"))
+
     def delete_all_content(self):
         """Deletes all content from Orthanc"""
         self.patients.delete_all()

release-notes.md

@@ -1,5 +1,12 @@
+v 0.24.0
+========
+
+- Added support for metrics.  For example:
+  `orthanc.get_metrics().get('orthanc_available_dicom_threads')`
+
 v 0.23.0
 ========
+
 - Added support for `Worklists` plugin
 - BREAKING CHANGES: 
   - `HttpError` no longer have a `dimse_error_status` field in case of DICOM related errors (it was actually not functional !).

setup.py

@@ -28,7 +28,7 @@
     # For a discussion on single-sourcing the version across setup.py and the
     # project code, see
     # https://packaging.python.org/guides/single-sourcing-package-version/
-    version='0.23.0',  # Required
+    version='0.24.0',  # Required
 
     # This is a one-line description or tagline of what your project does. This
     # corresponds to the "Summary" metadata field:

tests/test_api_client.py

@@ -1860,6 +1860,9 @@ def test_delete_worklist(self):
         wl_list = self.oa.worklists.get_all()
         self.assertEqual(len(wl_list), 0)
 
+    def test_metrics(self):
+        self.assertEqual('4', self.oa.get_metrics().get('orthanc_available_dicom_threads'))
+        self.assertIsNone(self.oa.get_metrics().get('name_that_does_not_exist'))
 
 
 if __name__ == '__main__':