example.yaml

# Run the following command to see how metrics defined below are collected:
#
# MIKE_CONFIG=example.yaml collect_metrics

# dashboard name
name: "The Example dashboard"

# first, we specify settings for generic sources like Jira and MySQL
# they need credentials and host name
sources: []

# where will metrics be stored
storage:
  engine: mysql
  host: ''
  database: ''
  user: ''
  password: ''

# now define metrics that are taken from sources above
metrics:
  - name: lubimy_czytac/rating
    source: http/xpath  # use the base source directly here
    url: "http://lubimyczytac.pl/ksiazka/{book_id}"
    xpath: '//*[@itemprop="aggregateRating"]//*[@itemprop="ratingValue"]'
    label: "Book rating: %d"
  - name: lubimy_czytac/wants_to_read
    source: http/xpath  # use the base source directly here
    url: "http://lubimyczytac.pl/ksiazka/{book_id}"
    xpath: '//*[@id="ajaxShelfsBox"]//*[@data-shelf-id-counter="3"]'
    label: "Wants to read: %d"

  - name: wikipedia/stats
    source: http/json  # let's use the base source directly here
    url: "https://{wikipedia_domain}.wikipedia.org/w/api.php?action=query&meta=siteinfo&siprop=statistics&format=json"
    jq: ".query.statistics.{stats_field}"
    label: "{wikipedia_domain} Wikipedia {stats_field}: %d"

# these keys will be copied to each feature defined below
common:
  metrics:
    -  name: lubimy_czytac/rating

# now features "score" will be calculated using the metrics defined above with per-feature parameters set
features:
    - name: PanTadeusz
      url: "http://lubimyczytac.pl/ksiazka/4871036/pan-tadeusz"
      template:
        book_id: 4871036
      metrics:
        # additional metric just for this book
        - name: lubimy_czytac/wants_to_read

    - name: "Wojna i Pókój"
      url: "http://lubimyczytac.pl/ksiazka/4869384/wojna-i-pokoj-tom-1"
      template:
        book_id: 4869384

    - name: PolishWikipedia
      template:
        wikipedia_domain: pl
        stats_field: "articles"
      metrics:
        - name: wikipedia/stats