Collecting information for Tanzu Mission Control API errors
search cancel

Collecting information for Tanzu Mission Control API errors

book

Article ID: 376347

calendar_today

Updated On:

Products

Tanzu Mission Control VMware Tanzu Mission Control - SM

Issue/Introduction

In some scenarios when you use Tanzu Mission Control (TMC) you may encounter API errors when accessing objects on the webpage. This KB outlines how to collect information required for Broadcom Support to troubleshoot further when you create a support case.

Resolution

Below is the required information to provide to Broadcom Support for API errors on TMC:

Tanzu Mission Control Deployment Type: Tanzu Mission Control SaaS or Tanzu Mission Control Self Managed

Tanzu Mission Control URL and Long Org ID (TMC SaaS only): Example formats - URL: example.tmc.cloud.vmware.com, ID: ########-####-####-####-############ (Note: you can use the following docs to find your Long Org ID.)

Error Verbiage: Typically API errors have red banners at the top of your browser that show a message with error info when you try to access specific objects in the TMC User Interface (UI). Example - API Error: Failed to list management clusters: Error

Generate and collect a HAR file from your browser: HAR file generation can vary depending on your browser, typically the process is similar to what is documented for Google Chrome in the browser docs. (Note: In most cases you would export a HAR file after logging into TMC, ensure that you preform the exact steps to reproduce the error in the TMC UI, and ensure that you have the `Preserve log` option enabled on your browser.)

Request URL and RequestID: This information can typically be accessed when looking at the HAR file export for the failure.

The Request URL field will show a URL to your TMC instance with some extra sub directories in the URL. Example - https://<TMC-URL>.tmc.cloud.vmware.com/v1alpha1/managementclusters?sort_by=status.kubeServerVersion:ascending,fullName...

The RequestID or X-Request-ID field will show a large number separated by dashes. Example format - ########-####-####-####-###########

 

After collecting this information you can proceed with opening a Broadcom Support case to investigate and troubleshoot the API error.

Warning: Recording a HAR file or generating a HAR file while passing credentials has the potential to capture access tokens or passwords in plain text. Refrain from capturing HARs during login operations.

Additional Information

Generate a HAR file in Chrome

  1. Open Chrome and go to the page where the issue is occurring.
  2. Look for the ⋮ button and select More Tools > Developer Tools.
  3. From the panel that appears, select the Network tab. You must keep the menu open while you reproduce the issue. 

  4. Look for a round record button in the upper left corner of the tab, and make sure it is red. If it is grey, click the button once to start recording.
  5. If it isn't, check the Preserve log box.
  6. Click the grey crossed circle button to clear any existing logs from the network tab.
  7. Reproduce the issue while the network requests are recorded.
  8. Click the download button, Export HAR, to download, and save the file to your computer: Save as HAR with Content.

For any issues generating this file, see this article from Google's Help Center: Capture web session traffic.

To retrieve console logs in Chrome

  1. Open Main Menu for Chrome.
  2. Navigate to More Tools > Developer Tools.
  3. Open the Console tab and screenshot any errors that appear.

Generate a HAR file in Firefox

  1. Open Firefox and go to the page where the issue is occurring.
  2. Open the Network Monitor.
  3. Reproduce the issue while the network requests are recorded.
  4. Right-click anywhere under the File column and click Save All As HAR.

  5. Save the HAR file somewhere convenient.

To retrieve console logs in Firefox

  1. In the Tools menu, select Web Developer.
  2. Console logs will appear in a separate window.
  3. Screenshot any errors that appear.

Generate a HAR file in Safari

  1. Open Safari and go to the Develop menu. If you don't see theDevelop menu, follow the instructions in this article from the Safari User Guide: Use the developer tools in the Develop menu in Safari on Mac.
  2. Select Show Web Inspector.
  3. Click the Network tab. You must keep it open while you reproduce the issue.
  4. Reproduce the issue while the network requests are recorded.
  5. Click the Export icon and save the HAR file.

For any issues generating a HAR file in Safari, see this article from Safari Developer website: Web Inspector.

To retrieve console logs in Safari

  1. Open Preferences and navigate to the Advanced tab.
  2. Select Show Developer menu in the menu bar.
  3. Close Preferences.
  4. In the menu bar, select Developer > Show error console.
  5. Screenshot any errors that appear.

To generate a HAR file in Edge

  1. Open Edge and go to the Network tool.
  2. Reproduce the issue while the network requests are recorded.
  3. Export captured traffic as a HAR file.

For any issues generating a HAR file in Safari, see this article from Microsoft Edge website: Inspect network activity.

To retrieve console logs in Edge

  1. Select the three dots in the upper-right corner of your browser window.
  2. Click More tools > Developer Tools.
  3. In the DevTools panel, click the Console tab.
  4. Right-click the console and select Clear Console of any pre-existing logs.
  5. Check the Preserve Log checkbox.
  6. Replicate the issue that you experienced in the Edge browser.
  7. Screenshot any errors that appear.
Powered by Wolken Software