Tideways with Xhgui

mongodb/aptkey.pgp

@@ -0,0 +1,39 @@
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+Version: SKS 1.1.6
+Comment: Hostname: keyserver.ubuntu.com
+
+mQINBFaUNhsBEACkTlpL9xCrlirl77tahFzzd9ccTc5wP+M3oob18GIaMYKicjbRh6J6ytCi
+XCkl65zYKvQdLkt8qlkBVc5DxGeJvD41IY3NzGPz+BZ9pFFBndAE+JEPng0ULLxzUDmWXIou
+kdHqf92BSizTFd2A8v+YGuwOkNBdPi/BHkwiViAaAKDZm/4k9LZeOF0v7gZF89QD75NrSCKo
+5SGFRb8Cxi4KR4cS/jPuQVjd+B9fWkc74BUWE91t3R87Uypd+1qnmoN6cOssLZ4s8n/cyOCk
+VphGmk1tDDhbEsI4knOqtPXaBHiC4lVIghpTHEDUuDfbQ7scySae8/YItTC/vVGngiJmZSfZ
+U5AvVspe6rfkHQHqZs3gYMqjXPl7acviEAZ7OiMp9diq6Kgp+xLRvRGL+jtUjLkP5O4gJlnx
+Cm7YWrYfYA/vHULDMyIGSBzuESGxL+Ygz+Dc0Aim9NPM5KhpV5FoAXNt50cn6n1adIwbUciR
+Y0zBXKAIVj6D+j3e0ozsO+GGEpmQFAIo1h7CEn8VV61WaLz2F60LKR8d/DEMZ7SY8uznbzkm
+TJCeCp/pTnPeGwkyJmJ78LAaKw2tSCeEAfRlnzPeQeanOnEX/wnAjHHAHewvGgQeGW1QkEdy
+8zNmfODDf9wqknBShaFRHAOAQFEgBAkYHuT4SgHqW8TVDtF3CQARAQABtDdNb25nb0RCIDMu
+NCBSZWxlYXNlIFNpZ25pbmcgS2V5IDxwYWNrYWdpbmdAbW9uZ29kYi5jb20+iQI+BBMBAgAo
+AhsDBgsJCAcDAgYVCAIJCgsEFgIDAQIeAQIXgAUCWk/J/wUJB336sAAKCRC8cR+boVcDxt2e
+EACgo6SOokDP4fZujOAyWIrmPMbb160uKKk5Pf1H2KPMxiG5Uih90AigfLkReuCPqZLFA6cE
+Cfpc32K9Y9gZAby0TusuiQYR7Mavf4XfTQRqVHK7/Vhxm3uQMNND5+ntyCUnDbjww0EtDgcS
+43Q33cSdVfZSLJ8PObjqPcqHMyKetkBfKJA9PjZMol4m0wub3HfF1K68/FxpCF8fqely5sGe
+/uFOSpZZndhyJW2L4lkgAYZEo+YByTv9w5jLL1BwESsoXkBmvWSeKMrQlJ+lt4BCd9cM0gMO
+umYcor3WWjXILmjV8M28/7EGkbszESSTZ9wRhYS+Z7J3dRNjuNrM949cqKgo01T5NtA7aViG
+lE1mY2NSzTsvHLVsyDCV53qbuycbl/zHKg/3CrMg3WZC6nS04mHUt7rGjXdLCIb6Sr+wvM2/
+3/jbMtsdwyoWyNJq8UdULoEjiRTGGRaIp056GG3IwdJ6h1N864E+qbcNlVgyG/UeViNM3t9D
+tnGY/JceRCyRFU6nWcIF/zIiQ2tpBWI4gtE2KuFoptUYn7P+c9Tie8a+agLDYd0hluasDBCG
+73693Rpt9mXcEkx5LrHN3QPPke6NaJUaW9PiWQhJZFE+LVg1OfKPvNAw3m6a9O6ZiEmTlRx5
+Rvn7Ueqmlxv5D11FKvEuvDZM7Pfbg0QYmHaaRYkCPgQTAQIAKAUCVpQ2GwIbAwUJA8JnAAYL
+CQgHAwIGFQgCCQoLBBYCAwECHgECF4AACgkQvHEfm6FXA8ZrRBAAko52XMHKMxmEv/KXh9j/
+Mj8Q9pl1UACfD7LPmAaPIaUWogOwRGPhRbYW0mBF/F0UfwYPR4w5PQjV3NttSNFnE0b90m+9
+fELrUXeKaXRrbrIEx41HWDQ83LRMVPdL7SUb8CNqIs9mAPHTO5rU81BaUeCEBqKQeD5oxJbO
+oZHm0440mjvVJnC8oqfkvq02fXPFELwR+6zaHuEGnJhov5f7lKP6uCe5xI7Y6bHplCuy1mO2
+LQdtRf4R9zq0JIEAKFb9qtsUmoiyXlrK9944HeKOP3d0DdbfzxpDSDhAXTv4TPLjo/oRg/rQ
+6YR83fYxowC6lepQtpPczV8gBZ01MKdDS++ITg7+s3WooSruH00VO0tHmEhnNrEAz4okBeWJ
+MQB6gA5z5kdmaQVVbW1DQd9QQzmI080cKrZCykQoCNvSoLrdFIb6vvx8ftOPOZ3YM3Knmi4b
+JVGoGctW1zd7A1uEGDdrT7z/j9iQ7RsnbGBmQlgNBQURXbEm67gUivwZBKRoave2xPb3JX1X
+IW/fPQOO5YBK7rMOQsbS8VBj5lXNnWJhyS1JIB7M3XEyx8MvP2q2DHoRu0VcwBBueQLni7HP
+QdL0iNBOq5b2pR4KArbQspxMzODpda3BvV7ZQsipOAHopmCxP3MZXJA6CFVcKxV60a4QeNQL
+MKz+JeMbZPp1h6Y=
+=YmWT
+-----END PGP PUBLIC KEY BLOCK----- 

