Logging for PHP SDK

This page explains how to enable logging in the PubNub PHP Software Development Kit (SDK) using Monolog.

How to enable logging

Required UUID

Always set the UUID to uniquely identify the user or device that connects to PubNub. This UUID should be persisted, and should remain unchanged for the lifetime of the user or the device. If you don't set the UUID, you won't be able to connect to PubNub.

1<?php
2

3// Include Composer autoloader (adjust path if needed)
4require_once 'vendor/autoload.php';
5

6use Monolog\Level;
7use Monolog\Logger;
8use Monolog\Handler\StreamHandler;
9use Monolog\Handler\ErrorLogHandler;
10use Monolog\Formatter\LineFormatter;
11use PubNub\PNConfiguration;
12use PubNub\PubNub;
13use PubNub\Exceptions\PubNubException;
14

15/**
16 * PubNub Logging Example using Monolog
17 * 
18 * This example demonstrates how to set up logging for PubNub PHP SDK
19 * using the Monolog library.
20 */
21

22try {
23    // Step 1: Create a PubNub configuration
24    $pnConfig = new PNConfiguration();
25    $pnConfig->setSubscribeKey("demo"); // Replace with your Subscribe Key from the PubNub Admin Portal
26    $pnConfig->setPublishKey("demo");   // Replace with your Publish Key from the PubNub Admin Portal
27    $pnConfig->setUserId("php-logging-demo-user");
28    
29    echo "PubNub Configuration created" . PHP_EOL;
30    
31    // Step 2: Set up Monolog logger
32    // Create a logger instance with channel name 'pubnub'
33    $logger = new Logger('pubnub');
34    
35    // Create a formatter for consistent log output
36    $dateFormat = "Y-m-d H:i:s";
37    $output = "[%datetime%] %level_name%: %message% %context% %extra%\n";
38    $formatter = new LineFormatter($output, $dateFormat);
39    
40    // Add a handler to output logs to stdout (console)
41    $stdoutHandler = new StreamHandler('php://stdout', Level::Info);
42    $stdoutHandler->setFormatter($formatter);
43    $logger->pushHandler($stdoutHandler);
44    
45    // Add a handler to output logs to PHP error log
46    $errorLogHandler = new ErrorLogHandler(ErrorLogHandler::OPERATING_SYSTEM, Level::Debug);
47    $errorLogHandler->setFormatter($formatter);
48    $logger->pushHandler($errorLogHandler);
49    
50    // Optional: Add a file handler to write logs to a file
51    $fileHandler = new StreamHandler(__DIR__ . '/pubnub.log', Level::Debug);
52    $fileHandler->setFormatter($formatter);
53    $logger->pushHandler($fileHandler);
54    
55    echo "Monolog logger configured with console, error log, and file handlers" . PHP_EOL;
56    
57    // Step 3: Create PubNub instance and set logger
58    $pubnub = new PubNub($pnConfig);
59    $pubnub->setLogger($logger);
60    
61    echo "PubNub instance created and logger attached" . PHP_EOL;
62    
63    // Step 4: Perform some operations to generate logs
64    $logger->info("Performing operations to generate logs");
65    
66    // Get PubNub time (simple operation to generate logs)
67    echo "Fetching PubNub time to generate logs..." . PHP_EOL;
68    $timeResult = $pubnub->time()->sync();
69    echo "Time result: " . $timeResult->getTimetoken() . PHP_EOL;
70    
71    // Publish a message (generates more logs)
72    echo "Publishing a message to generate more logs..." . PHP_EOL;
73    $publishResult = $pubnub->publish()
74        ->channel("logging-demo-channel")
75        ->message(["text" => "Hello from PHP logging example!"])
76        ->sync();
77    
78    echo "Message published with timetoken: " . $publishResult->getTimetoken() . PHP_EOL;
79    
80    // Get Here Now data (generates even more logs)
81    echo "Fetching Here Now data..." . PHP_EOL;
82    $hereNowResult = $pubnub->hereNow()
83        ->channels(["logging-demo-channel"])
84        ->sync();
85    
86    echo "Total occupancy: " . $hereNowResult->getTotalOccupancy() . PHP_EOL;
87    
88    // Log a final message
89    $logger->info("Operations completed successfully");
90    
91    echo PHP_EOL . "Logging example complete!" . PHP_EOL;
92    echo "Check the following locations for logs:" . PHP_EOL;
93    echo "1. Console output (above)" . PHP_EOL;
94    echo "2. PHP error log" . PHP_EOL;
95    echo "3. " . __DIR__ . "/pubnub.log" . PHP_EOL;
96    
97} catch (PubNubException $exception) {
98    echo "PubNub Error: " . $exception->getMessage() . PHP_EOL;
99} catch (Exception $exception) {
100    echo "Error: " . $exception->getMessage() . PHP_EOL;
101}

