How to Create and Gather NLINK Trace Files (NLINK 8x)

Owned by Darcy Curtin
Last updated: Feb 20, 2024
2 min read

 

This page is for NLINK version 8x.

Please see https://junotsystems.atlassian.net/wiki/spaces/NLINK/pages/448888833 if you are using NLINK version 7x.

Please see https://junotsystems.atlassian.net/wiki/spaces/NLINK/pages/491562 if you are using NLINK version 6x or 5x.


Follow these steps to create and gather NLINK Trace Files (aka "workset dumps" or "dump files") to send to Junot Support for help with troubleshooting data problems.

Step-by-step guide

Gather Logs

Use the NLINK Management Module (NMM) to gather diagnostic trace files:

  1. Remove old files (optional). If you are unsure whether existing log files might be helpful, just skip this step.

    1. From the NMM menu, choose either Tools >> Clear Messages, Logs or Options >> Goto Logs Folder.

    2. Clear out any old files and/or folders that you know are irrelevant. You may not be able to delete all the files if NLINK is running, so don't worry about those.

  2. Gather logs.

    1. From the NMM menu, choose Tools >> Gather Logs.

    2. You may choose to deselect any files you know are irrelevant. If you are not sure, just leave everything selected. 

    3. Change the name of the destination zip file, if desired.

    4. Optionally, choose the Upload to AWS S3 checkbox (the machine must have internet access)

    5. Click the OK button to create the designated zip file.

Create Logs

NLINK 8x is designed to run in "perpetual logging" mode, but if your particular environment has been set to not generate logs, you will need to follow these steps to create the diagnostic logs.

  1. Set the Logging Level to Debug.

    1. In the NMM, choose Edit >> System Properties

    2. Set Logging Level to Debug (or lower)

    3. Click the OK button

  2. Do whatever you need to do to create the situation that needs to be traced (e.g., run an NLINK event)

  3. Turn off the trace properties, if desired. (Definitely do this if you selected any level lower than Debug)

    1. In the NMM, choose Edit >> System Properties

    2. Set Logging Level to Production (or leave it at Debug if appropriate)

    3. Click the OK button

  4. Gather logs as described in the previous section.

 

Note

 NLINK trace files tend to be small, but they do accumulate over time. Use the System Property Keep logs for n days to let the NLINK Manager service clean up the contents of the Logs folder automatically based on file modification date. Note that cumulative log files may not get purged if they are written to frequently, so you should still monitor the Logs folder to purge obsolete files on a regular basis.

Video

Product Note: NLINK Traces and Logs