Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
125 changes: 125 additions & 0 deletions ProcessMaker/Logging/TenantAwareHandler.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
<?php

namespace ProcessMaker\Logging;

use Illuminate\Support\Facades\Context;
use Monolog\Handler\AbstractProcessingHandler;
use Monolog\LogRecord;
use Monolog\Formatter\LineFormatter;

class TenantAwareHandler extends AbstractProcessingHandler
{
private string $baseFilename;
private int $maxFiles;
private array $handlers = [];

/**
* Create a new tenant-aware handler instance.
*
* @param string $filename
* @param int $maxFiles
* @param string $level
* @param bool $bubble
*/
public function __construct(
string $filename,
int $maxFiles = 7,
$level = 'DEBUG',
bool $bubble = true
) {
$this->baseFilename = $filename;
$this->maxFiles = $maxFiles;

parent::__construct($level, $bubble);

// Set default formatter
$this->setFormatter(new LineFormatter(
"[%datetime%] %channel%.%level_name%: %message% %context% %extra%\n",
'Y-m-d H:i:s',
true,
true
));
}

/**
* Handle a log record.
*
* @param LogRecord $record
* @return bool
*/
public function handle(LogRecord $record): bool
{
// Get current tenant ID from context
$tenantId = Context::get('tenantId') ?? 'no-tenant';

// Get or create handler for this tenant
$handler = $this->getHandlerForTenant($tenantId);

// Remove context from the log record (e.g. {"tenantId":1})
$record->extra = [];

return $handler->handle($record);
}

/**
* Get handler for specific tenant.
*
* @param string $tenantId
* @return \Monolog\Handler\RotatingFileHandler
*/
private function getHandlerForTenant(string $tenantId): \Monolog\Handler\RotatingFileHandler
{
if (!isset($this->handlers[$tenantId])) {
$filename = $this->getTenantFilename($tenantId);

$this->handlers[$tenantId] = new \Monolog\Handler\RotatingFileHandler(
$filename,
$this->maxFiles,
$this->level,
$this->bubble
);

$this->handlers[$tenantId]->setFormatter($this->getFormatter());
}

return $this->handlers[$tenantId];
}

/**
* Get tenant-specific filename.
*
* @param string $tenantId
* @return string
*/
private function getTenantFilename(string $tenantId): string
{
$pathInfo = pathinfo($this->baseFilename);
$directory = $pathInfo['dirname'];
$filename = $pathInfo['filename'];
$extension = isset($pathInfo['extension']) ? '.' . $pathInfo['extension'] : '';

// Define the log directory
$logDir = $directory;
if (!is_dir($logDir)) {
mkdir($logDir, 0755, true);
}

// If tenant ID is no-tenant, return the base filename
if ($tenantId === 'no-tenant') {
return $logDir . '/' . $filename . $extension;
}
// Create tenant-specific filename
return $logDir . '/' . $filename . '_tenant_' . $tenantId . $extension;
}

/**
* Write a log record.
*
* @param LogRecord $record
* @return void
*/
protected function write(LogRecord $record): void
{
// This method is not used since we override handle()
}
}
86 changes: 86 additions & 0 deletions ProcessMaker/Logging/TenantAwareLogManager.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
<?php

namespace ProcessMaker\Logging;

use Illuminate\Log\LogManager;
use Illuminate\Support\Facades\Context;

class TenantAwareLogManager extends LogManager
{
/**
* Get a log channel instance.
*
* @param string|null $channel
* @return \Psr\Log\LoggerInterface
*/
public function channel($channel = null)
{
$channel = $channel ?: $this->getDefaultDriver();

// If we're using the default channel and have tenant context, use tenant channel
if ($channel === $this->getDefaultDriver() && Context::get('tenantId')) {
return $this->get('tenant');
}

return parent::channel($channel);
}

/**
* Get the default log driver name.
*
* @return string
*/
public function getDefaultDriver()
{
return $this->app['config']['logging.default'];
}

/**
* Create a custom log channel instance.
*
* @param array $config
* @return \Psr\Log\LoggerInterface
*/
protected function createCustomDriver(array $config)
{
$driver = $config['driver'] ?? null;

if ($driver === 'tenant-aware') {
return $this->createTenantAwareDriver($config);
}

return parent::createCustomDriver($config);
}

/**
* Create a tenant-aware driver.
*
* @param array $config
* @return \Psr\Log\LoggerInterface
*/
protected function createTenantAwareDriver(array $config)
{
$tenantId = Context::get('tenantId') ?? 'no-tenant';

// Create tenant-specific log path (use base_path to avoid tenant storage path issues)
$logPath = base_path("storage/logs/tenants/tenant_{$tenantId}.log");

// Ensure the directory exists
$logDir = dirname($logPath);
if (!is_dir($logDir)) {
mkdir($logDir, 0755, true);
}

// Create the logger with tenant-specific configuration
return $this->app->make('log')->build([
'driver' => 'daily',
'path' => $logPath,
'level' => $config['level'] ?? 'debug',
'days' => $config['days'] ?? 7,
'processors' => [
\Monolog\Processor\PsrLogMessageProcessor::class,
\ProcessMaker\Logging\TenantContextProcessor::class,
],
]);
}
}
32 changes: 32 additions & 0 deletions ProcessMaker/Providers/TenantLoggingServiceProvider.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<?php

namespace ProcessMaker\Providers;

use Illuminate\Support\ServiceProvider;
use ProcessMaker\Logging\TenantAwareLogManager;

class TenantLoggingServiceProvider extends ServiceProvider
{
/**
* Register services.
*
* @return void
*/
public function register()
{
// Bind our custom LogManager
$this->app->singleton('log', function ($app) {
return new TenantAwareLogManager($app);
});
}

/**
* Bootstrap services.
*
* @return void
*/
public function boot()
{
//
}
}
2 changes: 1 addition & 1 deletion ProcessMaker/Repositories/SettingsConfigRepository.php
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ private function readyToUseSettingsDatabase()
{
if (!$this->readyToUseSettingsDatabase) {
$this->readyToUseSettingsDatabase =
app('tenant-resolved') &&
(!config('app.multitenancy') || app('tenant-resolved')) &&
$this->databaseAvailable() &&
$this->redisAvailable() &&
$this->settingsTableExists();
Expand Down
1 change: 1 addition & 0 deletions config/app.php
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@
* ProcessMaker Service Providers
*/
ProcessMaker\Providers\ProcessMakerServiceProvider::class,
ProcessMaker\Providers\TenantLoggingServiceProvider::class,
ProcessMaker\Providers\RecommendationsServiceProvider::class,
ProcessMaker\Providers\AuthServiceProvider::class,
ProcessMaker\Providers\EventServiceProvider::class,
Expand Down
15 changes: 10 additions & 5 deletions config/logging.php
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,16 @@
],

'daily' => [
'driver' => 'daily',
'path' => base_path('storage/logs/processmaker.log'),
'level' => env('LOG_LEVEL', 'debug'),
'days' => 7,
'replace_placeholders' => true,
'driver' => 'monolog',
'handler' => \ProcessMaker\Logging\TenantAwareHandler::class,
'handler_with' => [
'filename' => base_path('storage/logs/processmaker.log'),
'maxFiles' => 7,
'level' => env('LOG_LEVEL', 'debug'),
],
'processors' => [
\Monolog\Processor\PsrLogMessageProcessor::class,
],
],

'slack' => [
Expand Down
Loading