Merge pull request #4 from perfsonar/3-convert-to-host-metrics-to-wsgi

3 convert to host metrics to wsgi

perfsonar-host-metrics/perfsonar-host-metrics/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.

perfsonar-host-metrics/perfsonar-host-metrics/Makefile

@@ -11,13 +11,19 @@ endif
 ifndef HTTPD-CONFIGPATH
 	@echo No HTTPD-CONFIGPATH specified for installation
 	@false
+endif
+ifndef WSGI-CONFIGPATH
+	@echo No WSGI-CONFIGPATH specified for installation
+	@false
 endif
 	mkdir -p ${PERFSONAR-ROOTPATH}
 	mkdir -p ${HTTPD-CONFIGPATH}
+	mkdir -p ${WSGI-CONFIGPATH}
 	install -m 755 exporter_opts.sh ${PERFSONAR-ROOTPATH}/
-	install -m 755 perfsonar_host_exporter ${PERFSONAR-ROOTPATH}/
+	install -m 755 perfsonar_host_exporter.py ${PERFSONAR-ROOTPATH}/
 	install -m 644 apache-node_exporter.conf ${HTTPD-CONFIGPATH}/
 	install -m 644 apache-perfsonar_host_exporter.conf ${HTTPD-CONFIGPATH}/
+	install -m 644 host_exporter.wsgi ${WSGI-CONFIGPATH}/
 
 clean:
 	@true

perfsonar-host-metrics/perfsonar-host-metrics/apache-perfsonar_host_exporter.conf

@@ -1,16 +1,15 @@
-<IfModule proxy_module>
-    ProxyRequests Off
-    <Proxy *>
-        <IfVersion >= 2.4>
-            Require all granted
-        </IfVersion>
-        <IfVersion < 2.4>
-            Order deny,allow
-            Allow from all
-        </IfVersion>
-    </Proxy>
+# WSGI settings
+WSGIDaemonProcess host_exporter display-name=host_exporter user=perfsonar group=perfsonar threads=5
+WSGIScriptAlias /perfsonar_host_exporter /var/www/html/perfsonar/host_exporter/host_exporter.wsgi
+WSGIApplicationGroup %{GLOBAL}
 
-    ProxyPass /perfsonar_host_exporter http://localhost:11284 status=+I
-    ProxyPassReverse /perfsonar_host_exporter http://localhost:11284 status=+I
-    ProxyPreserveHost On
-</IfModule>
+<Directory /var/www/html/perfsonar/host_exporter>
+
+    SSLRequireSSL
+
+    WSGIProcessGroup host_exporter
+    WSGIApplicationGroup host_exporter
+
+    Require all granted
+
+</Directory>

perfsonar-host-metrics/perfsonar-host-metrics/host_exporter.wsgi

@@ -0,0 +1,8 @@
+#
+# WSGI File for host_exporter
+#
+import sys
+
+sys.path.insert(0, '/var/www/html/perfsonar/host_exporter')
+
+from host_exporter.perfsonar_host_exporter import app as application

perfsonar-host-metrics/perfsonar-host-metrics/perfsonar_host_exporter → perfsonar-host-metrics/perfsonar-host-metrics/perfsonar_host_exporter.py

@@ -6,9 +6,11 @@
 import subprocess
 from psconfig.utilities.metrics import PSConfigMetricCalculator
 from psconfig.utilities.cli import PSCONFIG_CLI_AGENTS
-from http.server import BaseHTTPRequestHandler, ThreadingHTTPServer
+from flask import Flask, Response
 
-class PSMetricsWebHandler(BaseHTTPRequestHandler):
+app = Flask(__name__)
+
+class PSMetricsWebHandler:
     LS_BASE_URL = "http://35.223.142.206:8090/lookup/records"
 
     def _read_one_liner(self, filename):
@@ -111,31 +113,24 @@ def lookup_svc_metrics(self):
             ps_metric_output += 'perfsonar_host_registered{{uuid="{}"}} {}\n'.format(uuid, self._is_registered(uuid))
 
         return ps_metric_output
-
-    def do_GET(self):
+    
+    def gather_metrics(self):
         ps_metric_output = ""
