IW-4127 | Add ondemand profiling configuration

Author: mszabo-wikia

LocalSettings.php

@@ -291,6 +291,9 @@
  */
 require_once "$IP/../config/$wgWikiaEnvironment.php";
 
+/** Load ondemand profiler configuration */
+require_once "$IP/includes/wikia/Profiler.php";
+
 /**
  * Example read-only settings.
  * @see $wgLBFactoryConf

includes/wikia/Profiler.php

@@ -0,0 +1,64 @@
+<?php
+
+/**
+ * Configuration for reporting ondemand profiler data to XHGui
+ */
+
+// Disable profiling if no URL was given
+if ( !$wgXhguiProfilerUrl ) {
+	return;
+}
+
+function wfStartXhProf(): void {
+	// Keep it in scope until the end of the request
+	static $profiler;
+
+	global $wgXhguiProfilerUrl, $wgWikiaEnvironment, $wgXhguiUploadTokenDev, $wgXhguiUploadTokenProd;
+
+	$config = [
+		'profiler' => \Xhgui\Profiler\Profiler::PROFILER_TIDEWAYS_XHPROF,
+
+		'profiler.flags' => [
+			\Xhgui\Profiler\ProfilingFlags::CPU,
+			\Xhgui\Profiler\ProfilingFlags::MEMORY,
+			\Xhgui\Profiler\ProfilingFlags::NO_BUILTINS,
+			\Xhgui\Profiler\ProfilingFlags::NO_SPANS,
+		],
+
+		'save.handler' => \Xhgui\Profiler\Profiler::SAVER_UPLOAD,
+
+		'save.handler.upload' => [
+			'uri' => $wgXhguiProfilerUrl,
+			// The timeout option is in seconds and defaults to 3 if unspecified.
+			'timeout' => 15,
+			// the token must match 'upload.token' config in XHGui
+			'token' => $wgWikiaEnvironment === WIKIA_ENV_DEV ? $wgXhguiUploadTokenDev : $wgXhguiUploadTokenProd,
+		],
+
+		/**
+		 * Determine whether profiler should run.
+		 * @return bool
+		 */
+		'profiler.enable' => function (): bool {
+			return isset( $_GET['forceprofile'] );
+		},
+
+		/**
+		 * Creates a simplified URL given a standard URL.
+		 * Does the following transformations:
+		 *
+		 * - Remove numeric values after =.
+		 *
+		 * @param string $url
+		 * @return string
+		 */
+		'profile.simple_url' => function ( $url ) {
+			return preg_replace( '/=\d+/', '', $url );
+		},
+	];
+
+	$profiler = new \Xhgui\Profiler\Profiler( $config );
+	$profiler->start();
+}
+
+wfStartXhProf();

includes/wikia/VariablesBase.php

@@ -9422,6 +9422,13 @@
  */
 $wgEnablePostForumMigrationMessage = false;
 
+/**
+ * The URL of the XHGUI instance to send profiling data to.
+ * If null, ondemand profiling is disabled.
+ * @var string|null $wgXhguiProfilerUrl
+ */
+$wgXhguiProfilerUrl = null;
+
 /**
  * Expiration timestamp for post forum migration message
  */