> For the complete documentation index, see [llms.txt](https://learn.heeler.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://learn.heeler.com/tenant-admin-guide/operational-health.md).

# Operational Health

## Monitoring Scan and Connection Health Across Your Tenant

The **Operational Health** page is your single view of how Heeler is performing across your tenant — what's scanning successfully, what's failing, and where any errors are coming from. Check it weekly (or hook it into your monitoring) to catch silently broken connections before they undermine your security data.

### Where to find it

Open the **gear icon** in the top-right → **Operational Health** tab. This is a flat dashboard (no sub-sections).

URL: `https://app.heeler.com/administration/operational_health`

### Quick start

The page is divided into four sections, top to bottom:

1. **Summary** — at-a-glance counts of repositories and modules scanned successfully.
2. **Error Breakdown** — chart of errors by category.
3. **Guardrail Executions (Last 30 Days)** — timing stats for guardrail runs.
4. **First-Party Package Registries** — registries Heeler considers internal/first-party, with health and traffic.
5. **Errors and Warnings** — a filterable list of recent issues with links into the affected repository/module.

If everything is green and the Errors list is empty (or only contains expected items), you're in good shape. Investigate anything in red.

### Reference

#### Summary card

| Metric                                | Description                                                                                     |
| ------------------------------------- | ----------------------------------------------------------------------------------------------- |
| **Repositories Successfully Scanned** | Count and percentage of total repositories. Includes breakdown of Successful / Warning / Error. |
| **Modules Successfully Scanned**      | Same breakdown at module level (a module is a buildable unit within a repository).              |

#### Error Breakdown

Distribution of errors by category — typically things like *Authentication*, *Rate Limited*, *Parse Error*, *Network*, etc. Use this to spot systemic issues vs one-offs.

#### Guardrail Executions (Last 30 Days)

| Metric                     | Description                                                                                                                   |
| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| **Average Execution Time** | Mean time for a guardrail to evaluate.                                                                                        |
| **Minimum Execution Time** | Fastest evaluation in the window.                                                                                             |
| **Longest Execution Time** | Slowest evaluation. Investigate outliers — they often indicate a guardrail doing too much work or hitting a slow integration. |

#### First-Party Package Registries

Table showing which registries Heeler treats as first-party (i.e., registries you publish into).

| Column                    | Description                                         |
| ------------------------- | --------------------------------------------------- |
| **Type**                  | Registry type (npm, Maven, PyPI, etc.).             |
| **Registry**              | Display name.                                       |
| **Connection**            | Linked Registry connection.                         |
| **Traffic**               | Recent traffic volume Heeler has observed.          |
| **Affected Repositories** | Number of repos using this registry.                |
| **Last Probed**           | When Heeler last successfully reached the registry. |
| **Action**                | Quick controls (refresh probe, etc.).               |

Filters: **Status** (e.g., "Needs connection"), **Ecosystem**, **Repository**.

#### Errors and Warnings

A filterable, searchable list of issues currently affecting scan or analysis.

| Column          | Description                         |
| --------------- | ----------------------------------- |
| **Repository**  | Affected repo.                      |
| **Module**      | Affected module (where applicable). |
| **Category**    | Error category.                     |
| **Type**        | Specific error type.                |
| **Description** | Human-readable explanation.         |
| **Detected**    | When the error first appeared.      |

Filter: **Error Type**. Use the search box to find issues for a specific repository or module.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://learn.heeler.com/tenant-admin-guide/operational-health.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
