Latest revision as of 10:28, 30 July 2014

Mission

Provide specific API interface to end-user which would allow to manipulate with database log files. This feature provides the ability to access log files via Swift so the can download them for Auditing/Troubleshooting purposes.

Description

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).

Justification/Benefits

Justification

Perfomance tuning based on log file analyze.

Database throughput is always limited by the mathimatical equations based upon available resources, after reaching defined limit database starts throwing exceptions that are logged in general log(cassandra system.log, redis server log) or special error log (mysql, percona, maria, etc.).

Database startup Issues resolving based upon error/general log analyz.

Example: Mysql. The error log contains information indicating when mysqld was started and stopped and also any critical errors that occur while the server is running. If mysqld notices a table that needs to be automatically checked or repaired, it writes a message to the error log. Cassandra. Heap size errors based on automated memory allocation while database service launching (http://stackoverflow.com/questions/16243434/getting-outofmemory-in-cassandra-java-heap-space-version-1-0-7-frequently-on-dif).

The minimum requirements set forth in the “general overview and risk assessment” section below must be completed for the audit to qualify for core audit coverage. Following completion of the general overview and risk assessment, the auditor will use professional judgment to select specific areas for additional focus and audit testing.

Benefits

From the user perspective, this feature completely covers real-world use cases mentioned in justification section (management, perfomance tuning, audit, etc.)

Impacts

This feature would not affect/break current Trove API. It changes the attitute to the actual Trove instance from the simple database server with connection URL to something bigger. It affects in-accessability of the instance, that is restricted by the terms of use of the public/private cloud and affects the PaaS term.

Database

Database changes are not required because database logs are not tracked at the Trove backend as a resource that can be re-used in future.

Configuration

None

Public API

New routes are presented. Description mentioned below.

Public API Details

Two new resources, log-create, log-show will be exposed as part of the Trove API.

The log-show is used to provide an ability to list all available(availability defined by applied configuration group) database logging filenames per instance.

The log-create is used to provide an ability to save database logging file into the Swift container, required attribute - instance.

To implement this capability, the create/modify/list instance operations will be extended in a manner that does not break the existing 1.0 contract. These operations will permit a user to create a new database logging file entry for already existed instance, list all available database logging filenames for all registered datstore versions (basically, for all datastore managers across all versions), show all available database logging filenames per certain datastore version (manager).

log-show

Get the list of all available database logging files per given instance. HTTP method GET

Route: /{tenant_id}/instances/{id}/logs

Response

   {
       "instance": {
                          {
                             "log_files": [
                                                    {
                                                        "type": "general_log", 
                                                        "path": "/var/log/mysql/general.log"
                                                    },
                                                    {
                                                        "type": "log_slow_queries", 
                                                        "path": "/var/log/mysql/slow.log"
                                                    },
                                                    {
                                                        "type": "bin_log", 
                                                        "path": "/var/log/mysql/bin.log"
                                                    },
                                                    {
                                                        "type": "error_log", 
                                                        "path": "/var/log/mysql/error.log"
                                                    },
                             ],
                          }
       }
   }

Configuration groups

Logging can be turned on/ff by the configuration group through Configurations API and only.

HTTP code responses

HTTP 200 Accepted. Logging was enabled by the configuration group.

HTTP 404 NotFound. Logging is not enabled by applied configuration group.

log-create

Create and save database logging file entry. HTTP method POST

Route: /{tenant_id}/instance/{id}/logs

Request

   {
       "instance": {
         "log" : "general_log",
       }
   }

Response

   {
       "log": {
         "instance_id" : "12345678-1111-2222-3333-444444444444",
         "file" : "mysql.log",
         "locationURL" : "http://somewhere.com:PORT/dblogcontainer/{instance_id}/filename.timestamp",
         "created_at": POSIX Timestamp,
         "modified_at": POSIX Timestamp,
       }
   }

create_at and modified_at describes the time of log creation and the time last modification.

HTTP code responses

HTTP 201 Created. Log was shipped to Storage

HTTP 403 Forbidden. Storage is not available.

HTTP 404 NotFound. Instance is missing.

HTTP 400 BadRequest. Instance is not ACTIVE, can't execute procedure.

Internal API

Message: log_create Type: call Parameters: log_file_path

Guest Agent

Added new method and flow agent for saving the log files directly to Swift container

naming convention: dblogcontainer/{instance_id}/filename.timestamp
Storage container file extension: *.log, *.tar.gz
Storage Strategy: Swift
Container: dblogcontainer

@@ Line 1: / Line 1: @@
 = Mission =
-Provide specific API interface to end-user which would allow to manipulate with database log files. This feature provides  the ability to access log files via Swift so the can download them for Auditing/Troubleshooting purposes.
+:Provide specific API interface to end-user which would allow to manipulate with database log files. This feature provides  the ability to access log files via Swift so the can download them for Auditing/Troubleshooting purposes.
-= Why does Trove needs it ?=
-== Short BIO. Audit.==
-:Auditing is a core component to compliance and security programs, and a generally accepted practice by IT operations. Relational databases were the first enterprise application to embed auditing as a native platform feature. Yet part of this heritage is the stigma associated with auditing. Vendors provided the basic function, they failed to provide the performance and ease of management demanded by database administrators (DBAs), who remain loathe to enable the feature, and remain one of the last holdouts for accepting the use of database audit trails.
-:The reasons for their distaste of native audit are fully justified: from performance and data management nightmares, to the fact that these audit trails were not originally designed for the tasks they are being applied to. Regardless, regulatory compliance demands accurate and complete records of transactions, and relational database audit trails produce just that.
-:Security and compliance drive the use of database auditing, and these log files provide a unique perspective that needs to be captured. Database vendors are building better auditing features into their products, minimizing historic impediments, but careful deployment is required to avoid these known issues.
 = Description =
@@ Line 20: / Line 12: @@
 === Perfomance tuning based on log file analyze. ===
 :Database throughput is always limited by the mathimatical equations based upon available resources, after reaching defined limit database starts throwing exceptions that are logged in general log(cassandra system.log, redis server log) or special error log (mysql, percona, maria, etc.).
-=== Database audit. ===
-:Auditing is a core component to compliance and security programs, and a generally accepted practice by IT operations. Relational databases were the first enterprise application to embed auditing as a native platform feature. Yet part of this heritage is the stigma associated with auditing. Vendors provided the basic function, they failed to provide the performance and ease of management demanded by database administrators (DBAs), who remain loathe to enable the feature, and remain one of the last holdouts for accepting the use of database audit trails.Database auditing is the examination of audit or transaction logs for the purpose of tracking changes with data or database structure. Databases can be set to capture alterations to data and metadata.
-:Database Management will be audited approximately once every three years using a risk-based approach. Databases to be reviewed include those databases supporting mission critical university functions.  The following topics should be addressed during the review:
-:* Database Administration (policies and procedures, capacity planning)
-:* Database Maintenance and Tuning (operational effectiveness)
-:* Database Integrity (referential integrity, triggers)
-:* Database Security (database security settings, auditing/logging)
-:* Database Backup and Recovery (availability)
 === Database startup Issues resolving based upon error/general log analyz. ===
@@ Line 37: / Line 19: @@
 == Benefits ==
-:From the user perspective, this feature completely covers real-worl use cases mentioned in justification section (management, perfomance tuning, audit, etc.)
+:From the user perspective, this feature completely covers real-world use cases mentioned in justification section (management, perfomance tuning, audit, etc.)
 = Impacts =
-:Thi feature would not affect/break current Trove API. It changes the attitute to the actual Trove instance from the ''simple database server with connection URL'' to something bigger. It affects in-accessability of the instance, that is restricted by the terms of use of the public/private cloud and affects the PaaS term.
+:This feature would not affect/break current Trove API. It changes the attitute to the actual Trove instance from the ''simple database server with connection URL'' to something bigger. It affects in-accessability of the instance, that is restricted by the terms of use of the public/private cloud and affects the PaaS term.
 == Database ==
@@ Line 51: / Line 33: @@
 === Public API Details ===
-:Three new resources, ''log-create'', ''log-show'' will be exposed as part of the Trove API.
+:Two new resources, ''log-create'', ''log-show'' will be exposed as part of the Trove API.
-:The ''log-show'' is used to provide an ability to list all available(availability defined by Trove) database logging filenames per instance.
+:The ''log-show'' is used to provide an ability to list all available(availability defined by applied configuration group) database logging filenames per instance.
 :The ''log-create'' is used to provide an ability to save database logging file into the Swift container, required attribute - instance.
@@ Line 60: / Line 42: @@
 :To implement this capability, the create/modify/list instance operations will be extended in a manner that does not break the existing 1.0 contract.  These operations will permit a user to create a new database logging file entry for already existed instance, list all available database logging filenames for all registered datstore versions (basically, for all datastore managers across all versions), show all available database logging filenames per certain datastore version (manager).
-=== API Calls ===
+== log-show ==
-<br />
+=== Get the list of all available database logging files per given instance. HTTP method GET ===
-==== Get the list of all available database logging files per given datastore version. HTTP method GET====
 '''''Route''''':
@@ Line 72: / Line 53: @@
                             {
                                "log_files": [
-                                                      "general_log", "log_slow_queries", "log_error"
+                                                      {
+                                                         "type": "general_log",
+                                                         "path": "/var/log/mysql/general.log"
+                                                     },
+                                                     {
+                                                         "type": "log_slow_queries",
+                                                         "path": "/var/log/mysql/slow.log"
+                                                     },
+                                                     {
+                                                         "type": "bin_log",
+                                                         "path": "/var/log/mysql/bin.log"
+                                                     },
+                                                     {
+                                                         "type": "error_log",
+                                                         "path": "/var/log/mysql/error.log"
+                                                     },
                                ],
                             }
@@ Line 78: / Line 74: @@
      }
