import argparse import os import time import yaml from prometheus_client import start_http_server, Gauge, Counter from ecommerce_exporter.scrape_target import ScrapeError, ScrapeTarget ECOMMERCE_SCRAPE_TARGET_VALUE = Gauge( 'ecommerce_scrape_target_value', 'The value scraped from a scrape target', ['product_name', 'target_name'], ) ECOMMERCE_SCRAPE_TARGET_SUCCESS = Counter( 'ecommerce_scrape_target_success_total', 'The number of successful scrape and parse of a scrape target', ['product_name', 'target_name'], ) ECOMMERCE_SCRAPE_TARGET_FAILURE = Counter( 'ecommerce_scrape_target_failure_total', 'The number of failed scrape and parse of a scrape target', ['product_name', 'target_name', 'exception'], ) def main(): parser = argparse.ArgumentParser("An utility to scrape e-commerce product price and expose them as prometheus metrics") parser.add_argument( '-c', '--config', help='The configuration file. (default: %(default)s)', type=str, default='ecommerce-exporter.yml', ) parser.add_argument( '-i', '--interval', help='The target scrape interval, in minutes. (default: %(default)s)', type=float, default=15, ) parser.add_argument( '--user-agent', help='The user-agent to spoof. (default: %(default)s)', type=str, default='Mozilla/5.0 (X11; Linux x86_64; rv:131.0) Gecko/20100101 Firefox/131.0', ) parser.add_argument( '-p', '--listen-port', help='The listen port for the http server. (default: %(default)s)', type=int, default=8000, ) parser.add_argument( '-a', '--listen-address', help='The listen address for the http server. (default: %(default)s)', type=str, default='0.0.0.0', ) args = parser.parse_args() scrape_targets = parse_config(os.path.abspath(args.config)) # setup the headers for each scrape targets for scrape_target in scrape_targets: scrape_target.headers = { 'Accept': '*/*', 'User-Agent': args.user_agent, } # start the http server to server the prometheus metrics print("serving metrics on http://%s:%s/metrics" % (args.listen_address, args.listen_port)) start_http_server(args.listen_port, args.listen_address) # start the main loop while True: for scrape_target in scrape_targets: try: print("Starting scrape. product: '%s', target '%s'" % (scrape_target.product_name, scrape_target.target_name)) value = scrape_target.query_target() ECOMMERCE_SCRAPE_TARGET_VALUE.labels( product_name=scrape_target.product_name, target_name=scrape_target.target_name ).set(value) ECOMMERCE_SCRAPE_TARGET_SUCCESS.labels( product_name=scrape_target.product_name, target_name=scrape_target.target_name, ).inc() except KeyboardInterrupt: return except Exception as e: print("Failed to scrape! product: '%s', target: '%s', message: '%s'" % (scrape_target.product_name, scrape_target.target_name, e)) ECOMMERCE_SCRAPE_TARGET_FAILURE.labels( product_name=scrape_target.product_name, target_name=scrape_target.target_name, exception=e.__class__.__name__, ).inc() time.sleep(args.interval * 60) def parse_config(config_filename): result = [] print('Loading configurations from %s' % config_filename) with open(config_filename, 'r') as f: config = yaml.safe_load(f) # iterate through products listed in the configuration products = get_field_or_die(config, 'products') for product in products: product_name = get_field_or_die(product, 'name') # iterate through the targets listed for each products in the configuration targets = get_field_or_die(product, 'targets') for target in targets: # Create a ScrapeTarget for each targets to scrape result.append(ScrapeTarget( product_name=product_name, url=get_field_or_die(target, 'url'), selector=get_field_or_die(target, 'selector'), target_name=target.get('name'), regex=target.get('regex'), parser=target.get('parser'), )) return result def get_field_or_die(mapping, field_name): value = mapping.get(field_name) if value is None: raise Exception('Missing required field: %s' % field_name) else: return value if __name__ == '__main__': main()