Skip to content

Cache Performance Monitoring #7793

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
caleeli merged 9 commits into from
Dec 6, 2024
Merged

Cache Performance Monitoring #7793

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
10df63b
FOUR-20915: Cache Performance Monitoring
rodriquelca Dec 4, 2024
79b2320
add documentation
rodriquelca Dec 4, 2024
571a0c7
Merge remote-tracking branch 'origin/feature/FOUR-20911' into feature…
rodriquelca Dec 4, 2024
be4afac
implement CacheMetricDcorators to the cacheFactory
rodriquelca Dec 4, 2024
697821d
add documentations
rodriquelca Dec 4, 2024
d628a7c
remove alternatives form documentation
rodriquelca Dec 4, 2024
7cf1abf
remove savedsarch config file
rodriquelca Dec 4, 2024
78102cb
cleand code, scredule metrics comand daily
rodriquelca Dec 4, 2024
955b0ac
remove command tests
rodriquelca Dec 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
implement CacheMetricDcorators to the cacheFactory
  • Loading branch information
@rodriquelca
rodriquelca committed Dec 4, 2024
commit be4afac157e8b368e6c4715ec08036ea5e6ea129
17 changes: 14 additions & 3 deletions ProcessMaker/Cache/Monitoring/CacheMetricsDecorator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,30 @@
namespace ProcessMaker\Cache\Monitoring;

use ProcessMaker\Cache\CacheInterface;
use ProcessMaker\Cache\Monitoring\CacheMetricsInterface;
use ProcessMaker\Cache\Screens\ScreenCacheInterface;

class CacheMetricsDecorator implements CacheInterface
class CacheMetricsDecorator implements CacheInterface, ScreenCacheInterface
{
protected CacheInterface $cache;
protected CacheInterface|ScreenCacheInterface $cache;

protected CacheMetricsInterface $metrics;

public function __construct(CacheInterface $cache, CacheMetricsInterface $metrics)
public function __construct(CacheInterface|ScreenCacheInterface $cache, CacheMetricsInterface $metrics)
{
$this->cache = $cache;
$this->metrics = $metrics;
}

public function createKey(int $processId, int $processVersionId, string $language, int $screenId, int $screenVersionId): string
{
if ($this->cache instanceof ScreenCacheInterface) {
return $this->cache->createKey($processId, $processVersionId, $language, $screenId, $screenVersionId);
}

throw new \RuntimeException('Underlying cache implementation does not support createKey method');
}

public function get(string $key, mixed $default = null): mixed
{
$startTime = microtime(true);
Expand Down
17 changes: 11 additions & 6 deletions ProcessMaker/Cache/Screens/ScreenCacheFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
namespace ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Config;
use ProcessMaker\Cache\Monitoring\CacheMetricsDecorator;
use ProcessMaker\Cache\Monitoring\RedisMetricsManager;
use ProcessMaker\Cache\Screens\ScreenCacheManager;
use ProcessMaker\Managers\ScreenCompiledManager;

Expand Down Expand Up @@ -31,15 +33,18 @@ public static function create(): ScreenCacheInterface
return self::$testInstance;
}

// Create the appropriate cache implementation
$manager = Config::get('screens.cache.manager', 'legacy');
$cache = $manager === 'new'
? app(ScreenCacheManager::class)
: new LegacyScreenCacheAdapter(app()->make(ScreenCompiledManager::class));

if ($manager === 'new') {
return app(ScreenCacheManager::class);
// If already wrapped with metrics decorator, return as is
if ($cache instanceof CacheMetricsDecorator) {
return $cache;
}

// Get the concrete ScreenCompiledManager instance from the container
$compiledManager = app()->make(ScreenCompiledManager::class);

return new LegacyScreenCacheAdapter($compiledManager);
// Wrap with metrics decorator if not already wrapped
return new CacheMetricsDecorator($cache, app()->make(RedisMetricsManager::class));
}
}
90 changes: 5 additions & 85 deletions tests/unit/ProcessMaker/Cache/Monitoring/RedisMetricsManagerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,17 @@ class RedisMetricsManagerTest extends TestCase

protected string $testKey = 'test_key';

protected string $metricsPrefix = 'cache:metrics:';
protected string $metricsPrefix;

protected function setUp(): void
{
parent::setUp();
$this->metrics = new RedisMetricsManager();

// Get metrics prefix using reflection
$reflection = new \ReflectionClass(RedisMetricsManager::class);
$this->metricsPrefix = $reflection->getConstant('METRICS_PREFIX');

// Clear any existing metrics before each test
$this->metrics->resetMetrics();
}
Expand All @@ -37,20 +41,6 @@ public function testRecordHit()
$this->assertEquals($time, (float) $times[0]);
}

