Adding an Analyzer
Configuring Analyzers in ARES OS
Analyzers are essential components within ARES used to process real-time data and provide feedback for experiment optimization. This guide outlines how to register and verify a new analyzer within ARES OS. To learn more about building your own analysis logic, check out the PyAres documentation for creating an analyzer.
Adding a New Analyzer
Follow these steps to connect a new analyzer service to your environment:
- Access Settings: Click the Settings (gear icon) in the bottom-left sidebar of the ARES OS dashboard.
- Navigate to Analyzers: Select the Analyzer tab from the top navigation menu within the Settings view.
- Open Registration Modal: Click the + (plus) button in the top-right corner of the interface.
- Input Configuration:
- Analyzer Name: Enter a unique identifier for the analyzer (e.g.,
My Analyzer). - Address: Provide the full URL where the analyzer service is hosted (e.g.,
http://localhost:7083).
- Analyzer Name: Enter a unique identifier for the analyzer (e.g.,
- Save: Click the Save button to finalize the registration.
Verification: Upon successful registration, a green notification will confirm the update. The analyzer should immediately appear in the list with a green Active badge.
Analyzer Information Overview
Once an analyzer is registered, the settings page displays several key metadata fields retrieved from the service:
| Field | Description |
|---|---|
| Address | The network location ARES uses to communicate with the analyzer. |
| Type | The specific implementation type (e.g., Python Test Analyzer). |
| Version | The current version of the analyzer service. |
| Description | A summary of the analyzer’s functionality, often defined via PyAres. |
| Status | A real-time indicator showing if the analyzer is reachable and active. |
Plugin and Remote Services
Analyzers in ARES are typically implemented as remote services following the platform’s plugin-first philosophy:
- The analyzer runs as an independent service (often using PyAres) and exposes a gRPC/HTTP endpoint.
- ARES OS connects to the analyzer via the configured address and treats it as a plugin.
- Example analyzer services include custom Python analyzers and demo projects such as
DemoRemoteAnalyzerin the ARES OS repository.
For architectural background and guidance on building analyzer plugins and remote services, see the Developer Guide.