add comment about log format

elastic · Dec 10, 2020 · 41dad79 · 41dad79
1 parent a7d5a13
commit 41dad79
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/src/core/server/elasticsearch/client/configure_client.ts b/src/core/server/elasticsearch/client/configure_client.ts
@@ -58,7 +58,16 @@ function getErrorMessage(error: ApiError, event: RequestEvent): string {
   return `[${error.name}]: ${error.message}`;
 }
 
-function getResponseMessage(event: RequestEvent) {
+/**
+ * returns a string in format:
+ *
+ * status code
+ * URL
+ * request body
+ *
+ * so it could be copy-pasted into the Dev console
+ */
+function getResponseMessage(event: RequestEvent): string {
   const params = event.meta.request.params;
 
   // definition is wrong, `params.querystring` can be either a string or an object