Skip to content

Logger

Introduction

The RFLogger class of the rf_logger module set up a logger for your integration.

The logger is built-in in all the Managers classes in PSEngine, which means it is used by default as soon as any form of logging is enabled in your code.

This could be in three ways:

  1. If the SDK you are using have already a logging capability enabled
  2. If you have already enabled logging
  3. Neither point 1 and 2, and you want to use the PSEngine logger.

See the API Reference for internal details of the module.

Examples

Warning

Below are some examples of usage of the module. Consider adding error handling as necessary. All the errors that can be raised by each method or function are specified in the API Reference page.

Also, you need to configure the RF_TOKEN environment variable before starting. See Learn.

Example 1: Use a PSEngine module when another SDK has logging enabled.

In this example we are creating a Logger instance from the logging standard library to emulate the fact that you might have configured your own logging. In this case there is nothing else that needs to be done before using PSEngine. 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
import logging

from psengine.enrich import LookupMgr

logging.basicConfig(level=logging.INFO)
log = logging.getLogger(__name__)

mgr = LookupMgr()
ip = mgr.lookup('8.8.8.8', 'ip')

log.info(ip)

If you set the the logging level to DEBUG you will see all the internal PSEngine debug logging. 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
DEBUG:psengine.base_http_client:Creating an HTTP client session
DEBUG:psengine.enrich.lookup_mgr:Called LookupMgr.lookup(8.8.8.8, ip, fields='None')
DEBUG:psengine.enrich.lookup_mgr:Called LookupMgr._fetch_data(entity='8.8.8.8', entity_type='ip', fields="['timestamps', 'entity', 'risk']")
DEBUG:psengine.rf_client:Called RFClient.request(get, https://api.recordedfuture.com/v2/ip/8.8.8.8, params="{'fields': 'timestamps,entity,risk'}")
DEBUG:psengine.base_http_client:Called BaseHTTPClient.call(method='get', url='https://api.recordedfuture.com/v2/ip/8.8.8.8', data='None', params="{'fields': 'timestamps,entity,risk'}")
DEBUG:urllib3.connectionpool:Starting new HTTPS connection (1): api.recordedfuture.com:443
DEBUG:urllib3.connectionpool:https://api.recordedfuture.com:443 "GET /v2/ip/8.8.8.8?fields=timestamps%2Centity%2Crisk HTTP/1.1" 200 None
DEBUG:psengine.base_http_client:HTTP Status Code: 200
DEBUG:psengine.base_http_client:BaseHTTPClient.call ended with return value '<Response [200]>'
DEBUG:psengine.rf_client:RFClient.request ended with return value '<Response [200]>'
DEBUG:psengine.enrich.lookup_mgr:LookupMgr._fetch_data ended with return value 'EnrichedIP: 8.8.8.8, Risk Score: 0, Last Seen: 202'
DEBUG:psengine.enrich.lookup_mgr:LookupMgr.lookup ended with return value 'EnrichedIP: 8.8.8.8, Risk Score: 0, Last Seen: 202'
INFO:__main__:EnrichedIP: 8.8.8.8, Risk Score: 0, Last Seen: 2025-09-01 09:44:16

Any log entries of higher level, like ERROR or CRITICAL will be shown as well.

Example 2: Use RFLogger in combination with another PSEngine module

In this example we have the same code, expect for the logger definition which is via RFLogger. The default RFLogger behaviours are:

  • to log on console and on file under the logs/ directory in the same location where your script is running
  • to log everything from INFO above
  • formatted log entries: 
    1
    2025-09-01 13:27:21,297 [MainThread] INFO [example_2] <module>:9 - EnrichedIP: 8.8.8.8, Risk Score: 0, Last Seen: 2025-09-01 11:58:39
  • maintain the log propagation for other loggers

All of these parameters can be configured during RFLogger initialization.

1
2
3
4
5
6
7
8
9
from psengine.enrich import LookupMgr
from psengine.logger import RFLogger

log = RFLogger().get_logger()

mgr = LookupMgr()
ip = mgr.lookup('8.8.8.8', 'ip')

log.info(ip)