[executors] feat: switch to typer for CLI

* Add missing __init__.py to entrypoints
* Unify logging across library

Author: AndreyMarkinPPC

libs/exporters/garf_exporter/__init__.py

@@ -19,4 +19,4 @@
   'GarfExporter',
 ]
 
-__version__ = '0.0.2'
+__version__ = '0.0.3'

libs/exporters/garf_exporter/entrypoints/__init__.py

@@ -20,19 +20,24 @@
 
 from __future__ import annotations
 
-import argparse
 import asyncio
 import contextlib
 import datetime
+from typing import Literal
 
 import fastapi
-import garf_exporter
 import prometheus_client
 import requests
+import typer
 import uvicorn
 from garf_executors.entrypoints import utils as garf_utils
+from typing_extensions import Annotated
+
+import garf_exporter
 from garf_exporter import exporter_service
 
+typer_app = typer.Typer()
+
 
 class GarfExporterError(Exception):
   """Base class for GarfExporter errors."""
@@ -80,12 +85,6 @@ def healthcheck(host: str, port: int) -> bool:
 metrics_app = prometheus_client.make_asgi_app(registry=exporter.registry)
 app.mount('/metrics', metrics_app)
 
-logger = garf_utils.init_logging(
-  loglevel='INFO',
-  logger_type='rich',
-  name='garf-exporter',
-)
-
 
 async def start_metric_generation(
   request: exporter_service.GarfExporterRequest,
@@ -129,44 +128,82 @@ def health(request: fastapi.Request):
     raise fastapi.HTTPException(status_code=404, detail='Not updated properly')
 
 
-def main() -> None:  # noqa: D103
-  parser = argparse.ArgumentParser()
-  parser.add_argument('-s', '--source', dest='source')
-  parser.add_argument('-c', '--config', dest='config', default=None)
-  parser.add_argument('--log', '--loglevel', dest='loglevel', default='info')
-  parser.add_argument(
-    '--expose-type',
-    dest='expose_type',
-    choices=['http', 'pushgateway'],
-    default='http',
-  )
-  parser.add_argument('--host', dest='host', default='0.0.0.0')
-  parser.add_argument('--port', dest='port', type=int, default=8000)
-  parser.add_argument('--logger', dest='logger', default='local')
-  parser.add_argument('--iterations', dest='iterations', default=None, type=int)
-  parser.add_argument('--delay-minutes', dest='delay', type=int, default=15)
-  parser.add_argument('--namespace', dest='namespace', default='garf')
-  parser.add_argument('--max-parallel', dest='parallel', default=None)
-  parser.add_argument(
-    '--fetching-timeout-seconds', dest='fetching_timeout', default=120, type=int
+@typer_app.command(
+  context_settings={'allow_extra_args': True, 'ignore_unknown_options': True}
+)
+def main(
+  ctx: typer.Context,
+  source: Annotated[
+    str,
+    typer.Option(
+      '-s', '--source', help='API alias', prompt='Please add API alias'
+    ),
+  ],
+  config: Annotated[
+    str,
+    typer.Option(
+      '-c',
+      '--config',
+      help='Path to configuration file',
+      prompt='Please add path to config file.',
+    ),
+  ],
+  expose_type: Annotated[
+    str,
+    typer.Option(help='Type of metric expose'),
+  ] = 'http',
+  loglevel: Annotated[
+    str,
+    typer.Option(help='Level of logging'),
+  ] = 'INFO',
+  logger: Annotated[
+    str,
+    typer.Option(help='Type of logging'),
+  ] = 'rich',
+  namespace: Annotated[
+    str,
+    typer.Option(help='Namespace prefix for Prometheus'),
+  ] = 'garf',
+  host: Annotated[
+    str,
+    typer.Option(help='Host for exposing metrics'),
+  ] = '0.0.0.0',
+  port: Annotated[
+    int,
+    typer.Option(help='Port for exposing metrics'),
+  ] = 8000,
+  delay_minutes: Annotated[
+    int,
+    typer.Option(help='Delay in minutes between exports'),
+  ] = 15,
+  fetching_timeout: Annotated[
+    int,
+    typer.Option(help='Timeout in second for restarting stale exports'),
+  ] = 120,
+  iterations: Annotated[
+    int,
+    typer.Option(help='Stop export after N iterations'),
+  ] = 0,
+) -> None:
+  garf_utils.init_logging(
+    loglevel=loglevel,
+    logger_type=logger,
+    name='garf-exporter',
   )
-  parser.add_argument('--collectors', dest='collectors', default='default')
-  parser.add_argument('-v', '--version', dest='version', action='store_true')
-  args, kwargs = parser.parse_known_args()
-  cli_parameters = garf_utils.ParamsParser(['macro', 'source']).parse(kwargs)
+  cli_parameters = garf_utils.ParamsParser(['macro', 'source']).parse(ctx.args)
   runtime_options = exporter_service.GarfExporterRuntimeOptions(
-    expose_type=args.expose_type,
-    host=args.host,
-    port=args.port,
-    namespace=args.namespace,
-    fetching_timeout=args.fetching_timeout,
-    iterations=args.iterations,
-    delay_minutes=args.delay,
+    expose_type=expose_type,
+    host=host,
+    port=port,
+    namespace=namespace,
+    fetching_timeout=fetching_timeout,
+    iterations=iterations,
+    delay_minutes=delay_minutes,
   )
   request = exporter_service.GarfExporterRequest(
-    source=args.source,
+    source=source,
     source_parameters=cli_parameters.get('source'),
-    collectors_config=args.config,
+    collectors_config=config,
     macros=cli_parameters.get('macro'),
     runtime_options=runtime_options,
   )
@@ -187,4 +224,4 @@ async def start_uvicorn():
 
 
 if __name__ == '__main__':
-  main()
+  typer_app()

libs/exporters/garf_exporter/entrypoints/cli.py

@@ -26,6 +26,8 @@
 import garf_core
 import prometheus_client
 
+logger = logging.getLogger(__name__)
+
 
 class GarfExporter:
   """Exposes reports from Ads API in Prometheus format.
@@ -181,7 +183,7 @@ def _define_metrics(
     if virtual_columns := query_specification.virtual_columns:
       for column, field in virtual_columns.items():
         metrics[column] = self._define_gauge(column, suffix, labels, namespace)
-    logging.debug('metrics: %s', metrics)
+    logger.debug('metrics: %s', metrics)
     return metrics
 
   def _define_labels(
@@ -205,7 +207,7 @@ def _define_labels(
     for column, field in zip(non_virtual_columns, query_specification.fields):
       if 'metric' not in field and 'metric' not in column:
         labelnames.append(str(column))
-    logging.debug('labelnames: %s', labelnames)
+    logger.debug('labelnames: %s', labelnames)
     return labelnames
 
   def _define_gauge(

libs/exporters/garf_exporter/exporter.py

@@ -30,6 +30,8 @@
 import garf_exporter
 from garf_exporter import collector
 
+logger = logging.getLogger(__name__)
+
 
 class GarfExporterRuntimeOptions(pydantic.BaseModel):
   """Options to finetune exporting process.
@@ -121,14 +123,14 @@ def generate_metrics(
       request: Complete request to fetch and expose data.
       exporter: Initialized GarfExporter.
     """
-    logging.info('Beginning export')
+    logger.info('Beginning export')
     start_export_time = time()
     exporter.export_started.set(start_export_time)
     collectors = request.collectors or collector.load_collector_data(
       request.collectors_config
     )
     for col in collectors:
-      logging.info('Exporting from collector: %s', col.title)
+      logger.info('Exporting from collector: %s', col.title)
       start = time()
       report = self.fetcher.fetch(col.query, **self.source_parameters)
       end = time()
@@ -138,7 +140,7 @@ def generate_metrics(
         suffix=col.suffix,
         collector=col.title,
       )
-    logging.info('Export completed')
+    logger.info('Export completed')
     end_export_time = time()
     exporter.export_completed.set(end_export_time)
     exporter.total_export_time_gauge.set(end_export_time - start_export_time)

libs/exporters/garf_exporter/exporter_service.py

@@ -11,6 +11,7 @@ dependencies = [
   "pydantic",
   "fastapi",
   "uvicorn",
+  "typer",
 ]
 authors = [
   {name = "Andrei Markin", email = "andrey.markin.ppc@gmail.com"},
@@ -39,4 +40,4 @@ dynamic = ["version"]
 version = {attr = "garf_exporter.__version__"}
 
 [project.scripts]
-garf-exporter="garf_exporter.entrypoints.cli:main"
+garf-exporter="garf_exporter.entrypoints.cli:typer_app"