Merge pull request #91 from earthgecko/luminosity

v1.2.12

docs/releases/1_2_12.rst

@@ -42,29 +42,69 @@ How to update from v1.2.11
 - Diff your current running version skyline/settings.py with the new version of
   skyline/settings.py and create a new settings.py in the temp location
   appropriate for Skyline v1.2.12 and your set up with the new IONOSPHERE_ECHO
-  settings, ready to be deployed.
+  settings, ready to be deployed.  New settings to be added are:
+
+.. code-block:: python
+
+    IONOSPHERE_MAX_RUNTIME = 120
+    """
+    :var IONOSPHERE_MAX_RUNTIME: The maximum number of seconds an Ionosphere check
+        should run for.
+    :vartype IONOSPHERE_MAX_RUNTIME: int
+    """
+
+    IONOSPHERE_ECHO_ENABLED = True
+    """
+    :var IONOSPHERE_ECHO_ENABLED: This enables Ionosphere to create and test
+        features profiles for Mirage metrics but at settings.FULL_DURATION as well.
+        Features profiles will be made on the fly for any existing, validated Mirage
+        metric features profiles.  Ionosphere's matching performance is increased
+        between 30 to 50 percent when Ionosphere echo is run.
+    :vartype IONOSPHERE_ECHO_ENABLED: boolean
+    """
+
+    IONOSPHERE_ECHO_MAX_FP_CREATE_TIME = 55
+    """
+    :var IONOSPHERE_ECHO_MAX_FP_CREATE_TIME: The maximum number of seconds an
+        Ionosphere echo process should run creating FULL_DURATION features profiles
+        for created Mirage features profiles.  This setting is specifically relevant
+        for Skyline implematations pre Ionosphere echo (v1.2.12) to prevent timeouts
+        if Ionosphere echo needs to make > 30 echo features profiles for Mirage
+        metrics with lots of existing features profiles.
+    :vartype IONOSPHERE_ECHO_MAX_FP_CREATE_TIME: int
+    """
+
+    IONOSPHERE_ECHO_FEATURES_PERCENT_SIMILAR = 2.5
+    """
+    :var IONOSPHERE_ECHO_FEATURES_PERCENT_SIMILAR: In terms of Ionosphere echo a
+        value of 2.0 is the default.  This default is above the normal
+        IONOSPHERE_FEATURES_PERCENT_SIMILAR due to that fact that the the resolution
+        of Ionosphere echo is at FULL_DURATION.  During testing this value was
+        tested at 1.0, 2 and 2.5, with 2.5 resulting in the most desirable results
+        in terms of matching time series that are similarly not anomalous.
+    :vartype IONOSPHERE_ECHO_FEATURES_PERCENT_SIMILAR: float
+    """
+
+    IONOSPHERE_ECHO_MINMAX_SCALING_FEATURES_PERCENT_SIMILAR = 3.5
+    """
+    :var IONOSPHERE_ECHO_MINMAX_SCALING_FEATURES_PERCENT_SIMILAR: In terms of
+        Ionosphere echo Min-Max scaling percentage similar, a value of 3.5 is the
+        default.  This default is above the normal IONOSPHERE_FEATURES_PERCENT_SIMILAR
+        due to that fact that the the resolution of Ionosphere echo is at FULL_DURATION
+        and echo is using the normal IONOSPHERE_MINMAX_SCALING_RANGE_TOLERANCE to
+        determine if Min-Max scaling should be run.  During testing this value was
+        tested at 1, 2 and 3.5, with 3.5 resulting in the most desirable results in
+        terms of matching time series that are similarly not anomalous.
+    :vartype IONOSPHERE_ECHO_MINMAX_SCALING_FEATURES_PERCENT_SIMILAR: float
+    """
+
 - Stop Skyline Ionosphere and Panorama services.
 - Backup your Skyline database.
 - Apply the SQL update to your Skyline database as per described below, change
   the below variables as appropriate to your set up.
-
-.. code-block:: bash
-
-    BACKUP_DIR="/tmp"  # Where you want to backup the DB to
-    MYSQL_USER="<YOUR_MYSQL_USER>"
-    MYSQL_HOST="127.0.0.1"  # Your MySQL IP
-    MYSQL_DB="skyline"  # Your MySQL Skyline DB name
-
-    # Backup DB
-    mkdir -p $BACKUP_DIR
-    mysqldump -u$MYSQL_USER -p $MYSQL_DB > $BACKUP_DIR/pre.v1.2.12.$MYSQL_DB.sql
-
-    # Update DB
-    mysql -u$MYSQL_USER -p $MYSQL_DB < "${NEW_SKYLINE_PATH}/updates/sql/v1.2.12-stable.sql
-
 - Stop all the Skyline services and ensure any service controls such as monit,
   supervisor or systemd do not start them again, (change as appropriate for
-  your set up) e.g.
+  your set up)
 
 .. code-block:: bash
 
@@ -79,6 +119,35 @@ How to update from v1.2.11
     git clone https://github.com/earthgecko/skyline .
     git checkout "$NEW_SKYLINE_VERSION"
 
+    cp "$NEW_SKYLINE_PATH/skyline/settings.py" "$NEW_SKYLINE_PATH/skyline/settings.py.v1.2.12.bak"
+    cat "${CURRENT_SKYLINE_PATH}/skyline/settings.py" > "$NEW_SKYLINE_PATH/skyline/settings.py"
+
+    # ADD the new IONOSPHERE_ECHO to settings
+    vi "$NEW_SKYLINE_PATH/skyline/settings.py"
+
+    # Stop Skyline DB related services
+    SKYLINE_SERVICES="ionosphere
+    luminosity
+    panorama"
+    for i in $SKYLINE_SERVICES
+    do
+      /etc/init.d/$i stop
+    done
+    # And stop any service controls like monit or systemd
+
+    # BACKUP THE DB AND APPLY THE NEW SQL
+    BACKUP_DIR="/tmp"  # Where you want to backup the DB to
+    MYSQL_USER="<YOUR_MYSQL_USER>"
+    MYSQL_HOST="127.0.0.1"  # Your MySQL IP
+    MYSQL_DB="skyline"  # Your MySQL Skyline DB name
+
+    # Backup DB
+    mkdir -p $BACKUP_DIR
+    mysqldump -u$MYSQL_USER -p $MYSQL_DB > $BACKUP_DIR/pre.v1.2.12.$MYSQL_DB.sql
+
+    # Update DB
+    mysql -u$MYSQL_USER -p $MYSQL_DB < "${NEW_SKYLINE_PATH}/updates/sql/v1.2.12-stable.sql"
+
     # Stop all other Skyline services
     SKYLINE_SERVICES="horizon
     analyzer