Light

mhansen / domain-exporter Goto Github PK

View Code? Open in Web Editor NEW

1.0 3.0 0.0 126 KB

Dockerfile 20.70% Go 79.30%

domain-exporter's Introduction

Domain exporter

This allows monitoring domain.com.au listings with Prometheus.

API Key

Grab an API key from https://developer.domain.com.au/. Make a project and add an API key. The free API keys only support 500 queries per day, so don't query often!

Building and running

Edit the searches in searches/*.json to be searches that look like the domain /v1/listings/residential/_search request schema.

$ go build .
$ ./domain_exporter --api_key=<domain api key>

Then navigate to http://localhost:10550/listings?suburb=Pyrmont

Building with docker

$ docker build .

Querying with Prometheus

Example Prometheus config for querying:

scrape_configs:
  - job_name: 'domain_exporter'
    static_configs:
      - targets:
        - 'domain_exporter:10550'
  - job_name: 'domain_exporter_listings'
    # Only 500 requests per day allowed, so don't query too often!
    scrape_interval: 2h
    metrics_path: "/listings"
    params:
      state: ["NSW"]
    # https://github.com/prometheus/prometheus/issues/4885#issuecomment-515144405
    static_configs:
      - targets:
        - Alexandria
        - Pyrmont
        - Glebe
        - Redfern
        - Newtown
        - Surry Hills
        - Ultimo
        - Waterloo
    relabel_configs:
      # Convert the 'targets' list given above to a ?suburb=Pyrmont URL param
      - source_labels: [__address__]
        target_label: __param_suburb
      # Send requests to the real hostname:port
      - target_label: __address__
        replacement: domain_exporter:10550

Caveats

Domain API will only return a max of 1000 results per search. If you want more than that, consider splitting your search into multiple JSON files.

domain-exporter's People

Contributors

Stargazers

Watchers

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.