feat(logger): Implement custom logger injection for Typesense client

[jkobus]

Change Summary

The Typesense PHP client now supports injecting your own PSR-3 compatible logger instance instead of using the default Monolog logger.

Usage

With Custom Logger

You can pass any PSR-3 compatible logger instance via the logger configuration option:

use Monolog\Logger;
use Monolog\Handler\StreamHandler;
use Typesense\Client;

// Create your custom logger
$customLogger = new Logger('my-app');
$customLogger->pushHandler(new StreamHandler('/var/log/typesense.log', Logger::DEBUG));

// Pass it to the client
$client = new Client([
    'api_key' => 'xyz',
    'nodes' => [
        [
            'host' => 'localhost',
            'port' => '8108',
            'protocol' => 'http',
        ],
    ],
    'logger' => $customLogger,  // Your custom logger
]);

Compatible Loggers

Any PSR-3 compliant logger will work:

• Monolog
• Symfony Logger
• Laravel Logger
• Any other PSR-3 compliant implementation

Default Behavior

If you don't provide a custom logger, the client will create a default Monolog logger that writes to stdout:

$client = new Client([
    'api_key' => 'xyz',
    'nodes' => [
        [
            'host' => 'localhost',
            'port' => '8108',
            'protocol' => 'http',
        ],
    ],
    'log_level' => Logger::INFO,  // Optional: customize the default logger level
]);

Implementation Details

The change was made in src/Lib/Configuration.php:

// Allow custom logger injection
if (isset($config['logger']) && $config['logger'] instanceof LoggerInterface) {
    $this->logger = $config['logger'];
} else {
    $this->logLevel = $config['log_level'] ?? Logger::WARNING;
    $this->logger   = new Logger('typesense');
    $this->logger->pushHandler(new StreamHandler('php://stdout', $this->logLevel));
}

This ensures backward compatibility - existing code will continue to work without any changes.

Example

See examples/custom_logger.php for a complete working example.

PR Checklist

• [x ] I have read and signed the Contributor License Agreement.

[Copilot]

Pull request overview

This PR implements custom logger injection support for the Typesense PHP client, allowing users to provide their own PSR-3 compatible logger instead of relying on the default Monolog logger. This enhancement improves flexibility for users who want to integrate Typesense logging with their existing logging infrastructure.

Changes:

• Modified Configuration class to accept and validate custom PSR-3 logger instances via the logger configuration option
• Added comprehensive test coverage for logger injection scenarios including custom loggers, log levels, and edge cases
• Provided a working example demonstrating both custom logger usage and default logger configuration

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File	Description
src/Lib/Configuration.php	Implements custom logger injection with PSR-3 interface validation, falling back to default Monolog logger when no custom logger is provided
tests/Feature/ConfigurationTest.php	Comprehensive test suite covering default logger, custom logger, custom log levels, mock loggers, invalid logger handling, and configuration validation
examples/custom_logger.php	Example demonstrating custom logger injection and default logger configuration patterns

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

There is an extra blank line at the end of the file. PSR-12 requires exactly one blank line at the end of files. Remove the extra blank line on line 195.

Suggested change

[Copilot]

For consistency with other example files (alias_operations.php, cluster_operations.php, collection_operations.php, info_operations.php), consider adding the PHPStorm suppression annotation at the top of the file after the opening PHP tag: /** @noinspection ForgottenDebugOutputInspection */. This suppresses IDE warnings about debug output functions like print_r and echo in example files.

[tharropoulos]

Could there be a warning log right after the default's instantiation in cases where the instance of the logger doesn't satisfy the interface?

[jkobus]

I would be even more strict and just throw here an exception - it is clearly a configuration issue (like wrong autowiring in symfony).

[tharropoulos]

Why not :)

[tharropoulos]

@jkobus thank you for the PR!

Was the Copilot review requested by you, or did this happen without your consent?

[jkobus]

@jkobus thank you for the PR!

Was the Copilot review requested by you, or did this happen without your consent?

I think I accidentally brought mine here :-)

[tharropoulos]

I think I accidentally brought mine here :-)

No worries if that was the case, I just feel like AI reviews tend to bring visual noise with them and didn't want them start reviewing every PR out of nowhere haha