Troubleshoot OC Admin

This section details some resolutions to common issues that may arise during use of OC Admin.

Logs

The OC Admin Server logs a sizable amount of information.

Location

All logs are accessible via the following Docker command:

docker logs --follow oc-admin

The logs are divided in several categories:

Changing the Log Level

This operation requires modifying an important OC Admin configuration file.

Please follow the instructions carefully, as an error could prevent OC Admin from functioning correctly.

To check or change the Log Level, perform the following steps:

1. Open a new Shell inside the OC Admin container (oc-admin).

   CODE

   docker exec -it oc-admin sh 

2. Double check the current directory is /app .

   CODE

   pwd

3. Open the .env file into a Text editor.

   CODE

   vi .env 

4. Change the value of the LOGLEVEL variable to either:
   • Critical
   • Error
   • Warning
   • Information (default value) 
   • Verbose (necessary to see the HTTP Request logs)
   • Debug (not recommended)

5. Save the file by running the following from within vi:

   CODE

   : x

   

   Do not include the space.

6. Exit the running container:

   CODE

   exit 

7. Restart the OC Admin Server container:

   CODE

   ./lrctl oc-admin restart

Configuration Files

Location

1. Inside the OC Admin container (oc-admin), the files are all located under /app .
2. View the .env and .env.sample files from this directory.
3. View the config/ directory for the current configuration.

4. Open the config.sample/ directory to see examples of configuration files

   

   This directory contains a file set containing illustrative values.

Files

File Names	Location	Descriptions
.env	./	Stores low level configuration: Host binding IP, listening Port, Log level, etc. Use caution in this directory, as errors can cause OC Admin to stop functioning.
.env.sample	./	Same as above, but with only illustrative values and comments
https.cert.pem	./config/ & ./config.sample/	Provided as part of the Self-Signed HTTPS certificate.
https.key.pem	./config/ & ./config.sample/	Provided as part of the Self-Signed HTTPS certificate.
https.keytmp.pem	./config/ & ./config.sample/	Provided as part of the Self-Signed HTTPS certificate.
https.HOW TO - README.txt	./config/ & ./config.sample/	Explanation on how to create your own Self-Signed HTTPS certificate.
secure.json	./config/ & ./config.sample/	Stores the AES key used to encrypt secrets provided by the user via the UI.
ez-market-place.json	./config/ & ./config.sample/	Stores the unique deployment ID, the base URL for the Marketplace API, and the Public Key of the Marketplace.

HTTPS Certificate

By default, the certificate provided is a temporary Self-Signed certificate.

This default certificate could prevent some of the API calls from working if the window is left open for too long, as the "bypass the bad certificate" action from the user can timeout. The user will not see it, but the next API call will fail.

In this case, the solution is to either:

• Without losing unsaved changes:
  1. Open a second tab to the same URL.
  2. Bypass the "bad certificate" warning.
  3. Try to hit the API again (by clicking Save, or repeating the previous failed action).
• Losing all unsaved changes:
  1. Log out.
  2. Click refresh.
  3. Log back in.

Simply refreshing the page may not ask for a login, but it will break the socket connection. Logging out and then logging back in after a refresh ensures that the socket connection is properly established.

Shipper Logs (Tail/Field Mapping Editor)

These logs can reveal why the Tail is not providing logs to the Field Mapping Editor.

The shipper logs can be accessed from the main OC Admin page by performing the following steps:

1. From the menu, open the Advanced drop-list.
2. Toggle the Show Communication & Shipper's Logs to active.
3. Scroll to the bottom of the page (past the last field of the Editor, if active).

Some errors may not be in red. The shipper's logs can be verbose and difficult to navigate.