pgEdge Radar Analyst

Table of Contents

The pgEdge Radar Analyst documentation covers these topics:

• Getting Started
  • Introduction
  • Guided Walkthrough
• Installing the Analyst
• Configuring the Analyst
• Using the Analyst
• Managing an Installation
• Troubleshooting
• For Developers
  • API Reference
  • API Browser
  • Developer Resources
• Changelog
• License

pgEdge Radar Analyst assesses the health of a PostgreSQL host from a pgEdge Radar diagnostic archive. The analyst checks the archive against deterministic rules and gives each diagnostic category a verdict. For each category, the analyst also writes a brief that explains the verdict. You can read each assessment in a web console or retrieve it from a JSON API.

The analyst works from the uploaded archive alone, so it never connects to the assessed host. You can therefore review a host's health without giving the analyst any access to that host.

Installation

The analyst runs as two containers: the analyst itself and a PostgreSQL database that stores the assessments. The installation requires Docker with the Compose plugin. The following commands download the compose file into a new directory and start the analyst:

mkdir radar-analyst && cd radar-analyst
curl -fsSLO https://raw.githubusercontent.com/pgEdge/radar-analyst/main/docker-compose.yml
docker compose up -d --wait

The last command returns once both containers are ready. The console is then available at http://localhost:8080/ on the local machine. The Installing the Analyst page describes the installation in detail. The Developer Resources page describes building the analyst from source.

Configuration

The analyst reads its settings from a .env file beside docker-compose.yml. A provider writes the briefs, and the default provider needs only an Anthropic API key. Add the following line to the .env file, and create the file if it does not exist:

ANTHROPIC_API_KEY=sk-ant-...

The following command recreates the analyst's container with the new setting:

docker compose up -d --wait

The Configuring the Analyst page describes every provider and every setting.

Using pgEdge Radar Analyst

You assess a host by collecting a radar archive on the host and uploading the archive to the console. To assess a host, perform the following steps:

1. Run radar on the PostgreSQL host to collect a diagnostic archive.
2. Open http://localhost:8080/ in a browser on the machine that runs the analyst.
3. Drag the archive onto the upload area, and then select Upload.

The console shows the progress of the assessment and then opens the result. The Guided Walkthrough describes each step, and the Using the Analyst page describes the console in detail. The API Reference describes the JSON API that the console uses.

Documentation

MkDocs builds the documentation in the docs/ directory. The make docs command builds the site into site/ and stops on any warning. For more information about pgEdge products, visit docs.pgedge.com.

Support & Resources

The Troubleshooting page describes common problems and how to solve each one. For more information, visit docs.pgedge.com.

To report an issue with the software, visit GitHub Issues. To report a security vulnerability, follow the security policy instead of opening a public issue.

Contributing

We welcome your project contributions; for more information, see docs/developers.md and CONTRIBUTING.md.

Author

Jimmy Angelakos created Radar Analyst.

License

This project is licensed under the PostgreSQL License.