mongodb/mongodb.ini

@@ -0,0 +1 @@
+extension=mongodb.so

mongodb/provision.sh

@@ -0,0 +1,45 @@
+#!/usr/bin/env bash
+# Mongodb
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+
+install_mongodb_php() {
+    for version in "7.0" "7.1" "7.2" "7.3"
+    do
+        if [[ $(command -v php$version) ]]; then
+            echo "Installing MongoDB for PHP $version"
+            sudo pecl -d php_suffix="$version" install mongodb > /dev/null 2>&1
+            # do not remove files, only register the packages as not installed so we can install for other php version
+            sudo pecl uninstall -r mongodb > /dev/null 2>&1
+            cp -f "${DIR}/mongodb.ini" "/etc/php/$version/mods-available/mongodb.ini"
+            phpenmod -v "$version" mongodb
+        fi
+    done
+}
+
+install_mongodb() {
+    echo "Installing MongoDB"
+    apt-key add "${DIR}/aptkey.pgp"
+    echo "deb http://repo.mongodb.org/apt/ubuntu trusty/mongodb-org/3.4 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-3.4.list
+    sudo apt update > /dev/null 2>&1
+    apt-get -y install mongodb-org re2c
+    install_mongodb_php
+}
+
+cleanup_mongodb_entries() {
+    echo "Auto-removing mongoDB records older than 2592000 seconds (30 days)"
+    mongo xhprof --eval 'db.collection.ensureIndex( { "meta.request_ts" : 1 }, { expireAfterSeconds : 2592000 } )' > /dev/null 2>&1
+    # indexes
+    mongo xhprof --eval  "db.collection.ensureIndex( { 'meta.SERVER.REQUEST_TIME' : -1 } )" > /dev/null 2>&1
+    mongo xhprof --eval  "db.collection.ensureIndex( { 'profile.main().wt' : -1 } )" > /dev/null 2>&1
+    mongo xhprof --eval  "db.collection.ensureIndex( { 'profile.main().mu' : -1 } )" > /dev/null 2>&1
+    mongo xhprof --eval  "db.collection.ensureIndex( { 'profile.main().cpu' : -1 } )" > /dev/null 2>&1
+    mongo xhprof --eval  "db.collection.ensureIndex( { 'meta.url' : 1 } )" > /dev/null 2>&1
+}
+
+if [[ ! $(command -v mongo) ]]; then
+    install_mongodb
+fi
+cleanup_mongodb_entries
+
+echo "Restarting mongod"
+service mongod restart