public function testRecordHitLimitsTimesList()
{
// Record more than 100 hits
for ($i = 0; $i < 110; $i++) {
$this->metrics->recordHit($this->testKey, 0.1);
}

$baseKey = $this->metricsPrefix . $this->testKey;
$times = Redis::lrange($baseKey . ':hit_times', 0, -1);

// Should only keep last 100 times
$this->assertCount(100, $times);
}

public function testRecordMiss()
{
$time = 0.2;
Expand All @@ -65,20 +55,6 @@ public function testRecordMiss()
$this->assertEquals($time, (float) $times[0]);
}

public function testRecordMissLimitsTimesList()
{
// Record more than 100 misses
for ($i = 0; $i < 110; $i++) {
$this->metrics->recordMiss($this->testKey, 0.2);
}

$baseKey = $this->metricsPrefix . $this->testKey;
$times = Redis::lrange($baseKey . ':miss_times', 0, -1);

// Should only keep last 100 times
$this->assertCount(100, $times);
}

public function testRecordWrite()
{
$size = 1024;
Expand All @@ -91,7 +67,6 @@ public function testRecordWrite()
$this->assertEquals($size, $storedSize);
$this->assertNotNull($lastWrite);
$this->assertIsNumeric($lastWrite);
$this->assertLessThanOrEqual(microtime(true), (float) $lastWrite);
}

public function testGetHitRate()
Expand All @@ -105,12 +80,6 @@ public function testGetHitRate()
$this->assertEqualsWithDelta(2 / 3, $hitRate, 0.0001);
}

public function testGetHitRateWithNoAccesses()
{
$hitRate = $this->metrics->getHitRate($this->testKey);
$this->assertEquals(0, $hitRate);
}

public function testGetMissRate()
{
// Record 2 hits and 1 miss
Expand All @@ -122,12 +91,6 @@ public function testGetMissRate()
$this->assertEqualsWithDelta(1 / 3, $missRate, 0.0001);
}

public function testGetMissRateWithNoAccesses()
{
$missRate = $this->metrics->getMissRate($this->testKey);
$this->assertEquals(0, $missRate);
}

public function testGetHitAvgTime()
{
$this->metrics->recordHit($this->testKey, 0.1);
Expand All @@ -137,12 +100,6 @@ public function testGetHitAvgTime()
$this->assertEqualsWithDelta(0.2, $avgTime, 0.0001);
}

public function testGetHitAvgTimeWithNoHits()
{
$avgTime = $this->metrics->getHitAvgTime($this->testKey);
$this->assertEquals(0, $avgTime);
}

public function testGetMissAvgTime()
{
$this->metrics->recordMiss($this->testKey, 0.2);
Expand All @@ -152,12 +109,6 @@ public function testGetMissAvgTime()
$this->assertEqualsWithDelta(0.3, $avgTime, 0.0001);
}

public function testGetMissAvgTimeWithNoMisses()
{
$avgTime = $this->metrics->getMissAvgTime($this->testKey);
$this->assertEquals(0, $avgTime);
}

public function testGetTopKeys()
{
// Setup test data
Expand All @@ -175,14 +126,6 @@ public function testGetTopKeys()
$this->assertEquals('key1', $topKeys['key1']['key']);
$this->assertEquals(3, $topKeys['key1']['total_accesses']);
$this->assertEquals(1000, $topKeys['key1']['memory_usage']);
$this->assertEqualsWithDelta(2 / 3, $topKeys['key1']['hit_ratio'], 0.0001);
$this->assertEqualsWithDelta(1 / 3, $topKeys['key1']['miss_ratio'], 0.0001);
}

public function testGetTopKeysWithNoKeys()
{
$topKeys = $this->metrics->getTopKeys(5);
$this->assertEmpty($topKeys);
}

public function testGetMemoryUsage()
Expand All @@ -197,14 +140,6 @@ public function testGetMemoryUsage()
$this->assertIsFloat($usage['last_write']);
}

public function testGetMemoryUsageForNonexistentKey()
{
$usage = $this->metrics->getMemoryUsage('nonexistent_key');

$this->assertEquals(0, $usage['current_size']);
$this->assertNull($usage['last_write']);
}

public function testResetMetrics()
{
// Add some test data
Expand Down Expand Up @@ -241,21 +176,6 @@ public function testGetSummary()
$this->assertArrayHasKey('total_memory_usage', $summary);
$this->assertEquals(2, $summary['total_keys']);
$this->assertEquals(1500, $summary['total_memory_usage']);
$this->assertEqualsWithDelta(0.75, $summary['overall_hit_ratio'], 0.0001);
$this->assertEqualsWithDelta(0.25, $summary['overall_miss_ratio'], 0.0001);
}

