Diagnostics Class

Package:

com.microsoft.cognitiveservices.speech

Maven Artifact:

com.microsoft.cognitiveservices.speech:client-sdk:1.42.0

• java.lang.Object
• • com.microsoft.cognitiveservices.speech.Diagnostics

public final class Diagnostics

Native logging and other diagnostics

Constructor Summary

Constructor	Description
Diagnostics()

Method Summary

Modifier and Type	Method and Description
static void	dumpMemoryLog(String filename, String linePrefix, boolean emitToStdOut, boolean emitToStdErr) Dumps the contents of the memory logger to a file.
static void	dumpMemoryLogOnExit(String filename, String linePrefix, boolean emitToStdOut, boolean emitToStdErr) Dumps the contents of the memory logger on exit
static void	startConsoleLogging() Starts console (for Android, logcat) logging
static void	startConsoleLogging(boolean logToStderr) Starts console (for Android, logcat) logging
static void	startFileLogging(String filename, boolean append) Enables the native file logger
static void	startMemoryLogging() Enables the native memory logger
static void	stopConsoleLogging() Stops console logging
static void	stopFileLogging() Stops the native file logger
static void	stopMemoryLogging() Stops the native memory logger

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

Diagnostics

public Diagnostics()

Method Details

dumpMemoryLog

public static void dumpMemoryLog(String filename, String linePrefix, boolean emitToStdOut, boolean emitToStdErr)

Dumps the contents of the memory logger to a file.

Parameters:

filename - name to a log file on local disk.

linePrefix - The prefix to apply to each line of logged memory content, e.g. "CRBN"

emitToStdOut - Whether the log should be emitted to standard output (for Android, logcat) in addition to any other targets

emitToStdErr - Whether the log should be emitted to standard error (for Android, logcat) in addition to any other targets

dumpMemoryLogOnExit

public static void dumpMemoryLogOnExit(String filename, String linePrefix, boolean emitToStdOut, boolean emitToStdErr)

Dumps the contents of the memory logger on exit

Parameters:

filename - The name of the file to write to. Set this to an empty string if not needed

linePrefix - The prefix to apply to each line of logged memory content, e.g. "CRBN"

emitToStdOut - Whether the log should be emitted to standard output (for Android, logcat) in addition to any other targets

emitToStdErr - Whether the log should be emitted to standard error (for Android, logcat) in addition to any other targets

startConsoleLogging

public static void startConsoleLogging()

Starts console (for Android, logcat) logging

startConsoleLogging

public static void startConsoleLogging(boolean logToStderr)

Starts console (for Android, logcat) logging

Parameters:

logToStderr - Whether the log should be emitted to standard error or standard out; has no effect on Android.

startFileLogging

public static void startFileLogging(String filename, boolean append)

Enables the native file logger

Parameters:

filename - The name of resulting log file

append - If true will append to file (if already exists). Otherwise will create a new file

startMemoryLogging

public static void startMemoryLogging()

Enables the native memory logger

stopConsoleLogging

public static void stopConsoleLogging()

Stops console logging

stopFileLogging

public static void stopFileLogging()

Stops the native file logger

stopMemoryLogging

public static void stopMemoryLogging()

Stops the native memory logger