tideways/aptkey.pgp

@@ -0,0 +1,30 @@
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+Version: GnuPG v1
+
+mQENBFPr3H8BCACRvzYJ08kaFPzi3T1+FvjJTz+m7bz0gfEYENI2pfxwTm5utIIC
+FGVBVgexoq+oJ5OS2B45BoF9m8zJKfaLBuXxZ05b6wZa9SuTQkj4Hrw0SVMIOb0h
+LgCBi2nAhrKS60UrH8kCQ0qza44mCc/KJi97UQM/9EHz9QRhig/+in+h8Q2gUUgq
+kqDE48mxhJ77Z6jwSh/QdMthlN990EYgn6Y5eUHkT1tz+TgVhy/Aopje1xGKseet
+r5W9G0KDTbHrk976NAz4J6dyxHj/sXifqQwLp/d84EfRKwb+kb3CFDUL62XoMEO3
+SoFUB8rkDCMm8nFo/V6mKmDDPdCfPH70Z5D9ABEBAAG0JkJlbmphbWluIEViZXJs
+ZWkgPGtvbnRha3RAYmViZXJsZWkuZGU+iQE4BBMBAgAiBQJT69x/AhsDBgsJCAcD
+AgYVCAIJCgsEFgIDAQIeAQIXgAAKCRARzYz87rXo9P92B/9M18XHjZWOnKB7VJ9H
+YAJM4VijAge07BGskqmkBLDKCing+QtmJu+Nv1ujyVA8UJPLAwB/0Q+xMp/YM8IC
+665dgH3VPSFcYUi28u/y+mE5P3sovcRt3wyjgcU1HB04F2XB66N3cd4kQs7nguqd
+XfrH5HJ5RKpwrQVZuAqKGBJCsbcCQH3YxMQvQZv5rKtPPV1lUDu8Y11doeaEQNKi
+OIO37CvCcFmhv8w0OiRARqm1c4OEmFZ+CH2GPFokWiMmbyHQPJjrDhy7Sdf7b09A
+TeLZ6gULU0/ukmLCgRwNu4ocmAJLKAiuzCkTO0mzsI+m+1uRGbmiMqc25zqMchEx
+D+z+uQENBFPr3H8BCADazFnvb33ehm4sIyBofyj8uX7fbNyNgFU3opBrjRy6Ixc3
+lt+ZKIJgYBb5KVNB/7YuI6txiyYESogopp7pgmzYuf1YnajkA5OjD0nbsgBrnTiu
+RG76aLQ6Ukbcju2N5c6yJvrE+KTOqOuVSs1ssG1wJSKp2HkTFYpMshlagoVxUhR7
+p7doFqMB54sYHIETWserv2xETpJPq2lEAn7xy8SrqQ7NTLOAyquFIZ85tGb6haBj
+0i/cEAvazl0e4VkrTWfcSBFgtvzlDcb/9hxJX5CoPKM0t/RYNncn93T0lBbixunm
+eHPCNomwtYssX40xSYASdMROfru1v7ytD/p3edhPABEBAAGJAR8EGAECAAkFAlPr
+3H8CGwwACgkQEc2M/O616PSZuQgAjWbfjQOvJnWKvl8uMr3TuW6ERZg460vBuLKM
+Ej2BVrtlhKr8IEw1MtkelZWtSCZjrNL8KZxpstcb5m3SWBcTeX55nmm42pnZhS4C
+6CZ4Q81U3YvJ3V2qsaAKea/x/pxXOSlvMj/QfM6npMxNJaIAAO4elra4ea+RpW2P
+r/1C/Q8kPAS7D6An3QKU0g5s28hOW5Gk3Gv67PzZhyKeb5BTcSwm1Ip6QlnBajOY
+jTzH6UjKRDU94pbOMboDC08vIsZMWdOrqAyVN+w3ljNbRtR76rJglwy+UNFHidL7
+4kWbuCiIiGciJIV7+Xa1M1b499DQ8TymdKZgjW0Xh7PybfT4vw==
+=IiDB
+-----END PGP PUBLIC KEY BLOCK-----

