Improvement #7652 - Make the profiler store aggregated requests by default, with option for detailed store.

Author: asfernandes

doc/sql.extensions/README.profiler.md

@@ -57,7 +57,7 @@ set term ;!
 
 -- Start profiling
 
-select rdb$profiler.start_session('Profile Session 1') from rdb$database;
+select rdb$profiler.start_session('Profile Session 1', null, null, null, 'DETAILED_REQUESTS') from rdb$database;
 
 set term !;
 
@@ -126,16 +126,20 @@ select pstat.*
 
 `RDB$PROFILER.START_SESSION` starts a new profiler session, makes it the current session (of the given `ATTACHMENT_ID`) and returns its identifier.
 
-If `FLUSH_INTERVAL` is different from `NULL`, auto-flush is setup in the same way as manually calling `RDB$PROFILER.SET_FLUSH_INTERVAL`.
+If `FLUSH_INTERVAL` is different than `NULL`, auto-flush is setup in the same way as manually calling `RDB$PROFILER.SET_FLUSH_INTERVAL`.
 
 If `PLUGIN_NAME` is `NULL` (the default), it uses the database configuration `DefaultProfilerPlugin`.
 
-`PLUGIN_OPTIONS` are plugin specific options and currently should be `NULL` for `Default_Profiler` plugin.
+`PLUGIN_OPTIONS` are plugin specific options and currently could be `NULL` or the string `DETAILED_REQUESTS` for `Default_Profiler` plugin.
+
+When `DETAILED_REQUESTS` is used, `PLG$PROF_REQUESTS` will store detailed requests data, i.e., one record per each invocation of a statement. This may generate a lot of records, causing `RDB$PROFILER.FLUSH` to be slow.
+
+When `DETAILED_REQUESTS` is not used (the default), `PLG$PROF_REQUESTS` stores an aggregated record per statement, using `REQUEST_ID = 0`.
 
 Input parameters:
  - `DESCRIPTION` type `VARCHAR(255) CHARACTER SET UTF8` default `NULL`
  - `FLUSH_INTERVAL` type `INTEGER` default `NULL`
- - `ATTACHMENT_ID` type `BIGINT NOT NULL` default `CURRENT_CONNECTION`
+ - `ATTACHMENT_ID` type `BIGINT` default `NULL` (meaning `CURRENT_CONNECTION`)
  - `PLUGIN_NAME` type `VARCHAR(255) CHARACTER SET UTF8` default `NULL`
  - `PLUGIN_OPTIONS` type `VARCHAR(255) CHARACTER SET UTF8` default `NULL`
 
@@ -151,14 +155,14 @@ Calling `RDB$PROFILER.PAUSE_SESSION(TRUE)` has the same semantics of calling `RD
 
 Input parameters:
  - `FLUSH` type `BOOLEAN NOT NULL` default `FALSE`
- - `ATTACHMENT_ID` type `BIGINT NOT NULL` default `CURRENT_CONNECTION`
+ - `ATTACHMENT_ID` type `BIGINT` default `NULL` (meaning `CURRENT_CONNECTION`)
 
 ## Procedure `RESUME_SESSION`
 
 `RDB$PROFILER.RESUME_SESSION` resumes the current profiler session (of the given `ATTACHMENT_ID`), if it was paused, so the next executed statements statistics are collected again.
 
 Input parameters:
- - `ATTACHMENT_ID` type `BIGINT NOT NULL` default `CURRENT_CONNECTION`
+ - `ATTACHMENT_ID` type `BIGINT` default `NULL` (meaning `CURRENT_CONNECTION`)
 
 ## Procedure `FINISH_SESSION`
 
@@ -170,7 +174,7 @@ Calling `RDB$PROFILER.FINISH_SESSION(TRUE)` has the same semantics of calling `R
 
 Input parameters:
  - `FLUSH` type `BOOLEAN NOT NULL` default `TRUE`
- - `ATTACHMENT_ID` type `BIGINT NOT NULL` default `CURRENT_CONNECTION`
+ - `ATTACHMENT_ID` type `BIGINT` default `NULL` (meaning `CURRENT_CONNECTION`)
 
 ## Procedure `CANCEL_SESSION`
 
