-
Notifications
You must be signed in to change notification settings - Fork 256
/
MemoryLogger.xml
234 lines (234 loc) · 13.1 KB
/
MemoryLogger.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
<Type Name="MemoryLogger" FullName="Microsoft.CognitiveServices.Speech.Diagnostics.Logging.MemoryLogger">
<TypeSignature Language="C#" Value="public static class MemoryLogger" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit MemoryLogger extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.CognitiveServices.Speech.Diagnostics.Logging.MemoryLogger" />
<TypeSignature Language="VB.NET" Value="Public Class MemoryLogger" />
<TypeSignature Language="F#" Value="type MemoryLogger = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.20.0.28</AssemblyVersion>
<AssemblyVersion>1.21.0.28</AssemblyVersion>
<AssemblyVersion>1.22.0.28</AssemblyVersion>
<AssemblyVersion>1.23.0.28</AssemblyVersion>
<AssemblyVersion>1.24.0.28</AssemblyVersion>
<AssemblyVersion>1.24.1.28</AssemblyVersion>
<AssemblyVersion>1.25.1.26</AssemblyVersion>
<AssemblyVersion>1.27.0.28</AssemblyVersion>
<AssemblyVersion>1.28.0.28</AssemblyVersion>
<AssemblyVersion>1.30.0.28</AssemblyVersion>
<AssemblyVersion>1.31.0.28</AssemblyVersion>
<AssemblyVersion>1.32.1.28</AssemblyVersion>
<AssemblyVersion>1.34.0.28</AssemblyVersion>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
A static class 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
</summary>
<remarks>Memory logging is a process wide construct. That means that if (for example)
you have multiple speech recognizer objects running in parallel, there will be one
memory buffer containing interleaved logs from all recognizers. You cannot get a
separate logs for each recognizer.</remarks>
</Docs>
<Members>
<Member MemberName="Dump">
<MemberSignature Language="C#" Value="public static System.Collections.Generic.IEnumerable<string> Dump ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Collections.Generic.IEnumerable`1<string> Dump() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Diagnostics.Logging.MemoryLogger.Dump" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Dump () As IEnumerable(Of String)" />
<MemberSignature Language="F#" Value="static member Dump : unit -> seq<string>" Usage="Microsoft.CognitiveServices.Speech.Diagnostics.Logging.MemoryLogger.Dump " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<System.String></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns the content of the whole memory buffer as a string enumerable.
For example, you can access it as a string list by calling MemoryLogger.Dump().ToList<string>().
It does not block other SDK threads from continuing to log into the buffer.
</summary>
<returns>A string enumerable of the contents of the memory buffer copied into it.</returns>
<remarks>This does not reset (clear) the memory buffer.</remarks>
</Docs>
</Member>
<Member MemberName="Dump">
<MemberSignature Language="C#" Value="public static void Dump (System.IO.TextWriter writer);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void Dump(class System.IO.TextWriter writer) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Diagnostics.Logging.MemoryLogger.Dump(System.IO.TextWriter)" />
<MemberSignature Language="VB.NET" Value="Public Shared Sub Dump (writer As TextWriter)" />
<MemberSignature Language="F#" Value="static member Dump : System.IO.TextWriter -> unit" Usage="Microsoft.CognitiveServices.Speech.Diagnostics.Logging.MemoryLogger.Dump writer" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.IO.TextWriter" />
</Parameters>
<Docs>
<param name="writer">TextWriter object to write to.</param>
<summary>
Writes the content of the whole memory buffer to an object that implements System.IO.TextWriter.
For example, System.Console.Out (for console output).
It does not block other SDK threads from continuing to log into the buffer.
</summary>
<remarks>This does not reset (clear) the memory buffer.</remarks>
</Docs>
</Member>
<Member MemberName="Dump">
<MemberSignature Language="C#" Value="public static void Dump (string filePath);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void Dump(string filePath) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Diagnostics.Logging.MemoryLogger.Dump(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Sub Dump (filePath As String)" />
<MemberSignature Language="F#" Value="static member Dump : string -> unit" Usage="Microsoft.CognitiveServices.Speech.Diagnostics.Logging.MemoryLogger.Dump filePath" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filePath" Type="System.String" />
</Parameters>
<Docs>
<param name="filePath">Path to a log file on local disk.</param>
<summary>
Writes the content of the whole memory buffer to the specified file.
It does not block other SDK threads from continuing to log into the buffer.
</summary>
<remarks>This does not reset (clear) the memory buffer.</remarks>
</Docs>
</Member>
<Member MemberName="SetFilters">
<MemberSignature Language="C#" Value="public static void SetFilters (params string[] filters);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void SetFilters(string[] filters) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Diagnostics.Logging.MemoryLogger.SetFilters(System.String[])" />
<MemberSignature Language="VB.NET" Value="Public Shared Sub SetFilters (ParamArray filters As String())" />
<MemberSignature Language="F#" Value="static member SetFilters : string[] -> unit" Usage="Microsoft.CognitiveServices.Speech.Diagnostics.Logging.MemoryLogger.SetFilters filters" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="filters" Type="System.String[]">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ParamArray]</AttributeName>
<AttributeName Language="F#">[<System.ParamArray>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="filters">Filters to use, or an empty list to remove previously set filters.</param>
<summary>
Sets or clears filters for memory logging.
Once filters are set, memory logger will only be updated with log strings
containing at least one of the strings specified by the filters. The match is case sensitive.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetLevel">
<MemberSignature Language="C#" Value="public static void SetLevel (Microsoft.CognitiveServices.Speech.Diagnostics.Logging.Level level);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void SetLevel(valuetype Microsoft.CognitiveServices.Speech.Diagnostics.Logging.Level level) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Diagnostics.Logging.MemoryLogger.SetLevel(Microsoft.CognitiveServices.Speech.Diagnostics.Logging.Level)" />
<MemberSignature Language="VB.NET" Value="Public Shared Sub SetLevel (level As Level)" />
<MemberSignature Language="F#" Value="static member SetLevel : Microsoft.CognitiveServices.Speech.Diagnostics.Logging.Level -> unit" Usage="Microsoft.CognitiveServices.Speech.Diagnostics.Logging.MemoryLogger.SetLevel level" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="level" Type="Microsoft.CognitiveServices.Speech.Diagnostics.Logging.Level" />
</Parameters>
<Docs>
<param name="level">Maximum level of detail to be captured by the logger.</param>
<summary>
Sets the level of the messages to be captured by the logger
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Start">
<MemberSignature Language="C#" Value="public static void Start ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void Start() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Diagnostics.Logging.MemoryLogger.Start" />
<MemberSignature Language="VB.NET" Value="Public Shared Sub Start ()" />
<MemberSignature Language="F#" Value="static member Start : unit -> unit" Usage="Microsoft.CognitiveServices.Speech.Diagnostics.Logging.MemoryLogger.Start " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Starts logging into the internal memory buffer.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Stop">
<MemberSignature Language="C#" Value="public static void Stop ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void Stop() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.CognitiveServices.Speech.Diagnostics.Logging.MemoryLogger.Stop" />
<MemberSignature Language="VB.NET" Value="Public Shared Sub Stop ()" />
<MemberSignature Language="F#" Value="static member Stop : unit -> unit" Usage="Microsoft.CognitiveServices.Speech.Diagnostics.Logging.MemoryLogger.Stop " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.CognitiveServices.Speech.csharp</AssemblyName>
<AssemblyVersion>1.38.0.28</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Stops logging into the internal memory buffer.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>