├── .gitignore ├── LICENSE ├── README.md └── openweathermap_exporter /.gitignore: -------------------------------------------------------------------------------- 1 | *.swp 2 | *.yml 3 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | This is an [OpenWeatherMap](https://openweathermap.org/) exporter for [Prometheus](https://prometheus.io/). 2 | 3 | It exposes weather metrics to the [pushgateway](https://github.com/prometheus/pushgateway). 4 | 5 | A minimal `openweathermap_exporter.yml` would look like: 6 | 7 | ```` 8 | api_key: 9 | cities: 10 | - Munich 11 | - Ulaanbaatar 12 | - Isachsen 13 | latlons: 14 | - [40.2010176,-72.6806685] 15 | zips: 16 | - 90210 17 | ```` 18 | Either `cities`, `lathlons` or `zips` can be provided. 19 | 20 | Requirements: 21 | - Prometheus' Pushgateway installed and running on `localhost:9091` 22 | - Perl with packages `liblwp-useragent-determined-perl`, `libjson-perl` and `libconfig-yaml-perl` 23 | 24 | 25 | An example `prometheus.yml` configuration looks like: 26 | 27 | ```` 28 | - job_name: 'pushgateway' 29 | scrape_interval: 60s # Note this is NOT the interval the scripts will run; this is just the collection interval from the Pushgateway to Prometheus 30 | honor_labels: true 31 | static_configs: 32 | - targets: ['localhost:9091'] 33 | ```` 34 | -------------------------------------------------------------------------------- /openweathermap_exporter: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env perl 2 | 3 | use strict; 4 | use warnings; 5 | 6 | use Data::Dumper; 7 | 8 | use Config::YAML; 9 | use JSON; 10 | use LWP::UserAgent::Determined; 11 | use URI::Escape; 12 | 13 | my $configFile = $ARGV[0] || "openweathermap_exporter.yml"; 14 | my $port = $ARGV[1] || "9091"; 15 | 16 | my $config = Config::YAML->new( config => $configFile); 17 | 18 | my $ua = LWP::UserAgent::Determined->new; 19 | $ua->timing("1,2,5"); 20 | 21 | my $output = "# TYPE weather_info gauge 22 | # HELP weather_info Information about the location; the value equals the id of the location 23 | # TYPE weather_return_code gauge 24 | # HELP weather_return_code Internal API return code, presumably HTTP codes 25 | # TYPE weather_temperature_kelvin gauge 26 | # HELP weather_temperature_kelvin Temperature in Kelvin; for large areas, min/max might differ 27 | # TYPE weather_measurement_epoch gauge 28 | # HELP weather_measurement_epoch Unix timestamp of last measurement 29 | # TYPE weather_wind_meters_per_second gauge 30 | # HELP weather_wind_meters_per_second Speed in m/s 31 | # TYPE weather_wind_direction gauge 32 | # HELP weather_wind_direction Direction in meteorological degress 33 | # TYPE weather_id gauge 34 | # HELP weather_id Weather condition id 35 | # TYPE weather_location_coordinates gauge 36 | # HELP weather_location_coordinates Geolocation; latitude and longitude 37 | # TYPE weather_humidity_percent gauge 38 | # HELP weather_humidity_percent Relative humidity in percent 39 | # TYPE weather_clouds_percent gauge 40 | # HELP weather_clouds_percent Cloud cover in percent 41 | # TYPE weather_sun_epoch gauge 42 | # HELP weather_sun_epoch 43 | # TYPE weather_pressure_hectopascal gauge 44 | # HELP weather_pressure_hectopascal\n"; 45 | 46 | my @urls; 47 | my $api_key = $config->{api_key}; 48 | my $pushgateway = defined $config->{pushgateway} ? $config->{pushgateway} : 'localhost:9091'; 49 | 50 | if ($config->{cities}) { 51 | foreach my $city (@{$config->{cities}}) { 52 | push @urls, "http://api.openweathermap.org/data/2.5/weather?q=". uri_escape($city) ."&appid=$api_key"; 53 | } 54 | } 55 | 56 | if ($config->{latlons}) { 57 | foreach my $latlon (@{$config->{latlons}}) { 58 | my $lat = $latlon->[0]; 59 | my $lon = $latlon->[1]; 60 | push @urls, "http://api.openweathermap.org/data/2.5/weather?lat=$lat&lon=$lon&appid=$api_key"; 61 | } 62 | } 63 | 64 | if ($config->{zips}) { 65 | foreach my $zip (@{$config->{zips}}) { 66 | push @urls, "http://api.openweathermap.org/data/2.5/weather?zip=$zip,us&appid=$api_key"; 67 | } 68 | } 69 | 70 | foreach my $url (@urls) { 71 | my $api_key=$config->{api_key}; 72 | my $json = $ua->get($url); 73 | 74 | #TODO count up errors instead of dying once this becomes a daemon 75 | die "Could not get $url: $!" unless $json->is_success; 76 | my $decoded_json = decode_json( $json->content ); 77 | 78 | $output .= "weather_info{location=\"$decoded_json->{name}\",country=\"$decoded_json->{sys}{country}\"} $decoded_json->{id}\n"; 79 | 80 | $output .= "weather_return_code{name=\"$decoded_json->{name}\"} $decoded_json->{cod}\n"; 81 | 82 | $output .= "weather_temperature_kelvin{name=\"$decoded_json->{name}\",type=\"current\"} $decoded_json->{main}{temp}\n"; 83 | $output .= "weather_temperature_kelvin{name=\"$decoded_json->{name}\",type=\"max\"} $decoded_json->{main}{temp_max}\n"; 84 | $output .= "weather_temperature_kelvin{name=\"$decoded_json->{name}\",type=\"min\"} $decoded_json->{main}{temp_min}\n"; 85 | 86 | $output .= "weather_measurement_epoch{name=\"$decoded_json->{name}\"} $decoded_json->{dt}\n"; 87 | 88 | $output .= "weather_wind_meters_per_second{name=\"$decoded_json->{name}\"} $decoded_json->{wind}{speed}\n"; 89 | 90 | # This is not always returned 91 | $output .= "weather_wind_direction{name=\"$decoded_json->{name}\"} $decoded_json->{wind}{deg}\n" 92 | if defined $decoded_json->{wind}{deg}; 93 | 94 | # TODO I fear there might be multiple arrays in there, sometimes 95 | $output .= "weather_id{name=\"$decoded_json->{name}\"} $decoded_json->{weather}[0]{id}\n"; 96 | 97 | $output .= "weather_location_coordinates{name=\"$decoded_json->{name}\",dimension=\"latitude\"} $decoded_json->{coord}{lat}\n"; 98 | $output .= "weather_location_coordinates{name=\"$decoded_json->{name}\",dimension=\"longitude\"} $decoded_json->{coord}{lon}\n"; 99 | 100 | $output .= "weather_humidity_percent{name=\"$decoded_json->{name}\"} $decoded_json->{main}{humidity}\n"; 101 | 102 | $output .= "weather_clouds_percent{name=\"$decoded_json->{name}\"} $decoded_json->{clouds}{all}\n"; 103 | 104 | $output .= "weather_sun_epoch{name=\"$decoded_json->{name}\",change=\"sunrise\"} $decoded_json->{sys}{sunrise}\n"; 105 | $output .= "weather_sun_epoch{name=\"$decoded_json->{name}\",change=\"sunset\"} $decoded_json->{sys}{sunset}\n"; 106 | 107 | $output .= "weather_pressure_hectopascal{name=\"$decoded_json->{name}\",level=\"current\"} $decoded_json->{main}{pressure}\n"; 108 | $output .= "weather_pressure_hectopascal{name=\"$decoded_json->{name}\",level=\"ground\"} $decoded_json->{main}{grnd_level}\n" if defined $decoded_json->{main}{grnd_level}; 109 | $output .= "weather_pressure_hectopascal{name=\"$decoded_json->{name}\",level=\"sea\"} $decoded_json->{main}{sea_level}\n" if defined $decoded_json->{main}{sea_level}; 110 | 111 | # $output .= "weather_{name=\"$decoded_json->{name}\"} $decoded_json->{}{}\n"; 112 | } 113 | 114 | my $response = $ua->post('http://'. $pushgateway .'/metrics/job/openweathermap_exporter', 115 | Content_Type => 'form-data', 116 | Content => $output); 117 | 118 | $response->is_success ? exit 0 : print Dumper $response ; exit 1; 119 | 120 | --------------------------------------------------------------------------------