feat #1333: Enable downloading support archives from the configurati… (#1487)

* feat #1333:  Enable downloading support archives from the configuration UI

* apply inspectIT Ocelot code formatting

* change icon for downloading support archive

* resolved review notes

* minor comment/message refactoring

* AgentService checks if LogPreloading is enabled before trying to get the result

* fix(code-quality): add accidentally deleted saveactions_settings.xml (#1333)

Co-authored-by: Simon Braitsch <simon.braitsch@novatec-gmbh.de>
Co-authored-by: Heiko Holz <heiko.holz@novatec-gmbh.de>
Co-authored-by: Priebe Daniel <dpr@novatec-gmbh.de>

Author: 4 people

components/inspectit-ocelot-configurationserver-ui/src/components/views/dialogs/DownloadDialogue.js

@@ -21,6 +21,19 @@ const DownloadDialogue = ({ visible, onHide, error, loading, contentValue, conte
     return window.URL.createObjectURL(blob);
   };
 
+  const renderError = (errorType) => {
+    switch (errorType) {
+      case 'log':
+        return `${dialogueSettings.header} could not be loaded due to an unexpected error.\n
+                Ensure that both agent-commands and log-preloading are enabled and the agent-commands URL is correct in your agent
+                configuration.`;
+      case 'archive':
+        return `Downloading the Support Archive for ${contextName} failed. Make sure agent-commands are enabled and the agent-commands URL is correct in your agent configuration.`;
+      default:
+        return `${dialogueSettings.header} could not be loaded due to an unexpected error.`;
+    }
+  };
+
   return (
     <>
       <Dialog
@@ -41,16 +54,7 @@ const DownloadDialogue = ({ visible, onHide, error, loading, contentValue, conte
         {loading ? (
           <ProgressBar mode="indeterminate" />
         ) : error ? (
-          <div>
-            {dialogueSettings.header} could not be loaded due to an unexpected error.
-            {contentType === 'log' ? (
-              <span>
-                <br />
-                Ensure that both agent-commands and log-preloading are enabled and the agent-commands URL is correct in your agent
-                configuration.
-              </span>
-            ) : null}
-          </div>
+          renderError(contentType)
         ) : (
           <SyntaxHighlighter
             customStyle={{ maxHeight: '50vh' }}

components/inspectit-ocelot-configurationserver-ui/src/components/views/mappings/ContentTypeMapper.js

@@ -1,6 +1,6 @@
 /**
  * mapping function that returns all values needed to setup the download of a file for a given content-type
- * explicitly mapped contentTypes are 'config' and 'log', everything else will default to a plain .txt configuration
+ * explicitly mapped contentTypes are 'config', 'log' and 'archive', everything else will default to a plain .txt configuration
  * @param contentType
  * @param contextName
  * @returns {{fileExtension: string, header: string, language: string, mimeType: string}}
@@ -22,6 +22,13 @@ export const ContentTypeMapper = (contentType, contextName) => {
         mimeType: 'text/plain',
         header: 'Logs of ' + contextName,
       };
+    case 'archive':
+      return {
+        language: '',
+        fileExtension: '',
+        mimeType: '',
+        header: 'Preparing Download of the Support Archive for ' + contextName,
+      };
     default:
       return {
         language: 'plaintext',

components/inspectit-ocelot-configurationserver-ui/src/components/views/status/StatusTable.js

@@ -6,8 +6,8 @@ import dateformat from 'dateformat';
 import TimeAgo from 'react-timeago';
 import { map } from 'lodash';
 import classnames from 'classnames';
-import { linkPrefix } from '../../../lib/configuration';
 import classNames from 'classnames';
+import { linkPrefix } from '../../../lib/configuration';
 
 const timeFormatter = (time, unit, suffix) => {
   if (unit === 'second') {
@@ -53,18 +53,22 @@ class AgentMappingCell extends React.Component {
             display: flex;
             align-items: stretch;
           }
+
           .mapping-name {
             flex: 1;
             margin-right: 0.5rem;
           }
+
           .no-mapping {
             color: gray;
             font-style: italic;
           }
+
           .show-attributes {
             float: right;
             cursor: pointer;
           }
+
           .attributes {
             margin-top: 0.5rem;
             border-left: 0.25rem solid #ddd;
@@ -133,6 +137,7 @@ class StatusTable extends React.Component {
           .this {
             position: relative;
           }
+
           .this :global(.config-info-button) {
             width: 1.2rem;
             height: 1.2rem;
@@ -142,6 +147,7 @@ class StatusTable extends React.Component {
             background: #ddd;
             border-color: #ddd;
           }
+
           .this :global(.log-button) {
             width: 1.2rem;
             height: 1.2rem;
@@ -151,6 +157,7 @@ class StatusTable extends React.Component {
             background: #ddd;
             border-color: #ddd;
           }
+
           .this :global(.badge) {
             width: 1.2rem;
             height: 1.2rem;
@@ -216,7 +223,8 @@ class StatusTable extends React.Component {
   };
 
   agentHealthTemplate = (rowData) => {
-    const { health } = rowData;
+    const { onShowDownloadDialog } = this.props;
+    const { health, metaInformation } = rowData;
 
     let healthInfo;
     let iconClass;
@@ -244,12 +252,30 @@ class StatusTable extends React.Component {
           .state {
             align-items: center;
             display: flex;
+            position: relative;
+          }
+
+          .state :global(.archive-button) {
+            width: 1.2rem;
+            height: 1.2rem;
+            position: absolute;
+            right: 0;
+            top: 0;
+            background: #ddd;
+            border-color: #ddd;
           }
         `}</style>
         {health ? (
           <div className="state">
             <i className={classNames('pi pi-fw', iconClass)} style={{ color: iconColor }}></i>
             <span>{healthInfo}</span>
+            <Button
+              className="archive-button"
+              icon="pi pi-cloud-download"
+              onClick={() => onShowDownloadDialog(metaInformation.agentId, metaInformation.agentVersion, 'archive')}
+              tooltip="Download Support Archive"
+              tooltipOptions={{ showDelay: 500 }}
+            />
           </div>
         ) : (
           '-'
@@ -305,12 +331,15 @@ class StatusTable extends React.Component {
             display: flex;
             align-items: center;
           }
+
           .pi {
             margin-right: 0.5rem;
           }
+
           .pi.live {
             color: #ef5350;
           }
+
           .pi.workspace {
             color: #616161;
           }

components/inspectit-ocelot-configurationserver-ui/src/components/views/status/StatusView.js

@@ -5,8 +5,9 @@ import StatusTable from './StatusTable';
 import StatusToolbar from './StatusToolbar';
 import StatusFooterToolbar from './StatusFooterToolbar';
 import axios from '../../../lib/axios-api';
-import { map, isEqual } from 'lodash';
+import { isEqual, map } from 'lodash';
 import DownloadDialogue from '../dialogs/DownloadDialogue';
+import { downloadArchiveFromJson } from '../../../functions/export-selection.function';
 
 /**
  * The view presenting a list of connected agents, their mapping and when they last connected to the server.
@@ -290,6 +291,9 @@ class StatusView extends React.Component {
           case 'log':
             this.fetchLog(agentId);
             break;
+          case 'archive':
+            this.downloadSupportArchive(agentId, attributes);
+            break;
           default:
             this.setDownloadDialogShown(false);
             break;
@@ -298,6 +302,34 @@ class StatusView extends React.Component {
     );
   };
 
+  downloadSupportArchive = (agentId, agentVersion) => {
+    this.setState(
+      {
+        isLoading: true,
+      },
+      () => {
+        axios
+          .get('/agent/supportArchive', {
+            params: { 'agent-id': agentId },
+          })
+          .then((res) => {
+            this.setState({
+              isLoading: false,
+            });
+            downloadArchiveFromJson(res.data, agentId, agentVersion);
+            this.setDownloadDialogShown(false);
+          })
+          .catch(() => {
+            this.setState({
+              contentValue: null,
+              contentLoadingFailed: true,
+              isLoading: false,
+            });
+          });
+      }
+    );
+  };
+
   fetchConfiguration = (attributes) => {
     const requestParams = attributes;
     if (!requestParams) {

components/inspectit-ocelot-configurationserver-ui/src/functions/export-selection.function.js

@@ -82,3 +82,31 @@ function loadAndCompressSubFolderContent(subFolderPath, subFolderName, subFolder
     }
   });
 }
+
+export function downloadArchiveFromJson(json, agentId, agentVersion) {
+  for (let key of Object.keys(json)) {
+    let content = json[key];
+    let mimetype = 'text/plain;charset=utf-8';
+    let fileExtension = '.txt';
+
+    switch (key) {
+      case 'currentConfig':
+        mimetype = 'text/x-yaml;charset=utf-8';
+        fileExtension = '.yml';
+        break;
+      case 'logs':
+        fileExtension = '.log';
+        break;
+    }
+
+    if (typeof content === 'object') {
+      content = JSON.stringify(content, null, 2);
+    }
+    const file = new Blob([content], { type: mimetype });
+    zip.file(`${key}${fileExtension}`, file);
+  }
+  zip
+    .generateAsync({ type: 'blob' })
+    .then((archive) => saveAs(archive, `${agentId}_${agentVersion}.zip`))
+    .finally((zip = new JSZip()));
+}

components/inspectit-ocelot-configurationserver/src/main/java/rocks/inspectit/ocelot/agentcommunication/AgentCommandManager.java

@@ -4,7 +4,6 @@
 import com.google.common.cache.CacheBuilder;
 import com.google.common.cache.CacheLoader;
 import com.google.common.cache.LoadingCache;
-import lombok.extern.java.Log;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
@@ -13,8 +12,6 @@
 import rocks.inspectit.ocelot.config.model.InspectitServerSettings;
 
 import javax.annotation.PostConstruct;
-import java.time.Duration;
-import java.util.LinkedList;
 import java.util.concurrent.BlockingQueue;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.LinkedBlockingQueue;
@@ -82,7 +79,6 @@ public void addCommand(String agentId, Command command) throws ExecutionExceptio
     public Command getCommand(String agentId, boolean waitForCommand) {
         try {
             BlockingQueue<Command> commandQueue = agentCommandCache.get(agentId);
-
             Command command;
             if (waitForCommand) {
                 AgentCommandSettings commandSettings = configuration.getAgentCommand();
@@ -92,7 +88,7 @@ public Command getCommand(String agentId, boolean waitForCommand) {
                 command = commandQueue.poll();
             }
 
-            if (commandQueue.isEmpty()) {
+            if (command == null) {
                 agentCommandCache.invalidate(agentId);
             }
             return command;

components/inspectit-ocelot-configurationserver/src/main/java/rocks/inspectit/ocelot/agentcommunication/handlers/impl/EnvironmentCommandHandler.java

@@ -28,6 +28,7 @@ public class EnvironmentCommandHandler implements CommandHandler {
      * Checks if the given {@link Command} is an instance of {@link EnvironmentCommand}.
      *
      * @param command The command which should be checked.
+     *
      * @return True if the given command is an instance of {@link EnvironmentCommand}.
      */
     @Override
@@ -39,6 +40,7 @@ public boolean canHandle(Command command) {
      * Checks if the given {@link CommandResponse} is an instance of {@link EnvironmentCommand.Response}.
      *
      * @param response The response which should be checked.
+     *
      * @return True if the given response is an instance of {@link EnvironmentCommand.Response}.
      */
     @Override
@@ -52,6 +54,7 @@ public boolean canHandle(CommandResponse response) {
      *
      * @param agentId The id of the agent the command is meant for.
      * @param command The command to be Executed.
+     *
      * @return An instance of  {@link DeferredResult} with a set timeout value and a set timeout function.
      */
     @Override
@@ -70,7 +73,7 @@ public DeferredResult<ResponseEntity<?>> prepareResponse(String agentId, Command
     /**
      * Takes an instance of {@link CommandResponse} as well as an instance of {@link DeferredResult}.
      * Sets the {@link ResponseEntity} of the {@link DeferredResult} according to the
-     * Environment Information received from the respective Agent."
+     * Environment Information received from the respective Agent.
      *
      * @param response The {@link CommandResponse} to be handled.
      * @param result   The {@link DeferredResult} the response should be written in.

components/inspectit-ocelot-configurationserver/src/main/java/rocks/inspectit/ocelot/rest/agent/AgentController.java

@@ -8,6 +8,7 @@
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.*;
+import org.springframework.web.context.request.async.DeferredResult;
 import rocks.inspectit.ocelot.agentcommunication.AgentCallbackManager;
 import rocks.inspectit.ocelot.agentcommunication.AgentCommandManager;
 import rocks.inspectit.ocelot.agentconfiguration.AgentConfiguration;
@@ -20,6 +21,7 @@
 
 import java.util.Map;
 import java.util.UUID;
+import java.util.concurrent.ExecutionException;
 
 /**
  * The rest controller providing the interface used by the agent for configuration fetching.
@@ -40,6 +42,9 @@ public class AgentController extends AbstractBaseController {
     @Autowired
     private AgentCallbackManager agentCallbackManager;
 
+    @Autowired
+    private AgentService agentService;
+
     @ExceptionHandler
     public void e(Exception e) {
         e.printStackTrace();
@@ -97,4 +102,17 @@ public ResponseEntity<Command> fetchCommand(@RequestHeader Map<String, String> h
             return ResponseEntity.ok().body(nextCommand);
         }
     }
+
+    /**
+     * Returns the data for building the downloadable support archive for the agent with the given name in the frontend.
+     *
+     * @param attributes the attributes of the agents used to select the appropriate data.
+     *
+     * @return The data used in the support archive.
+     */
+    @ApiOperation(value = "Fetch an Agents Data for Downloading a Support Archive", notes = "Bundles useful information for debugging issues raised in support tickets.")
+    @GetMapping(value = "agent/supportArchive", produces = "application/json")
+    public DeferredResult<ResponseEntity<?>> fetchSupportArchive(@ApiParam("The agent attributes used to retrieve the correct data") @RequestParam Map<String, String> attributes) throws ExecutionException {
+        return agentService.buildSupportArchive(attributes, configManager);
+    }
 }