Skip to content

Commit c1e7522

Browse files
authored
Merge pull request #4838 from SkylineCommunications/logsettingsschema
logsettings XML schema
2 parents af0ec40 + f015e84 commit c1e7522

15 files changed

+279
-14
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
uid: Log.File
3+
---
4+
5+
# File element
6+
7+
Specifies the log level configuration for the specified file.
8+
9+
## Type
10+
11+
[FileElementType](xref:LogSettings-FileElementType)
12+
13+
## Parents
14+
15+
[Log](xref:LogSettingsLog)
16+
17+
## Attributes
18+
19+
| Name | Type | Required | Description |
20+
| --- | --- | --- | --- |
21+
| [name](xref:LogSettings-FileElementType-name) | string | | Specifies the name of the log file (without the extension) to which the settings belong. |
22+
23+
## Children
24+
25+
| Name | Occurrences | Description |
26+
| --- | --- | --- |
27+
| [Levels](xref:LogSettings-FileElementType.Levels) | | Specifies the log levels for the different log types. |
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
uid: Log.General.LinesPerIteration
3+
---
4+
5+
# LinesPerIteration element
6+
7+
Specifies the maximum number of lines to be taken from the buffer of a log file in one iteration.
8+
9+
Default: 100 lines.
10+
11+
## Content Type
12+
13+
int
14+
15+
## Parents
16+
17+
[General](xref:Log.General)
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
uid: Log.General.SLLogMaxMemory
3+
---
4+
5+
# SLLogMaxMemory element
6+
7+
Specifies the maximum memory size of the SLLog process in MB.
8+
9+
Default: 500 MB.
10+
11+
## Content Type
12+
13+
int
14+
15+
## Parents
16+
17+
[General](xref:Log.General)
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
uid: Log.General
3+
---
4+
5+
# General element
6+
7+
Specifies general log settings.
8+
9+
## Parents
10+
11+
[Log](xref:LogSettingsLog)
12+
13+
## Children
14+
15+
| Name | Occurrences | Description |
16+
| --- | --- | --- |
17+
| All | | |
18+
| &#160;&#160;[LinesPerIteration](xref:Log.General.LinesPerIteration) | [0, 1] | Specifies the maximum number of lines to be taken from the buffer of a log file in one iteration.<br>Default: 100 lines. |
19+
| &#160;&#160;[SLLogMaxMemory](xref:Log.General.SLLogMaxMemory) | [0, 1] | Specifies the maximum memory size of the SLLog process in MB.<br>Default: 500 MB. |
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
uid: LogSettingsLog
3+
---
4+
5+
# Log element
6+
7+
Specifies the log settings.
8+
9+
## Children
10+
11+
| Name | Occurrences | Description |
12+
| --- | --- | --- |
13+
| Sequence | | |
14+
| &#160;&#160;[File](xref:Log.File) | [0, *] | Specifies the log level configuration for the specified file. |
15+
| &#160;&#160;Sequence | [0, 1] | |
16+
| &#160;&#160;&#160;&#160;[General](xref:Log.General) | | Specifies general log settings. |
17+
| &#160;&#160;&#160;&#160;[File](xref:Log.File) | [0, *] | Specifies the log level configuration for the specified file. |
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
uid: LogSettings-FileElementType-name
3+
---
4+
5+
# name attribute
6+
7+
Specifies the name of the log file (without the extension) to which the settings belong.
8+
9+
## Content Type
10+
11+
string
12+
13+
## Parents
14+
15+
[FileElementType](xref:LogSettings-FileElementType), [File](xref:Log.File), [File](xref:Log.File)
16+
17+
## Remarks
18+
19+
When name is empty, this represents the default log settings.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
uid: LogSettings-FileElementType.Levels-debug
3+
---
4+
5+
# debug attribute
6+
7+
Specifies the debug logging level.
8+
9+
## Content Type
10+
11+
int
12+
13+
## Parents
14+
15+
[Levels](xref:LogSettings-FileElementType.Levels)
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
uid: LogSettings-FileElementType.Levels-error
3+
---
4+
5+
# error attribute
6+
7+
Specifies the error logging level.
8+
9+
## Content Type
10+
11+
int
12+
13+
## Parents
14+
15+
[Levels](xref:LogSettings-FileElementType.Levels)
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
uid: LogSettings-FileElementType.Levels-info
3+
---
4+
5+
# info attribute
6+
7+
Specifies the info logging level.
8+
9+
## Content Type
10+
11+
int
12+
13+
## Parents
14+
15+
[Levels](xref:LogSettings-FileElementType.Levels)
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
uid: LogSettings-FileElementType.Levels
3+
---
4+
5+
# Levels element
6+
7+
Specifies the log levels for the different log types.
8+
9+
## Parents
10+
11+
[FileElementType](xref:LogSettings-FileElementType), [File](xref:Log.File), [File](xref:Log.File)
12+
13+
## Attributes
14+
15+
| Name | Type | Required | Description |
16+
| --- | --- | --- | --- |
17+
| [debug](xref:LogSettings-FileElementType.Levels-debug) | int | | Specifies the debug logging level. |
18+
| [error](xref:LogSettings-FileElementType.Levels-error) | int | | Specifies the error logging level. |
19+
| [info](xref:LogSettings-FileElementType.Levels-info) | int | | Specifies the info logging level. |

0 commit comments

Comments
 (0)