qontract-reconcile 0.10.2.dev260__py3-none-any.whl → 0.10.2.dev261__py3-none-any.whl

{qontract_reconcile-0.10.2.dev260.dist-info → qontract_reconcile-0.10.2.dev261.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qontract-reconcile
-Version: 0.10.2.dev260
+Version: 0.10.2.dev261
 Summary: Collection of tools to reconcile services with their desired state as defined in the app-interface DB.
 Project-URL: homepage, https://github.com/app-sre/qontract-reconcile
 Project-URL: repository, https://github.com/app-sre/qontract-reconcile
@@ -449,6 +449,22 @@ GQL definitions and generated classes can be found [here](reconcile/gql_definiti
 
 `faulthandler` is enabled for this project and SIGUSR1 is registered to dump the traceback. To do so, you can use `kill -USR1 pid` where pid is the ID of the qontract-reconcile process.
 
+## Profiling
+
+Enable the Python cProfile module by setting the environment variable `ENABLE_PROFILING=1` before running the integration. This will generate a profile file `/tmp/profile.prof`.
+
+You can then analyze the profile using `snakeviz`:
+
+```sh
+snakeviz /tmp/profile.prof
+```
+
+> :information_source: Note
+>
+> `cProfile` doesn't support multithreading, but it can still highlight performance issues on the main thread.
+> If you need to profile multithreaded code, consider using [py-spy](https://github.com/benfred/py-spy) or similar tools that support sampling profiling.
+> Also [memray](https://github.com/bloomberg/memray) could be beneficial for memory profiling.
+
 ## Code style guide
 
 Qontract-reconcile uses [PEP8](https://peps.python.org/pep-0008/) as the code style guide.

{qontract_reconcile-0.10.2.dev260.dist-info → qontract_reconcile-0.10.2.dev261.dist-info}/RECORD

@@ -93,7 +93,7 @@ reconcile/query_validator.py,sha256=MSh5pKLBksws4AqfuvT8nrIGucIbqX-IOzYyPYTLO7k,
 reconcile/requests_sender.py,sha256=914iluuF4UVgG3VyxxtnHOu4yf6YKS2fIy6PViSsFTQ,3875
 reconcile/resource_scraper.py,sha256=znXCHrU7YwPfKuxGBiUrV7T1tYtn4vlz9qmZlfy6Flg,2307
 reconcile/resource_template_tester.py,sha256=DsKvBuNLPxm4Fa-e1YHHySnhThm5i_j-nF3G4b02Mz0,2416
-reconcile/run_integration.py,sha256=BMqJi7LbLs2fqmfH8ctl2hYcGulHG-n3QxEnIgGfw18,9713
+reconcile/run_integration.py,sha256=brbNFEQpHLeLIEN-sDpIctyrx8aiL5Vu9YLecdwwykk,10221
 reconcile/saas_file_validator.py,sha256=tyvFYU6lnkfDYIkAIr5pWqSvO5Yc6TagZ-quJYD2dtI,2547
 reconcile/sendgrid_teammates.py,sha256=oO8QbLb4s1o8A6CGiCagN9CmS05BSS_WLztuY0Ym9D8,4773
 reconcile/service_dependencies.py,sha256=G2qCuYFc8wQLpRxkdhmibxSAl3nUM3hcan4x50W_mCA,4335
@@ -797,7 +797,7 @@ tools/saas_promotion_state/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJ
 tools/saas_promotion_state/saas_promotion_state.py,sha256=oF7C4hpIgyMTwTRm3Aun3cDCHIjVar65JoLp6NcJHlU,3909
 tools/sre_checkpoints/__init__.py,sha256=CDaDaywJnmRCLyl_NCcvxi-Zc0hTi_3OdwKiFOyS39I,145
 tools/sre_checkpoints/util.py,sha256=zEDbGr18ZeHNQwW8pUsr2JRjuXIPz--WAGJxZo9sv_Y,894
-qontract_reconcile-0.10.2.dev260.dist-info/METADATA,sha256=6cfFbvQPSnVWrRXsxLdQLiQc_ZvulzFgB9qX9GILh_E,23827
-qontract_reconcile-0.10.2.dev260.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-qontract_reconcile-0.10.2.dev260.dist-info/entry_points.txt,sha256=5i9l54La3vQrDLAdwDKQWC0iG4sV9RRfOb1BpvzOWLc,698
-qontract_reconcile-0.10.2.dev260.dist-info/RECORD,,
+qontract_reconcile-0.10.2.dev261.dist-info/METADATA,sha256=FfdtlJxjSP74I6Qi-sXO-lkipfa8ghTnPug-yPAWJ4Y,24501
+qontract_reconcile-0.10.2.dev261.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+qontract_reconcile-0.10.2.dev261.dist-info/entry_points.txt,sha256=5i9l54La3vQrDLAdwDKQWC0iG4sV9RRfOb1BpvzOWLc,698
+qontract_reconcile-0.10.2.dev261.dist-info/RECORD,,

reconcile/run_integration.py

@@ -1,5 +1,7 @@
 #!/usr/bin/env python3
 
+import contextlib
+import cProfile
 import logging
 import os
 import sys
@@ -78,6 +80,15 @@ if LOG_FILE is not None:
 logging.basicConfig(level=LOG_LEVEL, handlers=HANDLERS)
 
 
+PROFILE_DUMP_FILE = os.environ.get("PROFILE_DUMP_FILE", "/tmp/profile.prof")
+profiling_enabled = os.environ.get("ENABLE_PROFILING", "").lower() in {
+    "true",
+    "1",
+    "yes",
+}
+profiler = cProfile.Profile() if profiling_enabled else contextlib.nullcontext()
+
+
 class PushgatewayBadConfigError(Exception):
     pass
 
@@ -238,7 +249,11 @@ def main() -> None:
         try:
             with command.make_context(info_name=COMMAND_NAME, args=args) as ctx:  # type: ignore
                 ctx.ensure_object(dict)
-                command.invoke(ctx)
+                with profiler as pr:
+                    command.invoke(ctx)
+                    if pr:
+                        LOG.info(f"Profiling data written to {PROFILE_DUMP_FILE}")
+                        pr.dump_stats(PROFILE_DUMP_FILE)
                 return_code = 0
         # This is for when the integration explicitly
         # calls sys.exit(N)