swh.counters package

Subpackages:

• swh.counters.api package
  • swh.counters.api.client module
    • RemoteCounters
  • swh.counters.api.server module
    • make_app()
    • index()
    • load_and_check_config()
    • make_app_from_configfile()
    • get_metrics()
    • get_history_file_content()

Submodules:

• swh.counters.cli module
• swh.counters.history module
  • History
    • History.get_history()
    • History.refresh_history()
• swh.counters.in_memory module
  • InMemory
    • InMemory.check()
    • InMemory.add()
    • InMemory.get_count()
    • InMemory.get_counts()
    • InMemory.get_counters()
• swh.counters.interface module
  • CountersInterface
    • CountersInterface.check()
    • CountersInterface.add()
    • CountersInterface.get_count()
    • CountersInterface.get_counts()
    • CountersInterface.get_counters()
  • HistoryInterface
    • HistoryInterface.get_history()
    • HistoryInterface.refresh_history()
• swh.counters.journal_client module
  • process_journal_messages()
  • process_revisions()
  • process_releases()
• swh.counters.kafka_client module
  • KeyOrientedJournalClient
    • KeyOrientedJournalClient.handle_messages()
• swh.counters.redis module
  • Redis
    • Redis.redis_client
    • Redis.check()
    • Redis.add()
    • Redis.get_count()
    • Redis.get_counts()
    • Redis.get_counters()

Module contents:

swh.counters.get_counters(cls: str, **kwargs: Dict[str, Any]) → CountersInterface

Get an counters object of class cls with arguments args.

Parameters:

• cls – counters’s class, either ‘local’ or ‘remote’

• args – dictionary of arguments passed to the counters class constructor

Returns:

an instance of swh.counters’s classes (either local or remote)

Raises:

ValueError if passed an unknown counters class. –

swh.counters.get_history(cls: str, **kwargs: Dict[str, Any]) → HistoryInterface

Get a history object of class cls with arguments kwargs.

Parameters:

• cls – history’s class, only ‘prometheus’ is supported actually

• kwargs – dictionary of arguments passed to the counters class constructor

Returns:

an instance of swh.counters.history’s classes (either local or remote)

Raises:

ValueError if passed an unknown history class. –