PMM-4192 MongoDB EXPLAIN JSON APIs. (#420)

* PMM-4192 WIP - Initial proto changes

* PMM-4192 Updated proto def for mongo explain

* PBM-4192 Updated MongoDBExplainParams definition

* PMM-4192 Removed database from mongodbexplain

* PMM-4192 Regenerate.

* PMM-4192 Fixed comments

Fixed comments referencing PostgreSQL instead of MongoDB

* PMM-4192 Merged current 2.0 branch

* Revert "PMM-4192 Merged current 2.0 branch"

This reverts commit b7d0361.

* PMM-4192 after make gen

* PMM-4192 Updated MongoExplain path

* PMM-4192 Removed Database from MDB explain

In MongoDB Explain action, the database to run the command should be
"admin" and the query database is taken from the JSON query in the Ns
field (namespace).
Keeping this parameter here and using it makes explain to fail in
pmm-agent.

Co-authored-by: Alexey Palazhchenko <[email protected]>
Co-authored-by: Nurlan Moldomurov <[email protected]>

api/agentpb/agent.proto

@@ -112,6 +112,11 @@ message StartActionRequest {
     string dsn = 1;
     string table = 2;
   }
+  // MongoDBExplainParams describes MongoDB EXPLAIN action parameters.
+  message MongoDBExplainParams {
+    string dsn = 1;
+    string query = 2;
+  }
   string action_id = 1;
   oneof params {
     MySQLExplainParams mysql_explain_params = 2;
@@ -120,6 +125,7 @@ message StartActionRequest {
     MySQLShowIndexParams mysql_show_index_params = 5;
     PostgreSQLShowCreateTableParams postgresql_show_create_table_params = 6;
     PostgreSQLShowIndexParams postgresql_show_index_params = 7;
+    MongoDBExplainParams mongodb_explain_params = 8;
   }
 }
 

api/managementpb/actions.proto

@@ -17,6 +17,7 @@ enum ActionType {
   MYSQL_SHOW_INDEX = 4;
   POSTGRESQL_SHOW_CREATE_TABLE = 5;
   POSTGRESQL_SHOW_INDEX = 6;
+  MONGODB_EXPLAIN = 7;
 }
 
 message GetActionRequest {
@@ -249,6 +250,30 @@ message StartPostgreSQLShowIndexActionResponse {
   string pmm_agent_id = 2;
 }
 
+message StartMongoDBExplainActionRequest {
+  // pmm-agent ID where to run this Action.
+  string pmm_agent_id = 1;
+  // Service ID for this Action. Required.
+  string service_id = 2 [
+    (validator.field) = {
+      string_not_empty: true
+    }
+  ];
+  // Query. Required.
+  string query = 3 [
+    (validator.field) = {
+      string_not_empty: true
+    }
+  ];
+}
+
+message StartMongoDBExplainActionResponse {
+  // Unique Action ID.
+  string action_id = 1;
+  // pmm-agent ID where to this Action was started.
+  string pmm_agent_id = 2;
+}
+
 message CancelActionRequest {
   // Unique Action ID. Required.
   string action_id = 1 [
@@ -325,6 +350,13 @@ service Actions {
       body: "*"
     };
   }
+  // StartMongoDBExplainAction starts MongoDB EXPLAIN Action.
+  rpc StartMongoDBExplainAction(StartMongoDBExplainActionRequest) returns (StartMongoDBExplainActionResponse) {
+    option (google.api.http) = {
+      post: "/v1/management/Actions/StartMongoDBExplain"
+      body: "*"
+    };
+  }
   // CancelAction stops an Action.
   rpc CancelAction(CancelActionRequest) returns (CancelActionResponse) {
     option (google.api.http) = {