-==== How does it works ====
+== Configuration groups ==
+Logging can be turned on/ff by the configuration group through Configurations API and only.
-Trove will have datastore-spicif (mysql, cassandra, etc.) list that contain all possible log file entities that which can be (possible) exist at given instance defined by datastore.
-List looks like:
-        "mapping": [
+=== HTTP code responses ===
-            'general_log', 'log_slow_queries',  'log_error', 'bin_log'
+HTTP 200 Accepted. Logging was enabled by the configuration group.
-        ]
-: If assigned configuration groups has any ony them, user will see them in the response body. If assigned configuration group has none of log configuration attributes user will receive empty list.
+HTTP 404 NotFound. Logging is not enabled by applied configuration group.
+<br/>
-Steps:
+== log-create ==
-# Look over assigned configuration for log configuration mentioned in datastore-specific mapping
+=== Create and save database logging file entry. HTTP method POST===
-# Return every logs enabled by the assigned configuration
-==== Create and save database logging file entry. HTTP method POST====
 '''''Route:'''''
@@ Line 102: / Line 93: @@
      {
          "instance": {
-           "filename" : "general_log",
+           "log" : "general_log",
          }
      }
@@ Line 119: / Line 110: @@
      }
-==== How does it works ====
+create_at and modified_at describes the time of log creation and the time last modification.
+=== HTTP code responses ===
+HTTP 201 Created. Log was shipped to Storage
+HTTP 403 Forbidden. Storage is not available.
+HTTP 404 NotFound. Instance is missing.
-When filename will be sent to a API service Trove will validate if the given log file is the part of the configuration group assigned to instance, if it is, API service will pick actual file system path to log file and will send request to guestagent through taskmanager.
+HTTP 400 BadRequest. Instance is not ACTIVE, can't execute procedure.
-Steps:
-# Check if log is a part of the configuration group assigned to instance;
-# Pick the FS path to log
-# Send appropriate request to taskmanager -> guestagent
-# Wait until response will occure
 == Internal API ==
-All required API will be covered
+Message: log_create
+Type: call
+Parameters: log_file_path
 == Guest Agent==

Difference between revisions of "Trove/DBInstanceLogOperationV1"

Latest revision as of 10:28, 30 July 2014

Contents

Mission

Description

Justification/Benefits

Justification

Perfomance tuning based on log file analyze.

Database startup Issues resolving based upon error/general log analyz.

Benefits

Impacts

Database

Configuration

Public API

Public API Details

log-show

Get the list of all available database logging files per given instance. HTTP method GET

Configuration groups

HTTP code responses

log-create

Create and save database logging file entry. HTTP method POST

HTTP code responses

Internal API

Guest Agent