Troubleshooting

The LumisXP provides a mechanism to assist in understanding and solving REST endpoint issues.
To achieve this, a system property is provided that:

• Enables the Jersey log with verbosity PAYLOAD_TEXT (default value).
• Enables Jersey's tracing support in an on-demand (ON_DEMAND) manner.

To enable this option in LumisXP and direct the log output to a specific file (to assist in analysis), you need to follow these steps:

Pass the system property during the application server startup

The following system property should be configured with the given value for the application:

Enable tracing on desired calls

With the configuration made in the previous steps, Jersey will log calls to the REST endpoints but without much information.
If you wish to increase the level of information, you can enable tracing for each call.
This should be done per call, using specific Jersey HTTP headers, as follows:

X-Jersey-Tracing-Accept

Enables tracing for the request.
This header can have any value.

X-Jersey-Tracing-Threshold

Defines the level of tracing that the request will have. It can take one of the following values:

SUMMARY

Reduces the amount of information in the tracing.

TRACE (default value)

Standard amount of tracing information.

VERBOSE

Increases the amount of tracing information.

As an example, consider the following request: curl -X POST -v -H "X-Jersey-Tracing-Accept: 1" "http://myserver/lumis/api/rest/lumlogin?username=admin".
This request adds the header X-Jersey-Tracing-Accept to enable tracing. This request produces response headers indicating the tracing information:
< X-Jersey-Tracing-000: START [ ---- / ---- ms | ---- %] baseUri=[http://myserver/lumis/api/rest/] requestUri=[http://myserver/lumis/api/rest/lumlogin?username=admin] method=[POST] authScheme=[n/a] accept=[*/*] accept-encoding=n/a accept-charset=n/a accept-language=n/a content-type=n/a content-length=n/a < X-Jersey-Tracing-001: PRE-MATCH [ 0.18 / 0.32 ms | 0.03 %] Filter by [org.glassfish.jersey.logging.ServerLoggingFilter @62805e4a #-2147483648] < X-Jersey-Tracing-002: PRE-MATCH [ 0.20 / 0.33 ms | 0.03 %] PreMatchRequest summary: 1 filters < X-Jersey-Tracing-003: MATCH [ ---- / 0.35 ms | ---- %] Matching path [/lumlogin] < X-Jersey-Tracing-004: MATCH [ ---- / 0.38 ms | ---- %] Pattern [/lumlogin(/)?] IS selected < X-Jersey-Tracing-005: MATCH [ 0.14 / 0.48 ms | 0.02 %] RequestMatching summary < X-Jersey-Tracing-006: REQ-FILTER [ 0.00 / 0.52 ms | 0.00 %] Request summary: 0 filters < X-Jersey-Tracing-007: RI [ 0.00 / 0.70 ms | 0.00 %] [org.glassfish.jersey.server.internal.MappableExceptionWrapperInterceptor @7c715262 #10] BEFORE context.proceed() < X-Jersey-Tracing-008: MBR [ ---- / 0.72 ms | ---- %] Find MBR for type=[javax.ws.rs.core.MultivaluedMap] genericType=[[sun.reflect.generics.reflectiveObjects.ParameterizedTypeImpl @67dd9ab3]] mediaType=[application/octet-stream] annotations=[] < X-Jersey-Tracing-009: RI [ 0.00 / 0.76 ms | 0.00 %] [org.glassfish.jersey.server.internal.MappableExceptionWrapperInterceptor @7c715262 #10] AFTER context.proceed() < X-Jersey-Tracing-010: RI [ 0.07 / 0.77 ms | 0.01 %] ReadFrom summary: 1 interceptors < X-Jersey-Tracing-011: INVOKE [644.30 / 645.13 ms | 99.82 %] Resource [lumis.portal.rest.resource.LoginResource @31f3c328] method=[public void lumis.portal.rest.resource.LoginResource.loginPost(javax.ws.rs.core.MultivaluedMap,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)] < X-Jersey-Tracing-012: INVOKE [ ---- / 645.19 ms | ---- %] Response: [org.glassfish.jersey.message.internal.OutboundJaxrsResponse @7f704fe0 <204/SUCCESSFUL|No Content|-no-entity->] < X-Jersey-Tracing-013: RESP-FILTER [ 0.01 / 645.30 ms | 0.00 %] Filter by [lumis.portal.rest.CacheControlFeature$CacheControlledResponseFilter @52b03821] < X-Jersey-Tracing-014: RESP-FILTER [ 0.11 / 645.43 ms | 0.02 %] Filter by [org.glassfish.jersey.logging.ServerLoggingFilter @62805e4a #-2147483648] < X-Jersey-Tracing-015: RESP-FILTER [ 0.15 / 645.44 ms | 0.02 %] Response summary: 2 filters < X-Jersey-Tracing-016: FINISHED [ ---- / 645.48 ms | ---- %] Response status: 204/SUCCESSFUL|No Content In addition, this tracing information is logged in the file lumisdata/log/lumis/rest-troubleshooting/lumis-rest-troubleshooting.log.
Now, let’s look at the following request: curl -X POST -v -H "X-Jersey-Tracing-Accept: 1" -H "X-Jersey-Tracing-Threshold: VERBOSE" "http://myserver/lumis/api/rest/lumlogin?username=admin".
This request adds, in addition to the X-Jersey-Tracing-Accept header, the X-Jersey-Tracing-Threshold header with the value VERBOSE. This header causes Jersey to increase the information contained in the tracing. This request produces response headers indicating the tracing information (in addition to these information being present in the log, also):
< X-Jersey-Tracing-000: START [ ---- / ---- ms | ---- %] baseUri=[http://myserver/lumis/api/rest/] requestUri=[http://myserver/lumis/api/rest/lumlogin?username=admin] method=[POST] authScheme=[n/a] accept=[*/*] accept-encoding=n/a accept-charset=n/a accept-language=n/a content-type=n/a content-length=n/a < X-Jersey-Tracing-001: START [ ---- / 0.02 ms | ---- %] Other request headers: host=[myserver] user-agent=[curl/7.68.0] x-jersey-tracing-accept=[1] x-jersey-tracing-threshold=[VERBOSE] < X-Jersey-Tracing-002: PRE-MATCH [ 0.15 / 0.30 ms | 0.04 %] Filter by [org.glassfish.jersey.logging.ServerLoggingFilter @62805e4a #-2147483648] < X-Jersey-Tracing-003: PRE-MATCH [ 0.18 / 0.32 ms | 0.05 %] PreMatchRequest summary: 1 filters < X-Jersey-Tracing-004: MATCH [ ---- / 0.34 ms | ---- %] Matching path [/lumlogin] < X-Jersey-Tracing-005: MATCH [ ---- / 0.35 ms | ---- %] Pattern [/lum\-internal/admin/portal\-studio/itempicker/layoutfile(/.*)?] is NOT matched < X-Jersey-Tracing-006: MATCH [ ---- / 0.35 ms | ---- %] Pattern [/lum\-internal/portaladministration/interactiveprocess(/.*)?] is NOT matched < X-Jersey-Tracing-007: MATCH [ ---- / 0.35 ms | ---- %] Pattern [/lum\-internal/admin/portal\-studio/itempicker/areatag(/.*)?] is NOT matched < X-Jersey-Tracing-008: MATCH [ ---- / 0.36 ms | ---- %] Pattern [/lum\-internal/portaladministration/buildinformation(/.*)?] is NOT matched < X-Jersey-Tracing-009: MATCH [ ---- / 0.36 ms | ---- %] Pattern [/lum\-internal/admin/portal\-studio/itempicker/locale(/.*)?] is NOT matched < X-Jersey-Tracing-010: MATCH [ ---- / 0.36 ms | ---- %] Pattern [/lum\-internal/admin/portal\-studio/itempicker/theme(/.*)?] is NOT matched < X-Jersey-Tracing-011: MATCH [ ---- / 0.36 ms | ---- %] Pattern [/lum\-internal/admin/portal\-studio/structureeditor(/.*)?] is NOT matched < X-Jersey-Tracing-012: MATCH [ ---- / 0.37 ms | ---- %] Pattern [/lum\-internal/portaladministration/healthmonitor(/.*)?] is NOT matched < X-Jersey-Tracing-013: MATCH [ ---- / 0.37 ms | ---- %] Pattern [/lum\-internal/admin/portal\-studio/itempicker/css(/.*)?] is NOT matched < X-Jersey-Tracing-014: MATCH [ ---- / 0.37 ms | ---- %] Pattern [/lum\-internal/admin/portal\-studio/module/editor(/.*)?] is NOT matched < X-Jersey-Tracing-015: MATCH [ ---- / 0.38 ms | ---- %] Pattern [/lum\-internal/admin/portal\-studio/theme/editor(/.*)?] is NOT matched < X-Jersey-Tracing-016: MATCH [ ---- / 0.38 ms | ---- %] Pattern [/lum\-internal/admin/portal\-studio/channeltree(/.*)?] is NOT matched < X-Jersey-Tracing-017: MATCH [ ---- / 0.38 ms | ---- %] Pattern [/lum\-internal/admin/portal\-studio/xsleditor(/.*)?] is NOT matched < X-Jersey-Tracing-018: MATCH [ ---- / 0.38 ms | ---- %] Pattern [/lumis/service/portalmanagement/mobileapp(/.*)?] is NOT matched < X-Jersey-Tracing-019: MATCH [ ---- / 0.39 ms | ---- %] Pattern [/lumis/service/portalmanagement/upgrade(/.*)?] is NOT matched < X-Jersey-Tracing-020: MATCH [ ---- / 0.39 ms | ---- %] Pattern [/lum\-internal/content/generatecontent(/.*)?] is NOT matched < X-Jersey-Tracing-021: MATCH [ ---- / 0.39 ms | ---- %] Pattern [/lum\-internal/doui/filespicker/rest(/.*)?] is NOT matched < X-Jersey-Tracing-022: MATCH [ ---- / 0.39 ms | ---- %] Pattern [/lum\-internal/admin/commandpalette(/.*)?] is NOT matched < X-Jersey-Tracing-023: MATCH [ ---- / 0.40 ms | ---- %] Pattern [/lumis/authentication/users(/.*)?] is NOT matched < X-Jersey-Tracing-024: MATCH [ ---- / 0.40 ms | ---- %] Pattern [/lum\-internal/documentation(/.*)?] is NOT matched < X-Jersey-Tracing-025: MATCH [ ---- / 0.40 ms | ---- %] Pattern [/lumis/service/htmlcontent(/.*)?] is NOT matched < X-Jersey-Tracing-026: MATCH [ ---- / 0.41 ms | ---- %] Pattern [/lum\-internal/admin/mode(/.*)?] is NOT matched < X-Jersey-Tracing-027: MATCH [ ---- / 0.41 ms | ---- %] Pattern [/internal/service/search(/.*)?] is NOT matched < X-Jersey-Tracing-028: MATCH [ ---- / 0.41 ms | ---- %] Pattern [/lum\-internal/monitor(/.*)?] is NOT matched < X-Jersey-Tracing-029: MATCH [ ---- / 0.41 ms | ---- %] Pattern [/lum\-internal/users(/.*)?] is NOT matched < X-Jersey-Tracing-030: MATCH [ ---- / 0.42 ms | ---- %] Pattern [/lumis/monitor/v1(/.*)?] is NOT matched < X-Jersey-Tracing-031: MATCH [ ---- / 0.42 ms | ---- %] Pattern [/lumsetlocale(/.*)?] is NOT matched < X-Jersey-Tracing-032: MATCH [ ---- / 0.42 ms | ---- %] Pattern [/mobile/v1.0(/.*)?] is NOT matched < X-Jersey-Tracing-033: MATCH [ ---- / 0.42 ms | ---- %] Pattern [/lumlogout(/)?] is NOT matched < X-Jersey-Tracing-034: MATCH [ ---- / 0.43 ms | ---- %] Pattern [/lumlogin(/)?] IS selected < X-Jersey-Tracing-035: MATCH [ ---- / 0.43 ms | ---- %] Pattern [/mobile(/)?] is skipped < X-Jersey-Tracing-036: MATCH [ ---- / 0.43 ms | ---- %] Pattern [/([^/]+)(/.*)?] is skipped < X-Jersey-Tracing-037: MATCH [ 0.17 / 0.50 ms | 0.04 %] RequestMatching summary < X-Jersey-Tracing-038: REQ-FILTER [ 0.00 / 0.53 ms | 0.00 %] Request summary: 0 filters < X-Jersey-Tracing-039: RI [ 0.00 / 0.71 ms | 0.00 %] [org.glassfish.jersey.server.internal.MappableExceptionWrapperInterceptor @7c715262 #10] BEFORE context.proceed() < X-Jersey-Tracing-040: MBR [ ---- / 0.73 ms | ---- %] Find MBR for type=[javax.ws.rs.core.MultivaluedMap] genericType=[[sun.reflect.generics.reflectiveObjects.ParameterizedTypeImpl @67dd9ab3]] mediaType=[application/octet-stream] annotations=[] < X-Jersey-Tracing-041: MBR [ ---- / 0.74 ms | ---- %] [org.glassfish.jersey.jaxb.internal.XmlCollectionJaxbProvider$General @28c29340] is NOT readable < X-Jersey-Tracing-042: MBR [ ---- / 0.75 ms | ---- %] [org.glassfish.jersey.jaxb.internal.XmlRootElementJaxbProvider$General @504e95ea] is NOT readable < X-Jersey-Tracing-043: MBR [ ---- / 0.75 ms | ---- %] [org.glassfish.jersey.jaxb.internal.XmlRootObjectJaxbProvider$General @68e6c0f6] is NOT readable < X-Jersey-Tracing-044: RI [ 0.00 / 0.77 ms | 0.00 %] [org.glassfish.jersey.server.internal.MappableExceptionWrapperInterceptor @7c715262 #10] AFTER context.proceed() < X-Jersey-Tracing-045: RI [ 0.07 / 0.77 ms | 0.02 %] ReadFrom summary: 1 interceptors < X-Jersey-Tracing-046: INVOKE [387.49 / 388.31 ms | 99.73 %] Resource [lumis.portal.rest.resource.LoginResource @60e135f6] method=[public void lumis.portal.rest.resource.LoginResource.loginPost(javax.ws.rs.core.MultivaluedMap,javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)] < X-Jersey-Tracing-047: INVOKE [ ---- / 388.37 ms | ---- %] Response: [org.glassfish.jersey.message.internal.OutboundJaxrsResponse @fc67e89 <204/SUCCESSFUL|No Content|-no-entity->] < X-Jersey-Tracing-048: RESP-FILTER [ 0.01 / 388.43 ms | 0.00 %] Filter by [lumis.portal.rest.CacheControlFeature$CacheControlledResponseFilter @52b03821] < X-Jersey-Tracing-049: RESP-FILTER [ 0.10 / 388.54 ms | 0.03 %] Filter by [org.glassfish.jersey.logging.ServerLoggingFilter @62805e4a #-2147483648] < X-Jersey-Tracing-050: RESP-FILTER [ 0.13 / 388.55 ms | 0.03 %] Response summary: 2 filters < X-Jersey-Tracing-051: FINISHED [ ---- / 388.56 ms | ---- %] Response status: 204/SUCCESSFUL|No Content

Log Output

Once both steps have been carried out, you can check the log entries in the file lumisdata/log/lumis/rest/lumis-rest.log.