Logging system-subsystem-application matrix

You can identify Relativity system components that log messages based on the system-subsystem-application designation. When troubleshooting, use the system-subsystem-application matrix to configure logging to target specific Relativity components.

Relativity systems

Systems are the top-level components of Relativity. They are typically IIS applications, Windows services, or executables.

Logging systems are as follows:

System
Description
AgentAgent windows service running as kCura EDDS Agent Manager.
InvariantRelativity Invariant processing and conversion engine.
RelativityRelativity web site under IIS installed by default as /Relativity.
RelativityDistributedRelativity web site for downloads installed by default as /Relativity.Distributed.
RelativityRestRelativity RESTful web services installed by default as /Relativity.Rest.
RelativityServicesRelativity web services installed by default as /Relativity.Services.
RelativityWebAPIRelativity web services installed by default as /RelativityWebAPI.
ServiceHostWindows service for running hosted services. Installed by default as kCura Service Host Manager.
WebProcessing

Agent windows service running as kCura EDDS Web Processing Manager.

The following image presents the Relativity components hosted in IIS. They correspond to the logging systems listed in the table above.

Subsystems

Subsystems are Relativity components called from one or more systems. Generally, they are designated based on similar functionality.

Logging subsystems are as follows:

Subsystem
Description
ContainerWeb API for dynamic endpoints for RESTful services.
CustomAgentBackground process of an agent that is part of an application or a resource file.
CustomPageCustom Pages are IIS applications deployed under /Relativity/CustomPage/<GUID>.
EventHandlerEvent handlers that run custom code build on the Relativity platform.
IdentityServerAuthentication server that is used for managing tokens for user login.
KeplerWeb API for dynamic endpoints for RESTful services.
RelativityAgentBackground process of an agent that is part of the Relativity.
InvariantAPIInvariant API hosted in the Invariant Queue Manager service for processing and conversion requests.
InvariantAdminAPIInvariant Admin API hosted in the Invariant Queue Manager service for managing processing workers.

Relativity applications

Applications are unique identifiers of the context the code is running in. Applications are identified by GUID.

Logging applications are as follows:

ApplicationDescription
51b4e374-ef1b-43a0-b5a8-e2841ac3efe1Analytics
62284add-91f5-4f35-a582-bbcfa439ad8cAnalytics Core
81ceb2f0-747a-4e8b-aad5-7c40d864d96dAssisted Review
62ab9904-2f5e-442e-9d5e-259636eae79cBinders
6a8c2341-6888-44da-b1a4-5bdce0d1a383 Data Grid Core
293c50ad-7b6d-45d0-9121-7f3826e1cca5Data Grid for Audit
3e86b18f-8b55-45c4-9a57-9e0cbd7baf46Default (Resource File Default)
5725cab5-ee63-4155-b227-c74cc9e26a76Document Viewer
5975ec2c-ef13-4358-a062-aff4891b2343Fact Manager
c9e4322e-6bd8-4a37-ae9e-c3c9be31776bImaging
3e258ac2-2b63-498e-a895-9515ecea8df4Layout Builder
e5fdddf9-b55b-454c-8d96-b8285d0de2beLists
901c56a1-bdbc-4b48-a5e9-fe3f17211149Mass Operation Handler
8354d537-689a-4dde-b057-5ef2fe4dba2bOCR
60a1d0a3-2797-4fb3-a260-614cbfd3fa0dPerformance Dashboard
ed0e23f9-da60-4298-af9a-ae6a9b6a9319Processing
51b19ab2-3d45-406c-a85e-f98c01b033ecProduction
98f31698-90a0-4ead-87e3-dac723fed2a6Relativity Legal Hold
2ff16b11-a4ca-4f02-8bbb-1f07f23fe713Relativity List Page
3d20c75d-e2a8-468d-86c3-7544c035a11dRelativity Telemetry
3b884f04-f8ec-45f3-8427-2fdbeed9bbfcReview Manager
f807ac5a-6f0c-4ef3-9c7d-db2bae51a5f4Search Terms Report

Custom Relativity applications can also use logging and be identified by GUID.