tideways/config.php

@@ -0,0 +1,40 @@
+<?php
+
+$defaults = array(
+    'debug' => false,
+
+    // Can be either mongodb or file.
+    'save.handler' => 'mongodb',
+
+    // Needed for file save handler. Beware of file locking. You can adujst this file path
+    // to reduce locking problems (eg uniqid, time ...)
+    //'save.handler.filename' => __DIR__.'/../data/xhgui_'.date('Ymd').'.dat',
+    'db.host' => 'mongodb://127.0.0.1:27017',
+    'db.db' => 'xhprof',
+
+    'templates.path' => dirname(__DIR__) . '/src/templates',
+    'date.format' => 'M jS H:i:s',
+    'detail.count' => 6,
+    'page.limit' => 25,
+    // Other config
+    'profiler.enable' => function() {
+        $url = $_SERVER['REQUEST_URI'];
+        if (strpos($url, 'vvv.test/') === 0) {
+            return false;
+        }
+        return true;
+    },
+    'profiler.replace_url' => function($uri) {
+        $uri = str_replace('?enable-tideways', '', $uri);
+        $uri = str_replace('%3Fenable-tideways', '', $uri);
+        return $uri;
+    }
+);
+
+$custom_args = array();
+if( file_exists( './custom-config.php' ) ) {
+    include_once( './custom-config.php' );
+}
+
+// In config/config.php
+return array_merge( $defaults, $custom_args );

tideways/nginx.conf

@@ -0,0 +1,22 @@
+server {
+    listen       80;
+    listen       443 ssl;
+    root         /srv/www/default/xhgui/webroot;
+    index  index.php;
+    server_name  tideways.vvv.test xhgui.vvv.test;
+
+    gzip off;
+
+     location / {
+        try_files $uri $uri/ /index.php?$args;
+    }
+
+    location ~ \.php$ {
+        client_max_body_size 1024M;
+        try_files $uri =404;
+        include /etc/nginx/fastcgi_params;
+        fastcgi_pass   php;
+        fastcgi_index   index.php;
+        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
+    }
+}

tideways/provision.sh

