Filippo Giunchedi has uploaded a new change for review. https://gerrit.wikimedia.org/r/319477
Change subject: Initial commit ...................................................................... Initial commit Change-Id: Ia156b8b057d04e7b0beedbbfe313c018d1b80477 --- A .gitignore A LICENSE A README.md A hhvm_exporter.py A setup.py 5 files changed, 451 insertions(+), 0 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/operations/software/hhvm_exporter refs/changes/77/319477/1 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..200f339 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +__pycache__/ +hhvm_exporter.egg-info/ +.venv/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..adebd00 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Prometheus exporter for HHVM + +Export health and runtime metrics from HHVM admin interface into +[Prometheus](https://prometheus.io) metrics. + +## Running + +The easiest way to run `hhvm_exporter` is via a virtualenv: + + virtualenv .venv + .venv/bin/python setup.py develop + .venv/bin/hhvm_exporter + +By default metrics are polled from `http://localhost:9002` and exposed on TCP port `9192`: + + curl localhost:9192/metrics -s | grep -v '^#' + hhvm_load 0.0 + hhvm_memory_strings_bytes 13641543.0 + hhvm_process_memory_bytes{segment="rss"} 443691008.0 + hhvm_process_memory_bytes{segment="shared"} 101527552.0 + ... + hhvm_startup 1477007598.0 + hhvm_up 1.0 + hhvm_scrape_duration_seconds_count 14.0 + hhvm_scrape_duration_seconds_sum 0.0016635158681310713 diff --git a/hhvm_exporter.py b/hhvm_exporter.py new file mode 100644 index 0000000..04cf6a9 --- /dev/null +++ b/hhvm_exporter.py @@ -0,0 +1,203 @@ +#!/usr/bin/python +# Copyright 2016 Filippo Giunchedi +# Wikimedia Foundation +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +import argparse +import datetime +import logging +import re +import sys +import time + +import requests + +from prometheus_client import start_http_server, Summary +from prometheus_client.core import GaugeMetricFamily, CounterMetricFamily, REGISTRY + +log = logging.getLogger(__name__) + + +class HHVMCollector(object): + scrape_duration = Summary('hhvm_scrape_duration_seconds', 'HHVM scrape latency') + + def __init__(self, admin_url): + self.url = admin_url + + def _fetch_json(self, url): + try: + response = requests.get(url, timeout=2) + response.raise_for_status() + except (requests.ConnectionError, requests.Timeout, requests.HTTPError): + return None + return response + + @scrape_duration.time() + def collect(self): + + health_data = self._fetch_json(self.url + '/check-health') + for metric in self._collect_health(health_data): + yield metric + + memory_data = self._fetch_json(self.url + '/memory.json') + for metric in self._collect_memory(memory_data): + yield metric + + status_data = self._fetch_json(self.url + '/status.json') + for metric in self._collect_status(status_data): + yield metric + + up = GaugeMetricFamily('hhvm_up', 'HHVM admin interface is up') + if not all([status_data, memory_data, health_data]): + up.add_metric([], 0) + else: + up.add_metric([], 1) + + yield up + + def _collect_health(self, response): + metrics = { + 'load': GaugeMetricFamily('hhvm_load', + 'Number of threads actively servicing requests'), + 'queued': GaugeMetricFamily('hhvm_queued', + 'Number of queued jobs'), + 'roarena': GaugeMetricFamily('hhvm_hhbc_ro_arena_capacity_bytes', + 'Read-only arena capacity, used only in RepoAuth mode'), + 'tc': GaugeMetricFamily('hhvm_tc_used_bytes', + 'Translation cache usage', labels=['block']), + 'rds': GaugeMetricFamily('hhvm_rds_used_bytes', + 'RDS total bytes usage'), + 'rds-local': GaugeMetricFamily('hhvm_rds_local_bytes', + 'RDS local region bytes usage'), + 'rds-persistent': GaugeMetricFamily('hhvm_rds_persistent_bytes', + 'RDS persistent region bytes usage'), + 'units': GaugeMetricFamily('hhvm_units_total', + 'Number of loaded units'), + 'funcs': GaugeMetricFamily('hhvm_funcs_total', + 'Number of functions created'), + } + + if response is not None: + data = response.json() + metrics['load'].add_metric([], data.get('load', 0)) + metrics['queued'].add_metric([], data.get('queued', 0)) + metrics['roarena'].add_metric([], + data.get('hhbc-roarena-capac', 0)) + metrics['tc'].add_metric(['main'], + data.get('tc-size', 0)) + for block in ('hot', 'prof', 'cold', 'frozen'): + metrics['tc'].add_metric([block], + data.get('tc-{}size'.format(block), 0)) + metrics['rds'].add_metric([], data.get('rds', 0)) + metrics['rds-local'].add_metric([], data.get('rds-local', 0)) + metrics['rds-persistent'].add_metric([], data.get('rds-persistent', 0)) + metrics['units'].add_metric([], data.get('units', 0)) + metrics['funcs'].add_metric([], data.get('funcs', 0)) + + for metric in metrics.values(): + yield metric + + def _collect_memory(self, response): + metrics = { + 'success': GaugeMetricFamily('hhvm_memory_success', + 'HHVM was able to fetch its memory statistics'), + 'vmsize': GaugeMetricFamily('hhvm_process_memory_size_bytes', + 'Virtual memory size of HHVM process'), + 'vmdetail': GaugeMetricFamily('hhvm_process_memory_bytes', + 'Virtual memory segment size', labels=['segment']), + 'strings_count': GaugeMetricFamily('hhvm_memory_strings_count', + 'Static strings allocated'), + 'strings_bytes': GaugeMetricFamily('hhvm_memory_strings_bytes', + 'Static strings total bytes used'), + 'tc_used': GaugeMetricFamily('hhvm_tc_used_bytes', 'XXX', + labels=['block']), + } + + if response is not None: + data = response.json() + memorym = data.get('Memory', {}) + metrics['success'].add_metric([], data.get('Success', 0)) + + statm = memorym.get('Process Stats (bytes)') + metrics['vmsize'].add_metric([], statm.get('VmSize')) + metrics['vmdetail'].add_metric(['rss'], statm.get('VmRss')) + metrics['vmdetail'].add_metric(['shared'], statm.get('Shared')) + metrics['vmdetail'].add_metric(['text'], statm.get('Text(Code)')) + metrics['vmdetail'].add_metric(['data'], statm.get('Data')) + + stringsm = memorym.get('Breakdown', {}).get('Static Strings') + if stringsm: + metrics['strings_count'].add_metric([], + stringsm.get('Details', {}).get('Count', 0)) + metrics['strings_bytes'].add_metric([], + stringsm.get('Bytes', 0)) + + for metric in metrics.values(): + yield metric + + def _collect_status(self, response): + metrics = { + 'compiler': GaugeMetricFamily('hhvm_build_info', + 'HHVM build information', labels=['compiler', 'build']), + 'start': CounterMetricFamily('hhvm_startup', 'HHVM process start time'), + } + + if response is not None: + data = response.json() + processm = data.get('status', {}).get('process', {}) + if processm: + metrics['compiler'].add_metric([ + processm.get('compiler'), + processm.get('build')], 1) + + hhvm_start = processm.get('start', '') + hhvm_start_date = datetime.datetime.strptime(hhvm_start, + '%a, %d-%b-%Y %H:%M:%S %Z') + metrics['start'].add_metric([], + float(hhvm_start_date.strftime('%s'))) + + for metric in metrics.values(): + yield metric + + +def main(): + parser = argparse.ArgumentParser() + parser.add_argument('--admin-url', metavar='URL', help='HHVM admin url', + default='http://localhost:9002') + parser.add_argument('-l', '--listen', metavar='ADDRESS', + help='Listen on this address', default=':9192') + parser.add_argument('-d', '--debug', action='store_true', default=False, + help='Enable debug logging') + args = parser.parse_args() + + if args.debug: + logging.basicConfig(level=logging.DEBUG) + else: + logging.basicConfig(level=logging.INFO) + + address, port = args.listen.split(':', 1) + + log.info('Starting hhvm_exporter on %s:%s', address, port) + + REGISTRY.register(HHVMCollector(args.admin_url)) + start_http_server(int(port), addr=address) + + try: + while True: + time.sleep(1) + except KeyboardInterrupt: + return 1 + + +if __name__ == "__main__": + sys.exit(main()) diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..1f7bcc9 --- /dev/null +++ b/setup.py @@ -0,0 +1,19 @@ +from setuptools import setup + +setup(name='hhvm_exporter', + version='0.1', + description='Prometheus exporter for HHVM', + url='https://github.com/wikimedia/operations-software-hhvm_exporter', + author='Filippo Giunchedi', + author_email='[email protected]', + license='Apache License, Version 2.0', + install_requires=[ + 'prometheus-client', + 'requests', + ], + entry_points={ + 'console_scripts': [ + 'hhvm_exporter = hhvm_exporter:main' + ] + }, +) -- To view, visit https://gerrit.wikimedia.org/r/319477 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: Ia156b8b057d04e7b0beedbbfe313c018d1b80477 Gerrit-PatchSet: 1 Gerrit-Project: operations/software/hhvm_exporter Gerrit-Branch: master Gerrit-Owner: Filippo Giunchedi <[email protected]> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
