18 Troubleshooting

Oracle Key Vault SDK programs can be debugged using the tracing infrastructure which is included as a part of Oracle Key Vault SDK deliverable.

Refer the content below for using the tracing infrastructure for C SDK and Java SDK programs.

• C SDK Tracing: Before turning on the tracing, identify the version of C SDK software being used on your system as shown below. If you have deployed C SDK under $OKV_HOME, then execute the following commands:

  cd $OKV_HOME/csdk/lib
  strings libokvcsdk.so | grep "Oracle Key Vault C SDK Version"

  The Oracle Key Vault C SDK supports an extensive tracing infrastructure in order to debug errors encountered during execution of a C SDK endpoint program. The tracing can be enabled for a C SDK program using the okvEnvSetTrace API. The Oracle Key Vault C SDK supports different trace levels to filter trace messages generated for a C SDK endpoint program. Refer to section okvEnvSetTrace to find information on various trace levels and refer the example in same section to enable tracing for a C SDK endpoint program. The trace files can be found in the location provided as input to okvEnvSetTrace API call. The trace files have the format okv_csdk_<Process_ID_of_CSDK_Program>.trc.

• Java SDK Tracing: Before turning on the tracing, identify the version of Java SDK software being used on your system as shown below. If you have deployed Java SDK under $OKV_HOME, then execute the following commands:

  cd $OKV_HOME/jsdk/lib
  unzip -p okvjsdk.jar | strings | grep "Oracle Key Vault Java SDK Version"

  Tracing for the Oracle Key Vault Java SDK is supported at the standard java.util.logging trace levels: OFF, SEVERE, WARNING, INFO, FINE, FINER, and ALL. Tracing can be turned on by setting the trace level in configuration file logging.properties. This configuration file is provided as part of the Oracle Key Vault Java SDK deliverable. Please make sure to turn on the global trace level .level and java.util.logging.FileHandler.level in the configuration file so that the Java SDK traces are generated in a file. Also you may change the directory in which you want the trace file to be generated by editing the property java.util.logging.FileHandler.pattern in the configuration file.

  For more information on trace levels, refer to https://docs.oracle.com/javase/7/docs/api/java/util/logging/Level.html. For more information on java.util.logging FileHandler, refer to https://docs.oracle.com/javase/7/docs/api/java/util/logging/FileHandler.html.

Provide the SDK version information and the trace logs when raising SDK issues to support team. Note that no sensitive information is written to a trace file during program execution.