Namespace Microsoft::CognitiveServices::Speech::Diagnostics::Logging
Summary
| Members | Descriptions |
|---|---|
| enum Level | Defines the different available log levels. |
| class Diagnostics::Logging::EventLogger | Class with static methods to control callback-based SDK logging. Turning on logging while running your Speech SDK scenario provides detailed information from the SDK's core native components. If you report an issue to Microsoft, you may be asked to provide logs to help Microsoft diagnose the issue. Your application should not take dependency on particular log strings, as they may change from one SDK release to another without notice. Use EventLogger when you want to get access to new log strings as soon as they are available, and you need to further process them. For example, integrating Speech SDK logs with your existing logging collection system. Added in version 1.20.0. |
| class Diagnostics::Logging::FileLogger | Class with static methods to control file-based SDK logging. Turning on logging while running your Speech SDK scenario provides detailed information from the SDK's core native components. If you report an issue to Microsoft, you may be asked to provide logs to help Microsoft diagnose the issue. Your application should not take dependency on particular log strings, as they may change from one SDK release to another without notice. FileLogger is the simplest logging solution and suitable for diagnosing most on-device issues when running Speech SDK. Added in version 1.20.0. |
| class Diagnostics::Logging::MemoryLogger | Class with static methods to control SDK logging into an in-memory buffer. Turning on logging while running your Speech SDK scenario provides detailed information from the SDK's core native components. If you report an issue to Microsoft, you may be asked to provide logs to help Microsoft diagnose the issue. Your application should not take dependency on particular log strings, as they may change from one SDK release to another without notice. MemoryLogger is designed for the case where you want to get access to logs that were taken in the short duration before some unexpected event happens. For example, if you are running a Speech Recognizer, you may want to dump the MemoryLogger after getting an event indicating recognition was canceled due to some error. The size of the memory buffer is fixed at 2MB and cannot be changed. This is a "ring" buffer, that is, new log strings written replace the oldest ones in the buffer. Added in version 1.20.0. |
Members
enum Level
| Values | Descriptions |
|---|---|
| Error | Error logging level. Only errors will be logged. |
| Warning | Warning logging level. Only errors and warnings will be logged. |
| Info | Informational logging level. Only errors, warnings and informational log messages will be logged. |
| Verbose | Verbose logging level. All log messages will be logged. |
Defines the different available log levels.
This is used by different loggers to set the maximum level of detail they will output.