Logging from Relativity applications
To capture data that meets your debugging needs, you can write logs from your custom applications that use Kepler, agents, custom pages, and event handlers. There are two supported methods to log from custom applications:
- External Logging: Instrument your application with the logging framework of your choice, and send log output to a service that you control.
- IAPILog Interface: Use the Relativity API helpers to add loggers to your applications, and access the logs via the Log Extractor.
The External Logging approach provides an optimal experience with near real-time telemetry, logging access for development workflows, and finer logging control. Because of these benefits, the External Logging approach is recommended over the IAPILog Interface, despite the IAPILog Interface's slightly lower barrier to entry.
Data Logging Security
Follow good security practices when writing and retrieving logs to minimize data exposure:
- Consult the data owner on data disclosure before logging
- Log data according to the data owner's data policy (Relativity recommends logging only the identifiers. Avoid logging names, private information, and sensitive information)
- Log only minimally necessary data
- Notify Relativity support if a data exposure incident is identified
