Skip to content

Surface issues in Fleet Android agent app when something is not working properly #38034

@getvictor

Description

@getvictor

Goal

User story
As an end user on Android,
I want to see errors when the Fleet agent app is not working properly
so that I can help my IT admin debug connectivity issues.

Original requests

Changes

Product

  • Android app UI changes (Figma)
    • Update debug page to be more user friendly:
      • Add left/right padding to match home page
      • Sentence case page title ("Debug Information" -> "Debug information")
      • Remove host_certificates (duplicative)
      • Remove server_url (DS) (duplicative)
      • Update label host_uuid (MC) -> host_uuid
      • Update label server_url (MC) -> server_url
    • Add error section to debug page
      • New section at the bottom of debug page: "error details"
      • includes most recent error formatted as:
        time: <timestamp>
        message: <message>
      • If no errors, text reads "No errors"
  • CLI (fleetctl) usage changes: No changes
  • YAML changes: No changes
  • REST API changes: No changes
  • Fleet's agent (fleetd) changes: No changes
  • Fleet server configuration changes: No changes
  • Exposed, public API endpoint changes: No changes
  • fleetdm.com changes: No changes
  • GitOps mode UI changes: No changes
  • GitOps generation changes: No changes
  • Activity changes: No changes
  • Permissions changes: No changes
  • Changes to paid features or tiers: No changes
  • My device and fleetdm.com/better changes: No changes
  • Usage statistics: No changes
  • Other reference documentation changes: No changes
  • First draft of test plan added
  • Once shipped, requester has been notified
  • Once shipped, dogfooding issue has been filed

Engineering

  • Test plan is finalized
  • Feature guide changes: Yes
  • This is a premium only feature: Yes

ℹ️  Please read this issue carefully and understand it. Pay special attention to UI wireframes, especially "dev notes".

Implementation work

  • Update the Android agent UI per Figma
  • When an exception/error occurs in the app, send it to a new class for handling. Android agent UI should pull the last error out of the handler. We should surface all unexpected errors.
    • Store the last error so it persists between restarts.
  • Provide specific instructions to QA (testplan in this ticket) how to cause errors to test this feature
  • Update guide: document how to open up the debug tool in the app

QA

Risk assessment

  • Risk level: Low

Test plan

Make sure to go through the list and consider all events that might be related to this story, so we catch edge cases earlier.

  • Test for customer-pingali's 403 infra error, make sure it is shown on the debug page
  • Test for customer-pingali's 401 invalid node_key error, make sure it is shown on the debug page

Testing notes

Confirmation

  1. Engineer: Added comment to user story confirming successful completion of test plan.
  2. QA: Added comment to user story confirming successful completion of test plan.

Metadata

Metadata

Labels

#g-security-complianceSecurity & Compliance product group:releaseReady to write code. Scheduled in a release. See "Making changes" in handbook.storyA user story defining an entire feature

Type

No type

Projects

Status

No status

Status

✅ Ready for release

Relationships

None yet

Development

No branches or pull requests

Issue actions