Doctor¶

The Doctor checks that a project is set up correctly in Imbi and in the systems that Imbi connects to. It shows each result as a finding. Many findings have a fix that you can apply with one click.

To open the Doctor, open a project and click the stethoscope icon at the right end of the tab bar. Its tooltip is Project Doctor. The icon color shows the overall result of the last analysis:

Run an analysis¶

1. Open the Doctor tab.
2. Click Analyze in the Utility Functions card.

When you open the tab and no analysis exists, and you have project:write, the analysis starts automatically.

Imbi stores one report for each project. Each analysis replaces the previous report. Imbi keeps no history of reports. A new report queues a recompute of the project score, because an Analysis Result scoring policy reads the report. No schedule runs the analysis for one project. An administrator can run it for all projects (see Maintenance operations).

An analysis runs these checks:

1. The built-in blueprint compliance check.
2. The analysis checks of each plugin that the project uses, at the same time. Each plugin has a time limit (10 seconds by default, IMBI_PLUGIN_TIMEOUT_SECONDS).

If a plugin fails, the report shows one Fail finding, "\<plugin> analysis failed". The server log has the details.

Read the results¶

The Analysis Results card shows the findings in three groups, in this order: Fail, Warn, and Pass. Each group shows its count. Findings are sorted by title in each group.

Each finding shows:

• a status icon and the title,
• the status (Fail, Warn, or Pass),
• the slug of the plugin that made the finding (blueprint-compliance for the built-in check),
• when you expand it, a description and, if the finding has one, a fix button.

Fail and Warn findings are expanded. Pass findings are collapsed.

There is no other severity. A finding is a Fail, a Warn, or a Pass.

Fix a finding¶

A finding with a fix shows a button under its description. The text of the button tells you what the fix does, for example Create the EXISTS_IN edge from GitHub.

1. Expand the finding.
2. Click the fix button.
3. If a dialog opens, read it, then click the button again to confirm.

A dialog opens only for a destructive fix: a fix that creates or deletes something, or removes a value. When the plugin gives no text for the dialog, it says "This action cannot be undone."

After the fix, Imbi runs the analysis again and shows the new report. A message tells you the result: fixed, nothing to do, or failed.

To apply all fixes in the report, click Fix all in the Utility Functions card. This applies every fix, destructive ones included, without a dialog. One failed fix does not stop the others. The message shows how many were fixed and how many failed.

While one fix runs, all other fix buttons are disabled.

Utility functions¶

The Utility Functions card has the buttons that you have permission to use.

The button reads Sync Releases for a project whose project types are releasable and none is deployable.

The seeded roles give project:deployment:write, project:commits:write, and project:pull-requests:write to admin and developer. The three sync buttons use only your role in the organization of the project. A platform administrator who is not a member of that organization gets 403. See Roles and permissions.

What the Doctor checks¶

Blueprint compliance (built-in)¶

This check runs for every project. It compares the project attributes with the Project blueprints that apply to the project types. See Blueprints.

GitHub¶

The GitHub plugin checks that the project is linked to the correct repository. The fixes are not destructive. See GitHub.

When Imbi cannot read the repository, the checks that need it show Warn.

SonarQube¶

The SonarQube plugin checks the link to the SonarQube project and its main branch. See SonarQube.

PagerDuty¶

The PagerDuty plugin checks the PagerDuty service of the project, its escalation policy, and its dependencies. See PagerDuty.

A dependency on a project that has no PagerDuty service is not synced. The check then shows Warn.

Other plugins¶

The AWS, Google, Logz.io, and OIDC plugins have no Doctor checks.

Sync fixes¶

A plugin can mark a fix as a sync fix. A sync fix only makes a remote system agree with Imbi. It never creates or deletes a remote resource, and it is safe to apply again. Today, the two PagerDuty fixes Repoint the escalation policy and Sync PagerDuty service dependencies are the only sync fixes.

Apply Sync Fixes¶

Apply Sync Fixes is a maintenance operation. It applies the sync fixes for every project, with no person at the screen.

1. Open Admin > Global Admin > Maintenance.
2. Find Apply Sync Fixes and click Run.
3. Read the dialog. The operation runs for all organizations. Click Run.

For each project that is not archived, the operation runs a new analysis, stores the report, and applies only the sync fixes. A project with no sync fix is skipped with the message "No sweepable findings." The operation runs as the system principal Imbi Maintenance.

You need admin:maintenance:manage to run it, and admin:maintenance:read to see it. The seeded roles give these only to admin. See Maintenance.

Maintenance operations¶

Admin > Global Admin > Maintenance has two more Doctor operations. Each one runs for every project that is not archived.

Scoring¶

A scoring policy of the category Analysis Result can give points for the status of one Doctor finding. See Scoring.