OpenWeather Exporter

Prometheus exporter for openweather API.

NOTE: As of version 0.0.12 of this exporter, you need to sign up for the API 3.0 free or paid subscription for your API keys to work.

Requirements

• Linux / MacOSX, git bash for Windows
• docker
• Openweather API 3.0 Subscription (Free or Paid)

Development

• go
• openweathermap

Configuration

Openweather exporter can be controlled by both ENV or CLI flags as described below.

Enabling OW_ENABLE_POL will call the API more times to pull pollution/air quality data, be weary of your API calls, so you do not get charged. See openweather pricing here.

Usage

Binary Usage

# Export weather metrics from Seattle using binary & pollution/UV metrics on
./openweather-exporter --city "Seattle, WA" --apikey mi4o2n54i0510n4510 --enable-pol

Docker Usage

# Export weather metrics from Seattle using docker
docker run -d --restart on-failure --name=openweather-exporter -p 9091:9091 billykwooten/openweather-exporter --city "Seattle, WA" --apikey mi4o2n54i0510n4510

Docker-compose Usage

  openweather-exporter:
    image: billykwooten/openweather-exporter
    container_name: openweather-exporter
    restart: always
    ports:
      - "9091:9091"
    environment:
      - OW_CITY=New York, NY
      - OW_APIKEY=mi4o2n54i0510n4510
      - OW_ENABLE_POL=true

Prometheus Scrape Usage

scrape_configs:
  - job_name: 'openweather-exporter'
    scrape_interval: 60s
    static_configs:
      - targets: ['openweather-exporter:9091']

Collectors

Openweather exporter metrics that are collected by default.

If you enable pollution metrics, the following metrics will be enabled.

Grafana

I have created a grafana dashboard for this exporter, feel free to use it. Link below.

Dashboard Link

Development

If you'd like to build this yourself you can clone this repo and run:

./script/cibuild