-
-        ##
         # toolkit/bundle metrics
-        ps_metric_output += self.bundle_metrics() 
-
-        ##
+        ps_metric_output += self.bundle_metrics()
         # pScheduler metrics
         ps_metric_output += self.pscheduler_metrics()
-
-        ##
         # pSConfig Metrics
         ps_metric_output += self.psconfig_metrics()
-
-        ##
         # LS client uuid
         ps_metric_output += self.lookup_svc_metrics()
-
-        self.send_response(200)
-        self.send_header("Content-Type", "text/plain")
-        self.end_headers()
-        self.wfile.write(ps_metric_output.encode("utf-8"))
+        return ps_metric_output
 
+@app.route("/")
+def metrics():
+    handler = PSMetricsWebHandler()
+    metrics_data = handler.gather_metrics()
+    return Response(metrics_data, status=200, mimetype="text/plain")
 
 if __name__ == "__main__":
     ##
@@ -147,7 +142,5 @@ def do_GET(self):
     parser.add_argument('--host', dest='host', action='store', default='localhost', help='The host to listen for connections. 0.0.0.0 means all interfaces.')
     parser.add_argument('--port', dest='port', action='store', type=int, default=11284, help='The port on which to listen for connections.')
     args = parser.parse_args()
-
-    #Build server
-    server = ThreadingHTTPServer((args.host, args.port), PSMetricsWebHandler)
-    server.serve_forever()
+
+    app.run(host=args.host, port=args.port)

perfsonar-host-metrics/perfsonar-host-metrics/unibuild-packaging/deb/control

@@ -10,7 +10,7 @@ Package: perfsonar-host-metrics
 Architecture: all
 Depends: ${shlibs:Depends}, ${misc:Depends}, prometheus-node-exporter,
  openssl, apache2, apache2-ssl-dev, perfsonar-common, python3-perfsonar-psconfig,
- python3-pscheduler
+ python3-pscheduler, python3, python3-flask, libapache2-mod-wsgi-py3
 Description: Prometheus node-exporter integration with perfSONAR
  A package that installs and sets-up Prometheus node_exporter for a perfSONAR
  to collect and report host metrics.

perfsonar-host-metrics/perfsonar-host-metrics/unibuild-packaging/deb/perfsonar-host-metrics.install

@@ -1,5 +1,5 @@
 apache-node_exporter.conf /etc/apache2/conf-available/
 apache-perfsonar_host_exporter.conf /etc/apache2/conf-available/
 exporter_opts.sh /usr/lib/perfsonar/host_metrics/
-perfsonar_host_exporter /usr/lib/perfsonar/host_metrics/
-perfsonar-host-exporter.service lib/systemd/system/
+perfsonar_host_exporter.py /usr/lib/perfsonar/host_metrics/
+host_exporter.wsgi /var/www/html/perfsonar/host_exporter

perfsonar-host-metrics/perfsonar-host-metrics/unibuild-packaging/deb/perfsonar-host-metrics.postinst

@@ -7,18 +7,19 @@ set -e
 
 case "$1" in
     configure)
+        # This link is necessary because the WSGI script imports the application using a path relative to the WSGI config directory.
+        ln -sT -f /usr/lib/perfsonar/host_metrics/ /var/www/html/perfsonar/host_exporter/host_exporter
         # check if installation or update, where version is a parameter
-        chmod 755 /usr/lib/perfsonar/host_metrics/perfsonar_host_exporter
+        chmod 755 /usr/lib/perfsonar/host_metrics/perfsonar_host_exporter.py
         #set node_exporter opts
         bash /usr/lib/perfsonar/host_metrics/exporter_opts.sh
         if [ -z "$2" ]; then
             #enable exporters - ignore errors for docker build env
             systemctl daemon-reload || :
             systemctl enable node_exporter.service || :
             systemctl restart node_exporter.service || :
-            systemctl enable perfsonar-host-exporter.service || :
-            systemctl restart perfsonar-host-exporter.service || :
 
+            # Enable and restart apache for wsgi and reverse proxy
             # Apache setup
             if [ -e /usr/share/apache2/apache2-maintscript-helper ]; then
                 . /usr/share/apache2/apache2-maintscript-helper