Difference between revisions of "Trove/DBInstanceLogOperationV1"
< Trove
(→DBLog Database Model) |
(→Request Parameters:) |
||
| Line 14: | Line 14: | ||
=== Request Parameters: === | === Request Parameters: === | ||
: | : | ||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! Header text !! Header text !! Header text !! Header text | ||
| + | |- | ||
| + | | Example || Example || Example || Example | ||
| + | |- | ||
| + | | Example || Example || Example || Example | ||
| + | |- | ||
| + | | Example || Example || Example || Example | ||
| + | |} | ||
:*Instance ID or Name | :*Instance ID or Name | ||
: | : | ||
Revision as of 12:04, 18 December 2013
Contents
Mission
Provide specific API interface to end-user which would allow to manipulate with database log files.
Design
Log manipulations are designed to let user perform log investigations. Since Trove is PaaS - level project, it's user cannot interact with compute instance directly, only with database through given API (database operations).
API Schema
DownloadDBLogFile request parameters and DBLog Model
-
- Description: Downloads current database log file.
Request Parameters:
| Header text | Header text | Header text | Header text |
|---|---|---|---|
| Example | Example | Example | Example |
| Example | Example | Example | Example |
| Example | Example | Example | Example |
- Instance ID or Name
-
- The customer-assigned name of the DB instance that contains the log files you want to list.
- Constraints:
- Must contain from 1 to 63 alphanumeric characters or hyphens or UUID
- Type: String
- Required: Yes
- LogFileName
-
- The name of the log file to be downloaded.
- Type: String
- Required: Yes
- Marker
-
- The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords (defined via Trove conf).
- Type: String
- Required: No
Response Elements
- The following elements are returned in a structure named DBLog.
- LogFileData
- Log file entry.
- Type: String
- Errors
- DBInstanceNotFound
- DBInstanceIdentifier does not refer to an existing DB instance.
- HTTP Status Code: 404
DBLog Database Model
- ID
- UUID
- Type: String
- DBInstanceID
- UUID of DBInstance.
- Type: String
- Location
- URL. Storage location
- Type: String
- CreateAt
- A POSIX timestamp when the last log entry was created.
- Type: String
- LogFileName
- The name of the log file for the specified DB instance.
- Type: String
- DeletedAt:
- A POSIX timestamp when the log entry was deleted.
- Type: String
- Deleted:
- If record deleted then True
- Type: Boolean
Server-side configuration
- Trove taskmanager and api services would require next conf values:
- log_file_storage_dir per datastore (could be retrieved from database configuration at guest side).
- pagination limit.
Guest-side configuration
- Same as server side, guest side requires several configuration values:
- naming convention: uuid+daytime.log
- manifest convention: *.log or *tar.bz2 or *tar.gz
- Storage Strategy: Swift
- Container: logs_files
