AdvancedLoggingResource REST endpoint to access and manipulate the system logging level SWAGGER CONTRACT: https://app.swaggerhub.com/apis/WANdisco/logging/1.0.0
Get the current global log level example CURL command to get current root logger level: curl -I -u admin:pass -H "Content-Type: text/plain" -X GET "http://{host}:{port}/api/logger/level"
code | condition |
---|---|
200 | Ok |
503 | Service Unavailable - unable to get/retrieve LogLevelAdjustor implementation |
media type | data type | description |
---|---|---|
text/plain | object | response |
GET /logger/level
Content-Type: */*
Accept: text/plain
...
HTTP/1.1 200 OK
Content-Type: text/plain
...
Get a list of the valid log levels. example CURL command to get all available valid logger levels: curl -I -u admin:pass -H "Content-Type: application/json" -X GET "http://{host}:{port}/api/logger/levels"
code | condition |
---|---|
200 | Ok |
503 | Service Unavailable - unable to get/retrieve LogLevelAdjustor implementation |
media type | data type | description |
---|---|---|
application/json | Response (JSON) | response |
application/xml | response (XML) |
GET /logger/levels
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"date" : 12345,
"stringHeaders" : {
"property1" : [ "...", "..." ],
"property2" : [ "...", "..." ]
},
"links" : [ {
"rel" : "...",
"params" : {
"property1" : "...",
"property2" : "..."
},
"rels" : [ "...", "..." ],
"title" : "...",
"uri" : "...",
"type" : "...",
"uriBuilder" : { }
}, {
"rel" : "...",
"params" : {
"property1" : "...",
"property2" : "..."
},
"rels" : [ "...", "..." ],
"title" : "...",
"uri" : "...",
"type" : "...",
"uriBuilder" : { }
} ],
"closed" : true,
"length" : 12345,
"entity" : { },
"allowedMethods" : [ "...", "..." ],
"cookies" : {
"property1" : {
"expiry" : 12345,
"comment" : "...",
"secure" : true,
"httpOnly" : true,
"sameSite" : "LAX",
"maxAge" : 12345,
"domain" : "...",
"name" : "...",
"version" : 12345,
"path" : "...",
"value" : "..."
},
"property2" : {
"expiry" : 12345,
"comment" : "...",
"secure" : true,
"httpOnly" : true,
"sameSite" : "NONE",
"maxAge" : 12345,
"domain" : "...",
"name" : "...",
"version" : 12345,
"path" : "...",
"value" : "..."
}
},
"metadata" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"lastModified" : 12345,
"statusInfo" : {
"family" : "REDIRECTION",
"reasonPhrase" : "...",
"statusCode" : 12345
},
"location" : "...",
"language" : "...",
"headers" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"entityTag" : {
"weak" : true,
"value" : "..."
},
"mediaType" : {
"wildcardType" : true,
"type" : "...",
"parameters" : {
"property1" : "...",
"property2" : "..."
},
"wildcardSubtype" : true,
"subtype" : "..."
},
"status" : 12345
}
Get all currently modified loggers example CURL command to all currently modified loggers: curl -I -u admin:pass -H "Content-Type: application/json" -X GET "http://{host}:{port}/api/logger/loggers"
code | condition |
---|---|
200 | Ok |
503 | Service Unavailable - unable to get/retrieve LogLevelAdjustor implementation |
media type | data type | description |
---|---|---|
application/json | Response (JSON) | response |
application/xml | response (XML) |
GET /logger/loggers
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"date" : 12345,
"stringHeaders" : {
"property1" : [ "...", "..." ],
"property2" : [ "...", "..." ]
},
"links" : [ {
"rel" : "...",
"params" : {
"property1" : "...",
"property2" : "..."
},
"rels" : [ "...", "..." ],
"title" : "...",
"uri" : "...",
"type" : "...",
"uriBuilder" : { }
}, {
"rel" : "...",
"params" : {
"property1" : "...",
"property2" : "..."
},
"rels" : [ "...", "..." ],
"title" : "...",
"uri" : "...",
"type" : "...",
"uriBuilder" : { }
} ],
"closed" : true,
"length" : 12345,
"entity" : { },
"allowedMethods" : [ "...", "..." ],
"cookies" : {
"property1" : {
"expiry" : 12345,
"comment" : "...",
"secure" : true,
"httpOnly" : true,
"sameSite" : "STRICT",
"maxAge" : 12345,
"domain" : "...",
"name" : "...",
"version" : 12345,
"path" : "...",
"value" : "..."
},
"property2" : {
"expiry" : 12345,
"comment" : "...",
"secure" : true,
"httpOnly" : true,
"sameSite" : "NONE",
"maxAge" : 12345,
"domain" : "...",
"name" : "...",
"version" : 12345,
"path" : "...",
"value" : "..."
}
},
"metadata" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"lastModified" : 12345,
"statusInfo" : {
"family" : "REDIRECTION",
"reasonPhrase" : "...",
"statusCode" : 12345
},
"location" : "...",
"language" : "...",
"headers" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"entityTag" : {
"weak" : true,
"value" : "..."
},
"mediaType" : {
"wildcardType" : true,
"type" : "...",
"parameters" : {
"property1" : "...",
"property2" : "..."
},
"wildcardSubtype" : true,
"subtype" : "..."
},
"status" : 12345
}
Reload log levels from file. Clears customizations made to logging since the last time the log config file was persisted. example CURL command to reset all custom logging settings: curl -I -u admin:pass -H "Content-Type: application/json" -X POST "http://{host}:{port}/api/logger/reload"
code | condition |
---|---|
204 | No Content - Operation completed successfully |
503 | Service Unavailable - unable to get/retrieve LogLevelAdjustor implementation |
media type | data type | description |
---|---|---|
application/json | Response (JSON) | Http Response, see statusCodes. |
application/xml | response (XML) |
POST /logger/reload
Content-Type: */*
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
{
"date" : 12345,
"stringHeaders" : {
"property1" : [ "...", "..." ],
"property2" : [ "...", "..." ]
},
"links" : [ {
"rel" : "...",
"params" : {
"property1" : "...",
"property2" : "..."
},
"rels" : [ "...", "..." ],
"title" : "...",
"uri" : "...",
"type" : "...",
"uriBuilder" : { }
}, {
"rel" : "...",
"params" : {
"property1" : "...",
"property2" : "..."
},
"rels" : [ "...", "..." ],
"title" : "...",
"uri" : "...",
"type" : "...",
"uriBuilder" : { }
} ],
"closed" : true,
"length" : 12345,
"entity" : { },
"allowedMethods" : [ "...", "..." ],
"cookies" : {
"property1" : {
"expiry" : 12345,
"comment" : "...",
"secure" : true,
"httpOnly" : true,
"sameSite" : "NONE",
"maxAge" : 12345,
"domain" : "...",
"name" : "...",
"version" : 12345,
"path" : "...",
"value" : "..."
},
"property2" : {
"expiry" : 12345,
"comment" : "...",
"secure" : true,
"httpOnly" : true,
"sameSite" : "LAX",
"maxAge" : 12345,
"domain" : "...",
"name" : "...",
"version" : 12345,
"path" : "...",
"value" : "..."
}
},
"metadata" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"lastModified" : 12345,
"statusInfo" : {
"family" : "SUCCESSFUL",
"reasonPhrase" : "...",
"statusCode" : 12345
},
"location" : "...",
"language" : "...",
"headers" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"entityTag" : {
"weak" : true,
"value" : "..."
},
"mediaType" : {
"wildcardType" : true,
"type" : "...",
"parameters" : {
"property1" : "...",
"property2" : "..."
},
"wildcardSubtype" : true,
"subtype" : "..."
},
"status" : 12345
}
Reset all logging level back to factory defaults. Clears customizations made to logging, including persisted changes, and restores the default configuration. example CURL command to reset all custom logging settings: curl -I -u admin:pass -H "Content-Type: application/json" -X POST "http://{host}:{port}/api/logger/reset"
code | condition |
---|---|
204 | No Content - Operation completed successfully |
503 | Service Unavailable - unable to get/retrieve LogLevelAdjustor implementation |
media type | data type | description |
---|---|---|
application/json | Response (JSON) | response |
application/xml | response (XML) |
POST /logger/reset
Content-Type: */*
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
{
"date" : 12345,
"stringHeaders" : {
"property1" : [ "...", "..." ],
"property2" : [ "...", "..." ]
},
"links" : [ {
"rel" : "...",
"params" : {
"property1" : "...",
"property2" : "..."
},
"rels" : [ "...", "..." ],
"title" : "...",
"uri" : "...",
"type" : "...",
"uriBuilder" : { }
}, {
"rel" : "...",
"params" : {
"property1" : "...",
"property2" : "..."
},
"rels" : [ "...", "..." ],
"title" : "...",
"uri" : "...",
"type" : "...",
"uriBuilder" : { }
} ],
"closed" : true,
"length" : 12345,
"entity" : { },
"allowedMethods" : [ "...", "..." ],
"cookies" : {
"property1" : {
"expiry" : 12345,
"comment" : "...",
"secure" : true,
"httpOnly" : true,
"sameSite" : "STRICT",
"maxAge" : 12345,
"domain" : "...",
"name" : "...",
"version" : 12345,
"path" : "...",
"value" : "..."
},
"property2" : {
"expiry" : 12345,
"comment" : "...",
"secure" : true,
"httpOnly" : true,
"sameSite" : "NONE",
"maxAge" : 12345,
"domain" : "...",
"name" : "...",
"version" : 12345,
"path" : "...",
"value" : "..."
}
},
"metadata" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"lastModified" : 12345,
"statusInfo" : {
"family" : "SERVER_ERROR",
"reasonPhrase" : "...",
"statusCode" : 12345
},
"location" : "...",
"language" : "...",
"headers" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"entityTag" : {
"weak" : true,
"value" : "..."
},
"mediaType" : {
"wildcardType" : true,
"type" : "...",
"parameters" : {
"property1" : "...",
"property2" : "..."
},
"wildcardSubtype" : true,
"subtype" : "..."
},
"status" : 12345
}
Save current in-memory logging customizations to the custom configuration file.
code | condition |
---|---|
204 | No Content - Operation completed successfully |
503 | Service Unavailable - unable to get/retrieve LogLevelAdjustor implementation |
media type | data type | description |
---|---|---|
application/json | Response (JSON) | Http Response |
application/xml | response (XML) |
POST /logger/save
Content-Type: */*
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
{
"date" : 12345,
"stringHeaders" : {
"property1" : [ "...", "..." ],
"property2" : [ "...", "..." ]
},
"links" : [ {
"rel" : "...",
"params" : {
"property1" : "...",
"property2" : "..."
},
"rels" : [ "...", "..." ],
"title" : "...",
"uri" : "...",
"type" : "...",
"uriBuilder" : { }
}, {
"rel" : "...",
"params" : {
"property1" : "...",
"property2" : "..."
},
"rels" : [ "...", "..." ],
"title" : "...",
"uri" : "...",
"type" : "...",
"uriBuilder" : { }
} ],
"closed" : true,
"length" : 12345,
"entity" : { },
"allowedMethods" : [ "...", "..." ],
"cookies" : {
"property1" : {
"expiry" : 12345,
"comment" : "...",
"secure" : true,
"httpOnly" : true,
"sameSite" : "LAX",
"maxAge" : 12345,
"domain" : "...",
"name" : "...",
"version" : 12345,
"path" : "...",
"value" : "..."
},
"property2" : {
"expiry" : 12345,
"comment" : "...",
"secure" : true,
"httpOnly" : true,
"sameSite" : "STRICT",
"maxAge" : 12345,
"domain" : "...",
"name" : "...",
"version" : 12345,
"path" : "...",
"value" : "..."
}
},
"metadata" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"lastModified" : 12345,
"statusInfo" : {
"family" : "REDIRECTION",
"reasonPhrase" : "...",
"statusCode" : 12345
},
"location" : "...",
"language" : "...",
"headers" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"entityTag" : {
"weak" : true,
"value" : "..."
},
"mediaType" : {
"wildcardType" : true,
"type" : "...",
"parameters" : {
"property1" : "...",
"property2" : "..."
},
"wildcardSubtype" : true,
"subtype" : "..."
},
"status" : 12345
}
Get logger for name provided example CURL command to get logger: curl -I -u admin:pass -H "Content-Type: application/json" -X GET "http://{host}:{port}/api/logger/com.wandisco"
name | type | description |
---|---|---|
logger | path | the name of the logger to retrieve |
code | condition |
---|---|
200 | Ok |
400 | Bad Request - see Exception |
503 | Service Unavailable - unable to get/retrieve LogLevelAdjustor implementation |
media type | data type | description |
---|---|---|
application/json | Response (JSON) | response |
application/xml | response (XML) |
GET /logger/{logger}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"date" : 12345,
"stringHeaders" : {
"property1" : [ "...", "..." ],
"property2" : [ "...", "..." ]
},
"links" : [ {
"rel" : "...",
"params" : {
"property1" : "...",
"property2" : "..."
},
"rels" : [ "...", "..." ],
"title" : "...",
"uri" : "...",
"type" : "...",
"uriBuilder" : { }
}, {
"rel" : "...",
"params" : {
"property1" : "...",
"property2" : "..."
},
"rels" : [ "...", "..." ],
"title" : "...",
"uri" : "...",
"type" : "...",
"uriBuilder" : { }
} ],
"closed" : true,
"length" : 12345,
"entity" : { },
"allowedMethods" : [ "...", "..." ],
"cookies" : {
"property1" : {
"expiry" : 12345,
"comment" : "...",
"secure" : true,
"httpOnly" : true,
"sameSite" : "LAX",
"maxAge" : 12345,
"domain" : "...",
"name" : "...",
"version" : 12345,
"path" : "...",
"value" : "..."
},
"property2" : {
"expiry" : 12345,
"comment" : "...",
"secure" : true,
"httpOnly" : true,
"sameSite" : "STRICT",
"maxAge" : 12345,
"domain" : "...",
"name" : "...",
"version" : 12345,
"path" : "...",
"value" : "..."
}
},
"metadata" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"lastModified" : 12345,
"statusInfo" : {
"family" : "SUCCESSFUL",
"reasonPhrase" : "...",
"statusCode" : 12345
},
"location" : "...",
"language" : "...",
"headers" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"entityTag" : {
"weak" : true,
"value" : "..."
},
"mediaType" : {
"wildcardType" : true,
"type" : "...",
"parameters" : {
"property1" : "...",
"property2" : "..."
},
"wildcardSubtype" : true,
"subtype" : "..."
},
"status" : 12345
}
Set the global log level example CURL command to update global log level to DEBUG: curl -I -u admin:pass -H "Content-Type: application/json" -X PUT "http://{host}:{port}/api/logger/level/global?level=DEBUG"
name | type | description |
---|---|---|
level | query | String of the level to set e.g. DEBUG |
code | condition |
---|---|
204 | No Content - Operation completed successfully |
400 | Bad Request - see Exception |
503 | Service Unavailable - unable to get/retrieve LogLevelAdjustor implementation |
media type | data type | description |
---|---|---|
application/json | Response (JSON) | response |
application/xml | response (XML) |
PUT /logger/level/global
Content-Type: */*
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
{
"date" : 12345,
"stringHeaders" : {
"property1" : [ "...", "..." ],
"property2" : [ "...", "..." ]
},
"links" : [ {
"rel" : "...",
"params" : {
"property1" : "...",
"property2" : "..."
},
"rels" : [ "...", "..." ],
"title" : "...",
"uri" : "...",
"type" : "...",
"uriBuilder" : { }
}, {
"rel" : "...",
"params" : {
"property1" : "...",
"property2" : "..."
},
"rels" : [ "...", "..." ],
"title" : "...",
"uri" : "...",
"type" : "...",
"uriBuilder" : { }
} ],
"closed" : true,
"length" : 12345,
"entity" : { },
"allowedMethods" : [ "...", "..." ],
"cookies" : {
"property1" : {
"expiry" : 12345,
"comment" : "...",
"secure" : true,
"httpOnly" : true,
"sameSite" : "STRICT",
"maxAge" : 12345,
"domain" : "...",
"name" : "...",
"version" : 12345,
"path" : "...",
"value" : "..."
},
"property2" : {
"expiry" : 12345,
"comment" : "...",
"secure" : true,
"httpOnly" : true,
"sameSite" : "NONE",
"maxAge" : 12345,
"domain" : "...",
"name" : "...",
"version" : 12345,
"path" : "...",
"value" : "..."
}
},
"metadata" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"lastModified" : 12345,
"statusInfo" : {
"family" : "REDIRECTION",
"reasonPhrase" : "...",
"statusCode" : 12345
},
"location" : "...",
"language" : "...",
"headers" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"entityTag" : {
"weak" : true,
"value" : "..."
},
"mediaType" : {
"wildcardType" : true,
"type" : "...",
"parameters" : {
"property1" : "...",
"property2" : "..."
},
"wildcardSubtype" : true,
"subtype" : "..."
},
"status" : 12345
}
Set the package log level example CURL command to update global log level to DEBUG: curl -I -u admin:pass -H "Content-Type: application/json" -X PUT "http://IP:PORT/api/logger/level/package?level=DEBUG&packageToAdjust=com.wandisco"
name | type | description |
---|---|---|
level | query | String of the level to set e.g. DEBUG |
packageToAdjust | query | The name of the package to have the log level adjusted |
code | condition |
---|---|
204 | No Content - Operation completed successfully |
400 | Bad Request - see Exception |
503 | Service Unavailable - unable to get/retrieve LogLevelAdjustor implementation |
media type | data type | description |
---|---|---|
application/json | Response (JSON) | response |
application/xml | response (XML) |
PUT /logger/level/package
Content-Type: */*
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
{
"date" : 12345,
"stringHeaders" : {
"property1" : [ "...", "..." ],
"property2" : [ "...", "..." ]
},
"links" : [ {
"rel" : "...",
"params" : {
"property1" : "...",
"property2" : "..."
},
"rels" : [ "...", "..." ],
"title" : "...",
"uri" : "...",
"type" : "...",
"uriBuilder" : { }
}, {
"rel" : "...",
"params" : {
"property1" : "...",
"property2" : "..."
},
"rels" : [ "...", "..." ],
"title" : "...",
"uri" : "...",
"type" : "...",
"uriBuilder" : { }
} ],
"closed" : true,
"length" : 12345,
"entity" : { },
"allowedMethods" : [ "...", "..." ],
"cookies" : {
"property1" : {
"expiry" : 12345,
"comment" : "...",
"secure" : true,
"httpOnly" : true,
"sameSite" : "STRICT",
"maxAge" : 12345,
"domain" : "...",
"name" : "...",
"version" : 12345,
"path" : "...",
"value" : "..."
},
"property2" : {
"expiry" : 12345,
"comment" : "...",
"secure" : true,
"httpOnly" : true,
"sameSite" : "STRICT",
"maxAge" : 12345,
"domain" : "...",
"name" : "...",
"version" : 12345,
"path" : "...",
"value" : "..."
}
},
"metadata" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"lastModified" : 12345,
"statusInfo" : {
"family" : "REDIRECTION",
"reasonPhrase" : "...",
"statusCode" : 12345
},
"location" : "...",
"language" : "...",
"headers" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"entityTag" : {
"weak" : true,
"value" : "..."
},
"mediaType" : {
"wildcardType" : true,
"type" : "...",
"parameters" : {
"property1" : "...",
"property2" : "..."
},
"wildcardSubtype" : true,
"subtype" : "..."
},
"status" : 12345
}
Reload the log level for a specific package/class. Clear any in-memory customization to the given logger and restore it back to the leve set in the custom configuration file. example CURL command to reset logged named 'com.wandisco': curl -I -u admin:pass -H "Content-Type: application/json" -X POST "http://{host}:{port}/api/logger/reset/logger?logger=com.wandisco"
name | type | description |
---|---|---|
logger | query | Name of logger to reset. |
code | condition |
---|---|
204 | No Content - Operation completed successfully |
503 | Service Unavailable - unable to get/retrieve LogLevelAdjustor implementation |
media type | data type | description |
---|---|---|
application/json | Response (JSON) | response |
application/xml | response (XML) |
POST /logger/reset/logger
Content-Type: */*
Accept: application/json
...
HTTP/1.1 204 No Content
Content-Type: application/json
{
"date" : 12345,
"stringHeaders" : {
"property1" : [ "...", "..." ],
"property2" : [ "...", "..." ]
},
"links" : [ {
"rel" : "...",
"params" : {
"property1" : "...",
"property2" : "..."
},
"rels" : [ "...", "..." ],
"title" : "...",
"uri" : "...",
"type" : "...",
"uriBuilder" : { }
}, {
"rel" : "...",
"params" : {
"property1" : "...",
"property2" : "..."
},
"rels" : [ "...", "..." ],
"title" : "...",
"uri" : "...",
"type" : "...",
"uriBuilder" : { }
} ],
"closed" : true,
"length" : 12345,
"entity" : { },
"allowedMethods" : [ "...", "..." ],
"cookies" : {
"property1" : {
"expiry" : 12345,
"comment" : "...",
"secure" : true,
"httpOnly" : true,
"sameSite" : "LAX",
"maxAge" : 12345,
"domain" : "...",
"name" : "...",
"version" : 12345,
"path" : "...",
"value" : "..."
},
"property2" : {
"expiry" : 12345,
"comment" : "...",
"secure" : true,
"httpOnly" : true,
"sameSite" : "NONE",
"maxAge" : 12345,
"domain" : "...",
"name" : "...",
"version" : 12345,
"path" : "...",
"value" : "..."
}
},
"metadata" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"lastModified" : 12345,
"statusInfo" : {
"family" : "REDIRECTION",
"reasonPhrase" : "...",
"statusCode" : 12345
},
"location" : "...",
"language" : "...",
"headers" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"entityTag" : {
"weak" : true,
"value" : "..."
},
"mediaType" : {
"wildcardType" : true,
"type" : "...",
"parameters" : {
"property1" : "...",
"property2" : "..."
},
"wildcardSubtype" : true,
"subtype" : "..."
},
"status" : 12345
}