Logging for Ruby SDK

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

How to enable logging

By default the PubNub SDK keeps logs in pubnub.log located in the script directory. You can pass a custom logger as :logger parameter during initialization of the client.

Required User ID

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

1require 'pubnub'
2require 'logger'
3

4def setup_logger
5  # Create a logger that outputs to STDOUT (console)
6  logger = Logger.new(STDOUT)
7  
8  # Set the log level
9  # Available levels: DEBUG, INFO, WARN, ERROR, FATAL
10  logger.level = Logger::DEBUG
11  
12  # Customize the log format
13  logger.formatter = proc do |severity, datetime, progname, msg|
14    date_format = datetime.strftime("%Y-%m-%d %H:%M:%S")
15    "[#{date_format}] #{severity}: #{msg}\n"
16  end
17  
18  return logger
19end
20

21def perform_operations(pubnub)
22  puts "Performing operations to generate logs..."
23  
24  # Time operation - generates logs
25  pubnub.time do |envelope|
26    puts "Time operation completed with status: #{envelope.status[:code]}"
27  end
28  
29  # Publish operation - generates more detailed logs
30  pubnub.publish(
31    channel: 'logging-demo-channel',
32    message: { text: 'Hello from Ruby logging example!' }
33  ) do |envelope|
34    puts "Publish operation completed with status: #{envelope.status[:code]}"
35  end
36  
37  # Subscribe to a channel - generates continuous logs
38  pubnub.subscribe(
39    channels: ['logging-demo-channel']
40  )
41  
42  puts "Operations initiated. Check the logs for details."
43  sleep 3 # Wait to see some subscribe logs
44  
45  # Unsubscribe
46  pubnub.unsubscribe(
47    channels: ['logging-demo-channel']
48  )
49end
50

51def main
52  # Set up a logger
53  logger = setup_logger
54  logger.info("Logger initialized")
55  
56  # Initialize PubNub with the logger
57  pubnub = Pubnub.new(
58    subscribe_key: ENV.fetch('SUBSCRIBE_KEY', 'demo'), # Replace 'demo' with your Subscribe Key from the PubNub Admin Portal
59    publish_key: ENV.fetch('PUBLISH_KEY', 'demo'),     # Replace 'demo' with your Publish Key from the PubNub Admin Portal
60    user_id: 'ruby-logging-demo-user',
61    ssl: true,
62    logger: logger  # Attach the logger to PubNub
63  )
64  
65  logger.info("PubNub initialized with DEBUG level logging")
66  
67  begin
68    # Perform operations to generate logs
69    perform_operations(pubnub)
70  rescue => e
71    logger.error("Error occurred: #{e.message}")
72    logger.debug(e.backtrace.join("\n"))
73  end
74  
75  # Clean up
76  pubnub.shutdown
77  logger.info("PubNub client shutdown")
78end
79

80if __FILE__ == $0
81  puts "Starting PubNub logging example"
82  main
83  puts "Logging example completed"
84end

show all 84 lines

Configuration parameter

The logger parameter is one of many available configuration options when initializing the PubNub client. For a complete list of configuration parameters and their descriptions, see the Configuration document.

Protect sensitive data

Never enable Logger::DEBUG in production environments that handle sensitive information.

DEBUG logs may expose:

• Complete request URLs, including Access Manager signature and auth token query parameters used for signed requests
• The full token string returned by grant_token calls, since request/response details are logged in full
• API keys, user identifiers, and message content

Use Logger::DEBUG only in development environments, and set the logger level to Logger::WARN or Logger::ERROR in production.