@@ -181,7 +185,7 @@ All session data present in the profiler plugin is discarded and will not be flu
 Data already flushed is not deleted automatically.
 
 Input parameters:
- - `ATTACHMENT_ID` type `BIGINT NOT NULL` default `CURRENT_CONNECTION`
+ - `ATTACHMENT_ID` type `BIGINT` default `NULL` (meaning `CURRENT_CONNECTION`)
 
 ## Procedure `DISCARD`
 
@@ -190,7 +194,7 @@ Input parameters:
 If there is a active session, it is cancelled.
 
 Input parameters:
- - `ATTACHMENT_ID` type `BIGINT NOT NULL` default `CURRENT_CONNECTION`
+ - `ATTACHMENT_ID` type `BIGINT` default `NULL` (meaning `CURRENT_CONNECTION`)
 
 ## Procedure `FLUSH`
 
@@ -203,7 +207,7 @@ Data is updated using an autonomous transaction, so if the procedure is called i
 Once flush happens, finished sessions are removed from memory.
 
 Input parameters:
- - `ATTACHMENT_ID` type `BIGINT NOT NULL` default `CURRENT_CONNECTION`
+ - `ATTACHMENT_ID` type `BIGINT` default `NULL` (meaning `CURRENT_CONNECTION`)
 
 ## Procedure `SET_FLUSH_INTERVAL`
 
@@ -213,7 +217,7 @@ Input parameters:
 
 Input parameters:
  - `FLUSH_INTERVAL` type `INTEGER NOT NULL`
- - `ATTACHMENT_ID` type `BIGINT NOT NULL` default `CURRENT_CONNECTION`
+ - `ATTACHMENT_ID` type `BIGINT` default `NULL` (meaning `CURRENT_CONNECTION`)
 
 # Snapshot tables
 
@@ -267,34 +271,35 @@ Below is the list of tables that stores profile data.
 ## Table `PLG$PROF_REQUESTS`
 
  - `PROFILE_ID` type `BIGINT` - Profile session ID
- - `REQUEST_ID` type `BIGINT` - Request ID
  - `STATEMENT_ID` type `BIGINT` - Statement ID
+ - `REQUEST_ID` type `BIGINT` - Request ID
+ - `CALLER_STATEMENT_ID` type `BIGINT` - Caller statement ID
  - `CALLER_REQUEST_ID` type `BIGINT` - Caller request ID
  - `START_TIMESTAMP` type `TIMESTAMP WITH TIME ZONE` - Moment this request was first gathered profile data
  - `FINISH_TIMESTAMP` type `TIMESTAMP WITH TIME ZONE` - Moment this request was finished
  - `TOTAL_ELAPSED_TIME` type `BIGINT` - Accumulated elapsed time (in nanoseconds) of the request
- - Primary key: `PROFILE_ID, REQUEST_ID`
+ - Primary key: `PROFILE_ID, STATEMENT_ID, REQUEST_ID`
 
 ## Table `PLG$PROF_PSQL_STATS`
 
  - `PROFILE_ID` type `BIGINT` - Profile session ID
+ - `STATEMENT_ID` type `BIGINT` - Statement ID
  - `REQUEST_ID` type `BIGINT` - Request ID
  - `LINE_NUM` type `INTEGER` - Line number of the statement
  - `COLUMN_NUM` type `INTEGER` - Column number of the statement
- - `STATEMENT_ID` type `BIGINT` - Statement ID
  - `COUNTER` type `BIGINT` - Number of executed times of the line/column
  - `MIN_ELAPSED_TIME` type `BIGINT` - Minimal elapsed time (in nanoseconds) of a line/column execution
  - `MAX_ELAPSED_TIME` type `BIGINT` - Maximum elapsed time (in nanoseconds) of a line/column execution
  - `TOTAL_ELAPSED_TIME` type `BIGINT` - Accumulated elapsed time (in nanoseconds) of the line/column executions
