Adding A Description To FusionReactor Tracked Transactions In Lucee CFML 5.2.9.40

<cfscript>
	
	/**
	* CAUTION: VARIADIC FUNCTION, accepts 2 or 3 arguments. I wrap the given callback in
	* a FusionReactor tracked transaction, assigning the given name and OPTIONAL
	* description. The results of the callback are returned to the calling context.
	*/
	public any function segmentWrap() {

		// PROXY: Name, Description, Callback.
		if ( arguments.len() == 3 ) {

			var proxyArguments = {
				"name": arguments[ 1 ],
				"description": arguments[ 2 ],
				"callback": arguments[ 3 ]
			};

		// PROXY: Name, Callback.
		} else {

			var proxyArguments = {
				"name": arguments[ 1 ],
				"description": "",
				"callback": arguments[ 2 ]
			};

		}
		
		return( segmentWrapWithNameAndDescription( argumentCollection = proxyArguments ) );

	}

	/**
	* I wrap the given callback in a FusionReactor tracked transaction, assigning the
	* given name and description. The results of the callback are returned to the calling
	* context.
	* 
	* @name I am the transaction name.
	* @description I am the transaction description.
	* @callback I am the callback to wrap.
	*/
	public any function segmentWrapWithNameAndDescription(
		required string name,
		required string description,
		required function callback
		) {

		// CAUTION: In a production setting, you'd have to check to make sure this class
		// is available AND that the .getInstance() call returns a non-null value.
		// However, for the sake of simplicity, I'm keeping this demo naive.
		var frapi = createObject( "java", "com.intergral.fusionreactor.api.FRAPI" )
			.getInstance()
		;

		var segment = frapi.createTrackedTransaction( name );
		// Set the "tracked transaction" description - this provides additional detail in
		// the "Tracing" and "Relations" tabs in the Cloud and Standalone dashboards,
		// respectively.
		segment.setDescription( description );
		// NOTE: This is only available in the Standalone dashboard - NOT THE CLOUD.
		segment.setProperty( "Test Property", "Test Value" );

		try {

			return( callback() );

		} finally {

			segment.close();

		}

	}

	// ------------------------------------------------------------------------------- //
	// ------------------------------------------------------------------------------- //

	// Wrapping transaction with NAME only.
	segmentWrap(
		"MyFirstSegment",
		() => {

			sleep( randRange( 50, 100 ) );

		}
	);

	// Wrapping transaction with NAME and DESCRIPTION.
	segmentWrap(
		"MySecondSegment",
		"This is my second segment, starting at #getTickCount()#",
		() => {

			sleep( randRange( 50, 100 ) );

		}
	);

	// EXPERIMENT: Since the Description is just a string, we can stuff any data we want
	// into it as long as its a string. Like a serialized struct.
	// --
	// NOTE: The are ways to set "properties" on a transaction. However, those do not
	// show up in the CLOUD dashboard - only the Standalone dashboard transactions.
	segmentWrap(
		"MyThirdSegment",
		serializeJson({
			httpMethod: cgi.request_method,
			httpServer: cgi.server_name,
			httpReferer: cgi.http_referer,
			httpUserAgent: cgi.http_user_agent,
			ancientChineseSecret: "Small pull-requests get reviewed with more clarity."
		}),
		() => {

			sleep( randRange( 50, 100 ) );

		}
	);

	// ------------------------------------------------------------------------------- //
	// ------------------------------------------------------------------------------- //	

	echo( "Done with demo." );

</cfscript>

<script type="text/javascript">

	// Refresh page to generate traffic (the Cloud dashboard seems to have trouble
	// syncing from my local system unless there is a steady stream of traffic).
	setTimeout(
		function() {

			window.location.reload();

		},
		1000
	);

</script>