@@ -0,0 +1,89 @@
+#!/usr/bin/env bash
+# Tideways with XHgui
+DIR=$(dirname "$0")
+
+install_tideways() {
+    # Tideways is only for php =>7.0
+    if [[ ! -d /var/local/tideways-php/.git ]]; then
+        echo "Cloning Tideways extension"
+        git clone "https://github.com/tideways/php-xhprof-extension" /var/local/tideways-php
+    else
+        echo "Updating Tideways extension"
+        ( cd /var/local/tideways-php/ && git pull -q && git checkout -q )
+    fi
+}
+
+install_tideways_php() {
+    echo "Installing Tideways for PHP $version"
+    cp -f "${DIR}/tideways-header.php" "/srv/tideways-header.php"
+    for version in "7.0" "7.1" "7.2" "7.3"
+    do
+        if [[ $(command -v php$version) ]]; then
+            php_modules_path=$(php-config$version --extension-dir)
+            echo "Copying tideways files for PHP $version"
+            cp -f "${DIR}/tideways.ini" "/etc/php/$version/mods-available/tideways_xhprof.ini"
+            cp -f "${DIR}/xhgui-php.ini" "/etc/php/$version/mods-available/xhgui.ini"
+            if [[ ! -f "$php_modules_path/tideways_xhprof.so" ]] || [[ $(stat -c %Y "$php_modules_path/tideways_xhprof.so") -lt $(stat -c %Y "/var/local/tideways-php/.git/info/") ]]; then
+                echo "Compiling Tideways for PHP $version"
+                cp -rf /var/local/tideways-php "/var/local/tideways-php$version"
+                cd "/var/local/tideways-php${version}"
+                update-alternatives --set php "/usr/bin/php$version" > /dev/null 2>&1
+                update-alternatives --set php-config "/usr/bin/php-config$version" > /dev/null 2>&1
+                update-alternatives --set phpize "/usr/bin/phpize$version" > /dev/null 2>&1
+                phpize$version > /dev/null 2>&1
+                ./configure --enable-tideways-xhprof --with-php-config=php-config$version > /dev/null 2>&1
+                make > /dev/null 2>&1
+                make install > /dev/null 2>&1
+                rm -rf "/var/local/tideways-php$version"
+            fi
+            phpenmod -v "$version" tideways_xhprof
+            phpenmod -v "$version" xhgui
+
+        fi
+    done
+}
+
+restart_php() {
+    echo "Restarting PHP-FPM server"
+    for version in "7.0" "7.1" "7.2" "7.3"
+    do
+        if [[ $(command -v php$version) ]]; then
+            service "php$version-fpm" restart > /dev/null 2>&1
+        fi
+    done
+    echo "Restarting Nginx"
+    service nginx restart > /dev/null 2>&1
+}
+
+install_xhgui() {
+    if [[ ! -d "/srv/www/default/xhgui" ]]; then
+        echo -e "\nGit cloning xhgui from https://github.com/perftools/xhgui.git"
+        cd /srv/www/default
+        git clone "https://github.com/perftools/xhgui.git" xhgui
+        cd xhgui
+        echo "Installing xhgui"
+        sudo php install.php
+        cp -f "${DIR}/config.php" "/srv/www/default/xhgui/config/config.php"
+        echo "Restarting MongoDB"
+        service mongod restart
+    else
+        echo -e "\nUpdating xhgui..."
+        cd /srv/www/default/xhgui
+        git pull --rebase origin master > /dev/null 2>&1
+        sudo php install.php > /dev/null 2>&1
+    fi
+}
+
+echo "Installing Tideways & XHgui"
+if [[ ! $(command -v mongo) ]]; then
+    echo "MongoDB is needed for XHGUI/Tideways support, provisioning MongoDB"
+    . "${DIR}/../mongodb/provision.sh"
+fi
+DIR=$(dirname "$0")
+install_tideways
+install_tideways_php
+install_xhgui
+cp -f "${DIR}/nginx.conf" "/etc/nginx/custom-utilities/xhgui.conf"
+restart_php
+
+echo "Tideways and xhgui installed"

tideways/tideways-header.php

@@ -0,0 +1,13 @@
+<?php
+
+if( isset( $_SERVER['REQUEST_URI'] ) && strpos( $_SERVER['REQUEST_URI'], 'enable-tideways' ) !== false ) {
+    if ( file_exists( '/srv/www/default/xhgui/external/header.php' ) ) {
+        include '/srv/www/default/xhgui/external/header.php';
+    }
+
+    define( 'QM_DISABLED', true );
+    if( file_exists( './custom-header.php' ) ) {
+        include_once( './custom-header.php' );
+    }
+}
+

tideways/tideways.ini

@@ -0,0 +1 @@
+extension=tideways_xhprof.so 

tideways/xhgui-php.ini

@@ -0,0 +1 @@
+auto_prepend_file=/srv/tideways-header.php