Merge pull request #122 from phylsix/master

workflowmonit

Author: Daniel Abercrombie

.travis.yml

@@ -1,5 +1,4 @@
 language: python
-cache: pip
 python: 2.7
 dist: trusty
 services:
@@ -8,4 +7,4 @@ env: TMPDIR=$PWD/tmp
 install:
   - python setup.py install
 script:
-  - opsspace-test
+  - package=workflowwebtools opsspace-test

docs/index.rst

@@ -14,6 +14,7 @@ Welcome to WorkflowWebTools!
    machine_learning
    python_modules
    javascript
+   workflowmonit
    troubleshooting
 
 Indices and tables

docs/requirements.txt

@@ -2,3 +2,4 @@ sphinx
 sphinx_rtd_theme
 sphinxcontrib-programoutput
 sphinxcontrib-autoanysrc
+-r ../workflowmonit/requirements.txt

docs/workflowmonit.rst

@@ -0,0 +1 @@
+.. include:: ../workflowmonit/README.rst

setup.py

@@ -18,7 +18,7 @@
                                  'templates/*']
         },
     install_requires=[
-        'cmstoolbox',
+        'cmstoolbox>=0.11.3',
         'more-itertools<6.0.0',
         'cherrypy<18.0.0',
         'mako',

workflowmonit/.gitignore

@@ -0,0 +1,4 @@
+*.json
+*.yml
+*.sqlite
+test*

workflowmonit/README.rst

@@ -0,0 +1,74 @@
+workflowmonit
+-------------
+
+Component which periodically fetches information of workflows in the system(list extracted from Unified database), process and organizes into static documents, then sends to CMSMONIT service via :py:mod:`workflowmonit.stompAMQ` for storage, monitoring and post-aggregation.
+
+- :ref:`usedApi-ref`
+- Composition
+    - :ref:`wmCollector-ref`
+    - :ref:`wmSender-ref`
+    - :ref:`wmScheduler-ref`
+    - :ref:`wmStompAMQ-ref`
+- :ref:`wmDocExample-ref`
+
+.. _usedApi-ref:
+
+Used APIs
+~~~~~~~~~
+
+- wmstatserver:
+    - https://cmsweb.cern.ch/wmstatsserver/data/jobdetail/
+    - https://cmsweb.cern.ch/wmstatsserver/data/request/
+- couchdb:
+    - https://cmsweb.cern.ch/couchdb/acdcserver/_design/ACDC/_view/byCollectionName/
+
+
+.. _wmCollector-ref:
+
+workflowCollector
+~~~~~~~~~~~~~~~~~
+
+.. automodule:: workflowmonit.workflowCollector
+   :members:
+
+
+.. _wmSender-ref:
+
+sendToMonit
+~~~~~~~~~~~
+
+.. automodule:: workflowmonit.sendToMonit
+   :members:
+
+
+.. _wmScheduler-ref:
+
+workflowMonitScheduler
+~~~~~~~~~~~~~~~~~~~~~~
+
+Schedule the ``main`` function of :ref:`wmSender-ref` every hour with :py:mod:`schedule`::
+
+    import workflowmonit.sendToMonit as wms
+    schedule.every().hour.do(wms.main)
+    while True:
+        schedule.run_pending()
+        time.sleep(1)
+
+
+.. _wmStompAMQ-ref:
+
+stompAMQ
+~~~~~~~~
+
+.. automodule:: workflowmonit.stompAMQ
+   :members:
+
+
+.. _wmDocExample-ref:
+
+Document examples
+~~~~~~~~~~~~~~~~~
+
+1. document describling a single workflow `example1 <http://wsi.web.cern.ch/wsi/public/toSaveExample4.json>`_
+2. document wrapped by ``stompAMQ`` as a batch `example2.1 <http://wsi.web.cern.ch/wsi/public/godummy2.json>`_, `example2.2 <http://wsi.web.cern.ch/wsi/public/amqMsg_190208-201142.json>`_
+3. document sent out by ``stomp`` (what ``stompAMQ`` wrapped around) `example3 <http://wsi.web.cern.ch/wsi/public/bab2ef60-b0f2-4b55-9434-95a9cfd00510.json>`_

workflowmonit/__init__.py

@@ -0,0 +1,9 @@
+"""
+WorkflowWebTools workflowmonit module
+
+:author: Weinan Si <weinan.si@cern.ch>
+"""
+
+__version__ = '0.0.1'
+
+__all__ = []

workflowmonit/configLogging.yml

@@ -0,0 +1,32 @@
+version: 1
+formatters:
+  simple:
+    format: '%(asctime)s - %(levelname)s - %(module)s.%(funcName)s - %(message)s'
+handlers:
+  console:
+    class: logging.StreamHandler
+    level: INFO
+    formatter: simple
+    stream: ext://sys.stdout
+  agentmonit:
+    class: logging.FileHandler
+    level: INFO
+    formatter: simple
+    filename: agentmonit.log
+  workflowmonit:
+    class: logging.FileHandler
+    level: INFO
+    formatter: simple
+    filename: workflowmonit.log
+loggers:
+  agentmonitLogger:
+    level: INFO
+    handlers: [agentmonit]
+    propagate: no
+  workflowmonitLogger:
+    level: INFO
+    handlers: [workflowmonit]
+    propagate: no
+root:
+  level: DEBUG
+  handlers: [console]

workflowmonit/dumpWfStatusDb.py

@@ -0,0 +1,27 @@
+#!/user/bin/env python
+import os
+import sys
+import sqlite3
+
+import workflowmonit.workflowCollector as wc
+
+CONFIG_FILE_PATH = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'config.yml')
+
+def main():
+
+    config = wc.get_yamlconfig(CONFIG_FILE_PATH)
+    if not config:
+        sys.exit('Config file: {} not exist, exiting..'.format(CONFIG_FILE_PATH))
+    dbPath = config.get(
+        'workflow_status_db',
+        os.path.join(os.path.dirname(os.path.abspath(__file__)), 'workflow_status.sqlite')
+        )
+
+    conn = sqlite3.connect(dbPath)
+    with conn:
+        c = conn.cursor()
+        for row in c.execute("SELECT * FROM workflowStatuses WHERE status='running-open' ORDER BY failurerate"):
+            print('[ {1:^15} ]\t{2:.6f}\t{0}'.format(*row))
+
+if __name__ == "__main__":
+    main()