Board Optimization - XCache for vBulletin Caching

This mod will replace the default vB_Cache_Db class (database cache) used in vBulletin with an xCache implementation of it.
vBulletin has promised to implement this option themselves, but I'm sick of waiting, so I created this.

What are the benefits of using XCache for caching over MySQL (Database) ?

In theory, quicker page load times, lower server load. This will offload the duty of caching from mysql and throw it into the RAM.
It will also reduce your query count per page.

The most staggering difference you will notice is with the CMS, or any mods that make good use of the cache.
For instance, in my dev site using the default CMS content and settings, browsing as a guest, I was able to shave off an average of 0.06 seconds from the page generation time (0.23 -> 0.17 seconds) and 43 queries (86 -> 43)!
In a live site, the reduction in queries and overall time spent serving the page will have a large effect on overall performance in a busy site.

Make sure that you also have the datastore cache method set to xcache as well for further query reduction: https://www.vbulletin.com/docs/html/datastore
Also install "Load templates from XCache" for further query reduction: https://vborg.vbsupport.ru/showthread.php?t=255994

Any drawbacks?

Other than a file edit required on every vBulletin upgrade, none that I can think of... If you think of one, post it.

What about other data caches ? (memcached, apc, etc.)

I could write those as well, if there is a demand for it, and they happen to work similar enough to xcache.

This is a beta!

This has been tested in a live forum for a few days, and no incidents/side-effects have been noticed or reported, but I cannot yet guarantee it is 100% perfect.

This mod requires one file edit

See this bug to find out why: http://tracker.vbulletin.com/browse/VBIV-13241

Requirements

This was designed to fail gracefully by falling back on the DB cache if there is an error, so if there is an error you will not even realize it.

Make sure these requirements are met:

• XCache 1.3.2 installed (only version that I tested) (verify by viewing phpinfo page)

The following are in your XCache ini settings (php.ini usually):

• xcache.var_size = 32M (32MB; at least)
• xcache.var_slots = 8k (8000; at least)
• Set xcache.admin.user and xcache.admin.pass to whatever you want (keep in mind that the pass must be MD5'd)

Restart after making any changes.

Another tip is to set your xcache.count and xcache.var_count to the number of CPU cores that you have.

See the documentation here: http://xcache.lighttpd.net/wiki/XcacheIni

After running this mod for a while, check your xcache admin page to ensure that your var_slots and var_size are large enough.

Install Instructions

1. Upload the contents of the UPLOAD folder in xcache.zip to your forum root

2. Open up your /includes/config.php file and add the following:

PHP Code:

/*
 * XCache Config
 */
$config['xcache']['user'] = 'user';
$config['xcache']['pass'] = 'pass'; 


Edit it to include your xcache admin username and password

3. This step will need to be repeated whenever you do a forum upgrade.
Open up /vb/cache.php.
Find:

PHP Code:

self::$instance = vB_Cache_Db::instance(); 


Replace with:

PHP Code:

self::$instance = fst_Cache_Xcache::instance(); 


[betterthanyours]

Uninstalled. Was also doing this on PM and some other pages.

[rossco_2005]

I uploaded a new version that fixes a bug that was causing CMS and some other pages to load blank, or show errors.
To update, just upload the contents of the UPLOAD folder to your forum root and allow it to overwrite the old file.

[bzcomputers]

Thanks for the update. I tried the older version a while back, but like you mentioned I had some issues with blank pages.

So far so good with this version. Using it on vb 4.2 PL3 with XCache 3.0.1.


Is anyone still using the template caching mentioned from this link?
https://vborg.vbsupport.ru/showthread.php?t=255994
...it seems to have issues

[kartheekb]

does hosting provider must be installed xcache on server to use this?

[bzcomputers]

Originally Posted by kartheekb

does hosting provider must be installed xcache on server to use this?

Yes. Latest version is 3.1.0. It's an easy install and can be done in just a couple minutes.

http://xcache.lighttpd.net/

[DreadsUK]

I've just installed vBOptimise which i am told works best with this mod.

I've uploaded all the contents into the forum root. Now looking at step 2

2. Open up your /includes/config.php file and add the following:

I went to download the file /includes/config.php and i'm being told its the same file i've just uploaded from vBoptimise. is this correct?

If so, where abouts do i add the code

/* 
 * XCache Config 
 */ 
$config['xcache']['user'] = 'user'; 
$config['xcache']['pass'] = 'pass';

[ozzy47]

You really need to remove the info from the above post, you gave out all your sites info in the config file.

[DreadsUK]

Originally Posted by ozzy47

You really need to remove the info from the above post, you gave out all your sites info in the config file.

im totally new at this and dont really know what i am doing. Im still learning. thanks ozzy

Where do i add the code?

Also, it says to edit it to include my admin xcache username and password. where do i find these or is this where i create them?

[bzcomputers]

Originally Posted by DreadsUK

im totally new at this and dont really know what i am doing. Im still learning. thanks ozzy

Where do i add the code?

Also, it says to edit it to include my admin xcache username and password. where do i find these or is this where i create them?

xCache can be run With or Without "Password Authentication". Running with password authentication has been known to cause some issues with vBulletin 4 and some mods. I've come across it personally it usually has to due with stale data, that is memory not being cleared when it should.

1) IF you decide to run xCache with "Password Authentication"

You will need to make sure these lines exist in your php.ini file:

xcache.admin.enable_auth="On"
xcache.admin.user="YOUR USERNAME HERE"
xcache.admin.pass="YOUR PASSWORD HERE (MD5)"

Then you need to add these lines to your config.php file:

    // ****** XCACHE CONFIGURATION *****
	// Here is XCache login information to use XCache instead of MYSql to cache.
$config['xcache']['user'] = 'YOUR USERNAME HERE';
$config['xcache']['pass'] = 'YOUR PASSWORD HERE (NOT MD5)';

It doesn't really matter where in the config.php file they go, personally I put it right under the "DATASTORE CACHE CONFIGURATION" section (which should also be set to use xCache) that way all the cache settings are right next to each other.

2. IF you decide to run xCache without "Password Authentication"

In php.ini this will be the only setting change:

xcache.admin.enable_auth="off"

..and in config.php file you will just need to make sure xCache is set in the "DATASTORE CACHE CONFIGURATION" section.

[RichieBoy67]

Originally Posted by DreadsUK

I've just installed vBOptimise which i am told works best with this mod.

I've uploaded all the contents into the forum root. Now looking at step 2

2. Open up your /includes/config.php file and add the following:

I went to download the file /includes/config.php and i'm being told its the same file i've just uploaded from vBoptimise. is this correct?

If so, where abouts do i add the code

/* 
 * XCache Config 
 */ 
$config['xcache']['user'] = 'user'; 
$config['xcache']['pass'] = 'pass';

I am not so sure this cache is good for you unless you have decent amount of ram. If you are already having issues using up your ram this will make it worse. Don't get me wrong, this can help immensely but not if you do not have a decent amount of ram.