Installer, Application, and Job Logs Using REST API
Learn how to manage logs using the REST API.
Table of Contents
Installer Logs
Installer logs are located in C:\Users\{{User}}\AppData\Local\Temp\bitrock_installer.txt.
Application/System Logs
The default location for the DryvIQ application logs is C:\ProgramData\SkySync\v4\Logs\Log.txt.
Job Logs
The default location for the DryvIQ job logs is C:\ProgramData\SkySync\v4\Logs\Log{{job_id}}.txt.
In each job log, you will find the job's configuration.
{"Date":"2018-10-09 03:19:54.9811","Level":"Info","Name":"TransferExecutor","Message":"TransferOptions: {\"source\":{\"connection\":{\"id\":\"d7406bf94fc3435591812ec61f969710\",\"name\":\"\\\\\\\\Win-XXXX\\\\nfs1\",\"platform\":{\"id\":\"nfs\",\"name\":\"Network File System\",\"group\":\"on-premise\",\"features\":{\"accounts\":true,\"accessed_on\":true,\"upload_details\":true,\"native_move\":{\"timestamps\":true,\"replace\":true},\"permissions\":{\"allow\":true,\"disinheritance\":true},\"hidden\":true},\"path\":{\"validation\":{\"total\":{\"max\":32767},\"prevent\":{\"trailing_periods\":true,\"trailing_whitespace_after_extension\":true},\"invalid_characters\":[\"|\",\"\\u0000\",\"\\u0001\",\"\\u0002\",\"\\u0003\",\"\\u0004\",\"\\u0005\",\"\\u0006\",\"\\u0007\",\"\\b\",\"\\t\",\"\\n\",\"\\u000b\",\"\\f\",\"\\r\",\"\\u000e\",\"\\u000f\",\"\\u0010\",\"\\u0011\",\"\\u0012\",\"\\u0013\",\"\\u0014\",\"\\u0015\",\"\\u0016\",\"\\u0017\",\"\\u0018\",\"\\u0019\",\"\\u001a\",\"\\u001b\",\"\\u001c\",\"\\u001d\",\"\\u001e\",\"\\u001f\",\"\\\"\",\"<\",\">\",\"|\",\"\\u0000\",\"\\u0001\",\"\\u0002\",\"\\u0003\",\"\\u0004\",\"\\u0005\",\"\\u0006\",\"\\u0007\",\"\\b\",\"\\t\",\"\\n\",\"\\u000b\",\"\\f\",\"\\r\",\"\\u000e\",\"\\u000f\",\"\\u0010\",\"\\u0011\",\"\\u0012\",\"\\u0013\",\"\\u0014\",\"\\u0015\",\"\\u0016\",\"\\u0017\",\"\\u0018\",\"\\u0019\",\"\\u001a\",\"\\u001b\",\"\\u001c\",\"\\u001d\",\"\\u001e\",\"\\u001f\",\":\",\"*\",\"?\",\"\\\\\",\"\/\"]}},\"type\":\"platform\"},\"auth\":\"<Content not shown>\",\"group\":false,\"load_strategy\":{\"by_path\":true,\"parent\":true,\"filter_expression\":true,\"by_type\":true},\"features\":{\"rate_limit\":-1,\"integrated_auth\":true,\"accounts\":true,\"accessed_on\":true,\"upload_details\":true,\"native_move\":{\"timestamps\":true,\"replace\":true},\"permissions\":{\"allow\":true,\"disinheritance\":true},\"hidden\":true},\"path\":{\"validation\":{\"total\":{\"max\":32767},\"prevent\":{\"trailing_periods\":true,\"trailing_whitespace_after_extension\":true},\"invalid_characters\":[\"|\",\"\\u0000\",\"\\u0001\",\"\\u0002\",\"\\u0003\",\"\\u0004\",\"\\u0005\",\"\\u0006\",\"\\u0007\",\"\\b\",\"\\t\",\"\\n\",\"\\u000b\",\"\\f\",\"\\r\",\"\\u000e\",\"\\u000f\",\"\\u0010\",\"\\u0011\",\"\\u0012\",\"\\u0013\",\"\\u0014\",\"\\u0015\",\"\\u0016\",\"\\u0017\",\"\\u0018\",\"\\u0019\",\"\\u001a\",\"\\u001b\",\"\\u001c\",\"\\u001d\",\"\\u001e\",\"\\u001f\",\"\\\"\",\"<\",\">\",\"|\",\"\\u0000\",\"\\u0001\",\"\\u0002\",\"\\u0003\",\"\\u0004\",\"\\u0005\",\"\\u0006\",\"\\u0007\",\"\\b\",\"\\t\",\"\\n\",\"\\u000b\",\"\\f\",\"\\r\",\"\\u000e\",\"\\u000f\",\"\\u0010\",\"\\u0011\",\"\\u0012\",\"\\u0013\",\"\\u0014\",\"\\u0015\",\"\\u0016\",\"\\u0017\",\"\\u0018\",\"\\u0019\",\"\\u001a\",\"\\u001b\",\"\\u001c\",\"\\u001d\",\"\\u001e\",\"\\u001f\",\":\",\"*\",\"?\",\"\\\\\",\"\/\"]}},\"allowed_types\":{\"default\":{\"item\":{\"id\":\"f\",\"caption\":\"File\",\"type\":\"item\"},\"container\":{\"id\":\"d\",\"caption\":\"Directory\",\"type\":\"container\"}},\"supported\":[{\"id\":\"d\",\"caption\":\"Directory\",\"type\":\"container\"},{\"id\":\"f\",\"caption\":\"File\",\"type\":\"item\"}],\"all\":[{\"id\":\"d\",\"caption\":\"Directory\",\"type\":\"container\"},{\"id\":\"f\",\"caption\":\"File\",\"type\":\"item\"}]},\"disabled\":false,\"type\":\"connection\"},\"target\":{}},\"destination\":{\"connection\":{\"id\":\"8f4bfc7e77b0454b9e1dccc282ba3324\",\"name\":\"Box (Joe Smith)\",\"platform\":{\"id\":\"box\",\"name\":\"Box\",\"group\":\"cloud\",\"features\":{\"accounts\":true,\"admin_mode\":true,\"versioning\":{\"allow\":true,\"promote\":true,\"delete\":true},\"upload_details\":true,\"impersonation\":{\"per_request\":true,\"rate_limit_after\":true},\"checkout\":{\"allow\":true,\"get_owner\":true,\"set_owner\":true},\"max_size\":16106127360,\"native_move\":{\"versions\":true,\"metadata\":true,\"permissions\":true,\"ownership\":true,\"timestamps\":true,\"tags\":true},\"native_copy\":{\"ownership\":true},\"permissions\":{\"allow\":true,\"links\":true},\"shared\":true,\"timestamps\":true,\"query_account\":{\"by_email\":true,\"by_name\":true,\"query_memberships\":true,\"allow\":true,\"filter\":true,\"by_id\":true,\"page\":true},\"provision_account\":{\"memberships\":true,\"allow\":true,\"deletes\":true},\"query_group\":{\"allow\":true,\"by_id\":true,\"page\":true},\"provision_group\":{\"allow\":true,\"deletes\":true},\"metadata\":{\"allow\":true,\"supports_schema\":true},\"tags\":{\"allow\":true,\"atomic_read\":true},\"api_key\":{\"client_id\":true,\"client_secret\":true,\"default\":true}},\"authorize\":{\"prompt\":{\"height\":625.0,\"width\":400.0}},\"path\":{\"validation\":{\"segment\":{\"max\":255},\"prevent\":{\"leading_whitespace\":true,\"trailing_whitespace_after_extension\":true,\"non_printable\":true},\"invalid_characters\":[\"\/\",\"\\\\\"]}},\"type\":\"platform\"},\"auth\":\"<Content not shown>\",\"group\":false,\"account\":{\"name\":\"Steve Woodward\",\"email\":\"swoodward@portalarchitects.com\",\"id\":\"197717922\",\"type\":\"account\"},\"load_strategy\":{\"by_id\":true,\"parent\":true,\"page_by_offset\":true},\"features\":{\"admin\":true,\"quota\":{\"bytes\":40692965716.0,\"quota\":1073741824000.0},\"accounts\":true,\"admin_mode\":true,\"versioning\":{\"allow\":true,\"promote\":true,\"delete\":true},\"upload_details\":true,\"impersonation\":{\"per_request\":true,\"rate_limit_after\":true},\"checkout\":{\"allow\":true,\"get_owner\":true,\"set_owner\":true},\"max_size\":16106127360,\"native_move\":{\"versions\":true,\"metadata\":true,\"permissions\":true,\"ownership\":true,\"timestamps\":true,\"tags\":true},\"native_copy\":{\"ownership\":true},\"permissions\":{\"allow\":true,\"links\":true},\"shared\":true,\"timestamps\":true,\"query_account\":{\"by_email\":true,\"by_name\":true,\"query_memberships\":true,\"allow\":true,\"filter\":true,\"by_id\":true,\"page\":true},\"provision_account\":{\"memberships\":true,\"allow\":true,\"deletes\":true},\"query_group\":{\"allow\":true,\"by_id\":true,\"page\":true},\"provision_group\":{\"allow\":true,\"deletes\":true},\"metadata\":{\"allow\":true,\"supports_schema\":true},\"tags\":{\"allow\":true,\"atomic_read\":true},\"api_key\":{\"client_id\":true,\"client_secret\":true,\"default\":true}},\"path\":{\"validation\":{\"segment\":{\"max\":255},\"prevent\":{\"leading_whitespace\":true,\"trailing_whitespace_after_extension\":true,\"non_printable\":true},\"invalid_characters\":[\"\/\",\"\\\\\"]}},\"allowed_types\":{\"supported\":[{\"id\":\"u\",\"caption\":\"User\",\"type\":\"container\"}],\"all\":[{\"id\":\"u\",\"caption\":\"User\",\"type\":\"container\"},{\"id\":\"f\",\"caption\":\"File\",\"type\":\"item\"},{\"id\":\"d\",\"caption\":\"Directory\",\"type\":\"container\"}]},\"disabled\":false,\"modified_on\":\"2018-10-09T10:19:10+00:00\",\"type\":\"connection\"},\"target\":{\"item\":{\"parent\":{\"parent\":{\"root\":true,\"name\":\"jsmith@portalarchitects.com\"},\"name\":\"MetadataImport\"},\"name\":\"LicenseTest\"}}},\"transfer_type\":\"copy\",\"batch_mode\":\"always\",\"performance\":{\"parallel_writes\":{\"max\":32}},\"type\":\"transfer\"}","TransferID":"52b6e4a99046412386f2f40372016d25","TransferName":"Test SF-54","ExecutionID":"21","JobID":"52b6e4a99046412386f2f40372016d25","ActionId":"ea1df353-662c-46d8-994c-a1faa7ce7430","ActionName":"PortalArchitects.Licensing.Services.V1.LicensingController.Activate (PortalArchitects.Licensing.Services)","RequestId":"0HLHD3SNDNA0N:00000009","RequestPath":"","ConnectionId":"0HLHD3SNDNA0N"}
Audit Level and Retention Days
You can customize the audit level for system-level and job logs, and you can set the number of days the system log is retained.
Log/Audit Level
The audit level determines the information included in the log.
- error: Logs only errors
- warn: Logs warnings and errors.
- info: Includes all basic logging, warnings, and errors. This is the system default.
- trace: Includes all log levels. This setting is ideal for debugging.
A log Level of “info” is required for full DryvIQ Report functionality.
Set Retention Days
The retention days setting determines how long the system log is retained. The default value is 21 days.
Audit Level and Retention Days Example
POST {{url}}v1/diagnostics/logs/configuration
{
"level": "trace",
"retention_days": 21
}
Job Level Logging Example
POST {{url}}v1/jobs
{
"name":"Simple Job",
"kind": "transfer",
"transfer": {
"transfer_type": "copy",
"batch_mode": "always",
"audit_level": "info",
"permissions": {
"policy": "add",
"failures": "exceptions"
},
"timestamps": true,
"empty_containers": "create",
"versioning": {
"preserve": "native",
"select": "latest"
},
"source": {
"connection": { "id": "{{cloud_connection_source}}" },
"target": {
"path": "/SourceFolder"
}
},
"destination": {
"connection": { "id": "{{cloud_connection_destination}}" },
"target": {
"path": "/DestinationFolder"
}
},
"simulation_mode": false
},
"schedule": {
"mode": "manual"
},
"stop_policy": {
"on_success": 5,
"on_failure": 5,
"on_execute": 25
},
"category": {
"name": "Report | Simple Job"
}
}