show all 101 lines

HTTP/2 negotiation logging

After every request, the PHP SDK logs the protocol version that was actually negotiated for that request at debug level:

Publish response from <your-origin> negotiated HTTP/2

If HTTP/2 wasn't negotiated, you'll see negotiated HTTP/1.1 instead. This log line reflects the protocol reported by the response itself, not just what the SDK requested. For configuration details, refer to HTTP/2.

Protect sensitive data

The default PubNub PHP SDK logger only logs endpoint names and connection details, not full request URLs or response bodies. However, if you attach a custom PSR-3 logger or Guzzle middleware, verify it doesn't log full request URLs (which can include Access Manager signature and auth token query parameters for signed requests) or response bodies (which can include the full token string returned by grantToken calls). Review any custom logging integration before enabling it in production.

How to disable logging

You can disable the STDOUT print statements by ommiting configuration of logger. Default PSR/Log/NullLogger will be used.

Using this code sample you can discard all log message output:

1<?php
2

3// Include Composer autoloader (adjust path if needed)
4require_once 'vendor/autoload.php';
5

6use PubNub\PNConfiguration;
7use PubNub\PubNub;
8use PubNub\Exceptions\PubNubException;
9

10/**
11 * Basic PubNub PHP SDK Initialization Example
12 */
13try {
14    // Create a new configuration
15    $pnconf = new PNConfiguration();
16    
17    // Set the required keys and configuration
18    $pnconf->setPublishKey("demo");    // Replace with your Publish Key from the PubNub Admin Portal
19    $pnconf->setSubscribeKey("demo");  // Replace with your Subscribe Key from the PubNub Admin Portal
20    $pnconf->setUserId('php-basic-user');
21    
22    // Optional: Configure timeouts (in seconds)
23    $pnconf->setConnectTimeout(10);
24    $pnconf->setNonSubscribeRequestTimeout(10);
25    $pnconf->setSubscribeTimeout(310);
26    
27    // Initialize PubNub with the configuration
28    $pubnub = new PubNub($pnconf);
29    
30    echo "PubNub initialized successfully with the following configuration:" . PHP_EOL;
31    echo "- Subscribe Key: " . $pnconf->getSubscribeKey() . PHP_EOL;
32    echo "- Publish Key: " . $pnconf->getPublishKey() . PHP_EOL;
33    echo "- User ID: " . $pnconf->getUserId() . PHP_EOL;
34    
35    // Optional: Perform a simple operation to verify the connection
36    $timeResult = $pubnub->time()->sync();
37    echo "PubNub server time: " . $timeResult->getTimetoken() . PHP_EOL;
38    
39    echo PHP_EOL . "PubNub SDK is ready to use!" . PHP_EOL;
40    
41} catch (PubNubException $exception) {
42    echo "PubNub Error: " . $exception->getMessage() . PHP_EOL;
43} catch (Exception $exception) {
44    echo "Error: " . $exception->getMessage() . PHP_EOL;
45}

show all 45 lines