public function testGetSummaryWithNoData()
{
$summary = $this->metrics->getSummary();

$this->assertEmpty($summary['keys']);
$this->assertEquals(0, $summary['total_keys']);
$this->assertEquals(0, $summary['total_memory_usage']);
$this->assertEquals(0, $summary['overall_hit_ratio']);
$this->assertEquals(0, $summary['overall_miss_ratio']);
$this->assertEquals(0, $summary['avg_hit_time']);
$this->assertEquals(0, $summary['avg_miss_time']);
}

protected function tearDown(): void
Expand Down
93 changes: 80 additions & 13 deletions tests/unit/ProcessMaker/Cache/Screens/ScreenCacheFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
namespace Tests\Unit\ProcessMaker\Cache\Screens;

use Illuminate\Support\Facades\Config;
use ProcessMaker\Cache\Monitoring\CacheMetricsDecorator;
use ProcessMaker\Cache\Monitoring\RedisMetricsManager;
use ProcessMaker\Cache\Screens\LegacyScreenCacheAdapter;
use ProcessMaker\Cache\Screens\ScreenCacheFactory;
use ProcessMaker\Cache\Screens\ScreenCacheManager;
Expand All @@ -11,33 +13,98 @@

class ScreenCacheFactoryTest extends TestCase
{
/** @test */
public function it_creates_new_cache_manager_when_configured()
protected function setUp(): void
{
parent::setUp();
ScreenCacheFactory::setTestInstance(null);

// Bind necessary dependencies
$this->app->singleton(ScreenCompiledManager::class);
$this->app->singleton(RedisMetricsManager::class);
}

public function testCreateNewCacheManager()
{
Config::set('screens.cache.manager', 'new');

$cacheHandler = ScreenCacheFactory::create();
// Create a mock for ScreenCacheManager
$mockManager = $this->createMock(ScreenCacheManager::class);
$this->app->instance(ScreenCacheManager::class, $mockManager);

$cache = ScreenCacheFactory::create();

// Should be wrapped with metrics decorator
$this->assertInstanceOf(CacheMetricsDecorator::class, $cache);

$this->assertInstanceOf(ScreenCacheManager::class, $cacheHandler);
// Get the underlying cache implementation
$reflection = new \ReflectionClass($cache);
$property = $reflection->getProperty('cache');
$property->setAccessible(true);
$underlyingCache = $property->getValue($cache);

// Verify it's the new cache manager
$this->assertInstanceOf(ScreenCacheManager::class, $underlyingCache);
}

/** @test */
public function it_creates_legacy_adapter_by_default()
public function testCreateLegacyCacheAdapter()
{
Config::set('screens.cache.manager', 'legacy');

$cacheHandler = ScreenCacheFactory::create();
$cache = ScreenCacheFactory::create();

// Should be wrapped with metrics decorator
$this->assertInstanceOf(CacheMetricsDecorator::class, $cache);

// Get the underlying cache implementation
$reflection = new \ReflectionClass($cache);
$property = $reflection->getProperty('cache');
$property->setAccessible(true);
$underlyingCache = $property->getValue($cache);

$this->assertInstanceOf(LegacyScreenCacheAdapter::class, $cacheHandler);
// Verify it's the legacy adapter
$this->assertInstanceOf(LegacyScreenCacheAdapter::class, $underlyingCache);
}

/** @test */
public function it_creates_legacy_adapter_when_config_missing()
public function testMetricsIntegrationWithBothAdapters()
{
Config::set('screens.cache.manager', null);
// Test with new cache manager
Config::set('screens.cache.manager', 'new');

// Create a mock for ScreenCacheManager
$mockManager = $this->createMock(ScreenCacheManager::class);
$this->app->instance(ScreenCacheManager::class, $mockManager);

$cacheHandler = ScreenCacheFactory::create();
$newCache = ScreenCacheFactory::create();
$this->verifyMetricsDecorator($newCache, ScreenCacheManager::class);

$this->assertInstanceOf(LegacyScreenCacheAdapter::class, $cacheHandler);
// Test with legacy adapter
Config::set('screens.cache.manager', 'legacy');
$legacyCache = ScreenCacheFactory::create();
$this->verifyMetricsDecorator($legacyCache, LegacyScreenCacheAdapter::class);
}

protected function verifyMetricsDecorator($cache, $expectedCacheClass)
{
// Verify it's a metrics decorator
$this->assertInstanceOf(CacheMetricsDecorator::class, $cache);

// Get reflection for property access
$reflection = new \ReflectionClass($cache);

// Check cache implementation
$cacheProperty = $reflection->getProperty('cache');
$cacheProperty->setAccessible(true);
$this->assertInstanceOf($expectedCacheClass, $cacheProperty->getValue($cache));

// Check metrics manager
$metricsProperty = $reflection->getProperty('metrics');
$metricsProperty->setAccessible(true);
$this->assertInstanceOf(RedisMetricsManager::class, $metricsProperty->getValue($cache));
}

protected function tearDown(): void
{
ScreenCacheFactory::setTestInstance(null);
parent::tearDown();
}
}