- - Primary key: `PROFILE_ID, REQUEST_ID, LINE_NUM, COLUMN_NUM`
+ - Primary key: `PROFILE_ID, STATEMENT_ID, REQUEST_ID, LINE_NUM, COLUMN_NUM`
 
 ## Table `PLG$PROF_RECORD_SOURCE_STATS`
 
  - `PROFILE_ID` type `BIGINT` - Profile session ID
+ - `STATEMENT_ID` type `BIGINT` - Statement ID
  - `REQUEST_ID` type `BIGINT` - Request ID
  - `CURSOR_ID` type `INTEGER` - Cursor ID
  - `RECORD_SOURCE_ID` type `INTEGER` - Record source ID
- - `STATEMENT_ID` type `BIGINT` - Statement ID
  - `OPEN_COUNTER` type `BIGINT` - Number of open times of the record source
  - `OPEN_MIN_ELAPSED_TIME` type `BIGINT` - Minimal elapsed time (in nanoseconds) of a record source open
  - `OPEN_MAX_ELAPSED_TIME` type `BIGINT` - Maximum elapsed time (in nanoseconds) of a record source open
@@ -303,7 +308,7 @@ Below is the list of tables that stores profile data.
  - `FETCH_MIN_ELAPSED_TIME` type `BIGINT` - Minimal elapsed time (in nanoseconds) of a record source fetch
  - `FETCH_MAX_ELAPSED_TIME` type `BIGINT` - Maximum elapsed time (in nanoseconds) of a record source fetch
  - `FETCH_TOTAL_ELAPSED_TIME` type `BIGINT` - Accumulated elapsed time (in nanoseconds) of the record source fetches
- - Primary key: `PROFILE_ID, REQUEST_ID, CURSOR_ID, RECORD_SOURCE_ID`
+ - Primary key: `PROFILE_ID, STATEMENT_ID, REQUEST_ID, CURSOR_ID, RECORD_SOURCE_ID`
 
 # Auxiliary views
 

src/include/firebird/FirebirdInterface.idl

@@ -1746,19 +1746,22 @@ interface ProfilerSession : Disposable
 	void defineRecordSource(int64 statementId, uint cursorId, uint recSourceId,
 		const string accessPath, uint parentRecSourceId);
 
-	void onRequestStart(Status status, int64 requestId, int64 statementId, int64 callerRequestId,
-		ISC_TIMESTAMP_TZ timestamp);
+	void onRequestStart(Status status, int64 statementId, int64 requestId,
+		int64 callerStatementId, int64 callerRequestId, ISC_TIMESTAMP_TZ timestamp);
 
-	void onRequestFinish(Status status, int64 requestId, ISC_TIMESTAMP_TZ timestamp, ProfilerStats stats);
+	void onRequestFinish(Status status, int64 statementId, int64 requestId,
+		ISC_TIMESTAMP_TZ timestamp, ProfilerStats stats);
 
-	void beforePsqlLineColumn(int64 requestId, uint line, uint column);
-	void afterPsqlLineColumn(int64 requestId, uint line, uint column, ProfilerStats stats);
+	void beforePsqlLineColumn(int64 statementId, int64 requestId, uint line, uint column);
+	void afterPsqlLineColumn(int64 statementId, int64 requestId, uint line, uint column, ProfilerStats stats);
 
-	void beforeRecordSourceOpen(int64 requestId, uint cursorId, uint recSourceId);
-	void afterRecordSourceOpen(int64 requestId, uint cursorId, uint recSourceId, ProfilerStats stats);
+	void beforeRecordSourceOpen(int64 statementId, int64 requestId, uint cursorId, uint recSourceId);
+	void afterRecordSourceOpen(int64 statementId, int64 requestId, uint cursorId, uint recSourceId,
+		ProfilerStats stats);
 
-	void beforeRecordSourceGetRecord(int64 requestId, uint cursorId, uint recSourceId);
-	void afterRecordSourceGetRecord(int64 requestId, uint cursorId, uint recSourceId, ProfilerStats stats);
+	void beforeRecordSourceGetRecord(int64 statementId, int64 requestId, uint cursorId, uint recSourceId);
+	void afterRecordSourceGetRecord(int64 statementId, int64 requestId, uint cursorId, uint recSourceId,
+		ProfilerStats stats);
 }
 
 interface ProfilerStats : Versioned