(r2) MustGatherCollectionUsingAutogather < Deployment

Engineering Lifecycle Management Wiki - Deployment

Community information and contribution guidelines

~~EditAttach~~Printable

TWiki > Deployment Web > DeploymentTroubleshooting > PerformanceTroubleshooting > MustGatherCollectionUsingAutogather

Revision 2 - 2025-11-06 - 10:27:09 - IanBarnard

<div id="header-title" style="padding: 10px 15px; border-width:1px; border-style:solid; border-color:#FFD28C; background-image: url(<nop>https://jazz.net/wiki/pub/Deployment/WebPreferences/TLASE.jpg); background-size: cover; font-size:120%">
---+!! Automating MustGather and other diagnostic collection using AutoGather  
%DKGRAY% Authors: Main.TWikiUser, Main.TWikiUser <br>
Build basis: Products, editions, or versions that apply to the content. If no build basis applies to this content, set the build basis to None.
%ENDCOLOR%</div></sticky>

<!-- Page contents top of page on right hand side in box -->
<sticky><div style="float:right; border-width:1px; border-style:solid; border-color:#DFDFDF; background-color:#F6F6F6; margin:0 0 15px 15px; padding: 0 15px 0 15px;">
%TOC{title="Page contents"}%
</div></sticky>

<sticky><div style="margin:15px;"></sticky>

The manual collection of Performance MustGather is quite a complicated series of steps - see for example the [[https://www.ibm.com/support/pages/ibm-engineering-requirements-management-doors-next-v7x-performance-mustgather][DOORS Next Performance MustGather]].

AutoGather is a new diagnostic application to help by automating large parts of the MustGather collection, which can also be used for other diagnostic collection needs.

---++ Introduction

The manual collection of Performance MustGather is quite a complicated series of steps - see for example the [[https://www.ibm.com/support/pages/ibm-engineering-requirements-management-doors-next-v7x-performance-mustgather][DOORS Next Performance MustGather]] -  often requiring an IBM support engineer to run a call coordinating actions among several client personnel including at least one JazzAdmin and a user; the user reproduces the problem while the other client personnel capture information, such as triggering javacores every thirty seconds during the reproduction. Around this main collection there are various pages and files which need to be combined with the ISADC logs to attach to the support case. This complexity often causes some of the files to be missed and this typically won't be discovered until after the call has finished, and may require the complete collection to be repeated.

AutoGather is a new diagnostic application to help by automating large parts of the MustGather collection - requiring only a JazzAdmin and the user to reproduce the problem - and speeds up the collection, with no possibility that parts of the collection will be missed.

---+++ What AutoGather can do

AutoGather is a Java application which uses available APIs of the running server to collect more than just the log files. A particular difference from ISADC is that it can trigger and collect javacores at controlled intervals - this is valuable for analysis of many issues including performance problems.

In addition to expediting collection of Performance MustGather, AutoGather can meet other needs for logs collection, such as:
   * Remote Gather - simplifying log collection from multiple servers
   * "Super" ISADC - collects everything that ISADC collects and also collects javacores, verbosegc, server startup and configuration details
   * Monitoring - run AutoGather for a period (e.g. one hour, or twenty four hours) collecting javacores and other information at regular intervals
   * Gathering DEBUG loggers - automatically enables loggers to DEBUG at the start of the collection and reverts these when the collection finished

---+++ Collection modes for AutoGather

AutoGather can be used in three modes of operation:
   * Normal: this mode is intended to directly address the collection of Performance MustGather diagnostics and logs. AutoGather must be installed on the application server and is run there, collecting files and logging in to the ELM server to gather other diagnostic information - however if the ELM deployment is using a web-based authentication scheme such as SAML or ADFS this mode can't be used.
   * Remote: this mode is intended for use when 
   * Anonymous: this mode doesn't require a username and password to log into ELM - in that respect it's most like ISADC. However the collection is more limited, so this isn't suitable for the full Performance MustGather collection. However this mode also requires no/minimal configuration as it collects information through the filesystem. Because no login is required this can collect disagnostics when the ELM application is using a web-based authentication scheme like SAML or ADFS, whoich isn't possible in the other two modes.

---+++ What is collected in each mode

Sub-Section text Sub-Section text  Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text

---+++ Heading 2 (use sentence-style capitalization)

Sub-Section text Sub-Section text  Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text Sub-Section text

---+++ Heading 2 (use sentence-style capitalization)





---++ Heading 1

---+++++!! Related topics: [[DeploymentWebHome][Deployment web home]], [[DeploymentWebHome][Deployment web home]]

---+++++!! External links:          

   * [[https://www.ibm.com][IBM]]

---+++++!! Additional contributors: Main.TWikiUser, Main.TWikiUser

<sticky></div></sticky>

Copyright © by IBM and non-IBM contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our Terms of Use. Please read the following disclaimer.
Dashboards and work items are no longer publicly available, so some links may be invalid. We now provide similar information through other means. Learn more here.