You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/ai-services/speech-service/includes/how-to/diagnostics/intro.md
+5-6Lines changed: 5 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,13 +6,12 @@ ms.date: 03/18/2025
6
6
ms.author: changfu001
7
7
---
8
8
9
-
Starting from version 1.43.0, SDK extends logging mechanism with three types of loggers: `File logger`, `Memory logger` and `Event logger`.
9
+
Starting from version 1.43.0, SDK extends logging mechanism with three types of loggers: `File logger`, `Memory logger`, and `Event logger`.
10
10
11
-
`File logger` is the simplest logging solution and suitable for diagnosing most on-device issues when running Speech SDK.
11
+
`File logger` is the simplest logging solution, and is suitable for diagnosing most on-device issues when running Speech SDK.
12
12
13
-
`Memory logger` is a logging solution that stores log messages in memory. It is suitable for diagnosing issues that occur in a short period of time. For example, if you are running a Speech Recognizer, you may want to dump the memory logger 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.
13
+
`Memory logger` is a logging solution that stores log messages in memory. It is suitable for diagnosing issues that occur in a short period of time. For example, if you are running a Speech Recognizer, you may want to dump the memory logger 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 class is a "ring" buffer, that is, new log strings written replace the oldest ones in the buffer.
14
14
15
-
`Event logger` is a logging solution that sends log messages to the event handler which is provided by the developer. It is suitable for diagnosing issues when certain new log strings are as soon as available and need for further processing. For example, integrating Speech SDK logs with your existing logging collection system.
15
+
`Event logger` is a logging solution that sends log messages to the event handler which is provided by the developer. It is suitable for diagnosing issues when certain new log strings need to be available as soon as possible, and need further processing. For example, integrating Speech SDK logs with your existing logging collection system.
16
16
17
-
`File logger, memory logger and event logger` all have filter mechanism by only logging certain string messages. Also these loggers are process wide constructs. That means that if (for example) you have multiple speech recognizer objects running in parallel, there will be one log file containing interleaved logs lines from all recognizers. You cannot get a separate file logger for each recognizer. Similarly, there will be one
18
-
memory buffer containing interleaved logs from all recognizers and you can only register one event handler as callback function to receive interleaved logs from all recognizers. You cannot get a separate memory logger for each recognizer and you cannot register an event handler for each recognizer. However, `File logger, memory logger and event logger` can coexist in the same process or in the same recognizer.
17
+
`File logger`, `memory logger`, and `event logger` all have a filter mechanism by only logging certain string messages. Also, these loggers are process wide constructs. That means that if you have multiple speech recognizer objects running in parallel, there is only one log file that contains interleaved log lines from all recognizers. You cannot get a separate file logger for each recognizer. Similarly, there will only be one memory buffer containing interleaved logs from all recognizers, and you can only register one event handler as the callback function to receive interleaved logs from all recognizers. You cannot get a separate memory logger for each recognizer, and you cannot register an event handler for each recognizer. However, `File logger`, `memory logger`, and `event logger` can coexist in the same process or in the same recognizer.
0 commit comments