General
XpoLog SDK provides a set of commands that enables remote configuration of different XpoLog properties without accessing the GUI.
The following commands are available.
...
Key | Description | Values |
|
api | The API type to use – must be addLog | “addLog” | Mandatory |
| logName | The name of the log to be created | Text | Mandatory |
| logId | The unique ID of a log in XpoLog that can be modified. In case logId is used, it is mandatory to use override true, since it is an edit mode of an existing log in XpoLog - all the paramters that will be passed in this commnand will override and update an existing log. | Text | Optional |
| logPath | The full path to the log under the Folders and Log Tree (excluding the log name) | ROOT = Top Folder (Folders and Logs) Use ‘->’ in the path between folders | Optional |
filesPath | The full path to the logs on the source:
| Text | Mandatory |
| collectionPolicy | The exact name of the collection policy to be assigned on the log (if doesn't exist, the command will be ignored) | TestText | Optional |
| accountName | The name of the account to be used if needed (SSH or Win Account or Remote XpoLog) | Text | Direct Access - Optional Win Network/SSH - Mandatory |
| patterns | A list of patterns that will be applied on the log that is added (separated by XPLG_SDK_SEP) | Text | Mandatory* |
| appTags | A comma separated list of appTags that the added log will be tagged to | Text | Optional |
| timezone | The timezone definition of the added log | Text (a value from JAVA time zone list) | Optional |
| charset | The charset definition of the added log | Text (a value from JAVA charset list) | Optional |
| template | The name of the template to be used | Text | Optional* specific parameters that are passed override template's settings |
| dataFilterQuery | The dataFilterQuery to be applied on the specified - see Advanced Log Settings for more information. (pass an empty filter to clear an existing filter) | Text | Optional |
override | Overwrite an existing log configuration (Default: false) | true/false | Optional |
...