How to Use the AGILITY Active Probe
The AGILITY Active Probe is designed to automate triggering analysis, collecting results, and tracking performance metrics.
Prerequisites:
Basic understanding of network diagnostics, SFTP, and S3 operations.
Installed dependencies for the Active Probe (see Dependencies section).
Running the Active Probe
Once deployed, the Active Probe runs automatically:
Automatic Triggering: The probe automatically triggers diagnostic analysis, either on demand or according to a defined schedule.
Analysis Collection: The Active Probe fetches analysis results using AGILITY API endpoints (e.g.,
/v1/analysis
and/v1/analysis/{analysis_id}/summary
).Result Validation: The probe compares collected results with expected outcomes, logging failures or successes based on analysis status.
Monitoring and Viewing Results
Real-time monitoring and result tracking are integrated seamlessly with AGILITY:
Dashboard for Results: A dedicated dashboard shows:
Validated Results (successful analyses).
Failed Results, with labels such as model, call ID, and cause for failure.
OpenTelemetry Integration: Metrics like
active_probe_attempt_count
andactive_probe_analysis_count
are forwarded to your monitoring systems, providing real-time insights into probe performance.
Handling Failures and Retries
In case of failure, the Active Probe employs automatic retry logic to ensure consistent results:
Retry Logic: The probe automatically retries the analysis collection process if initial attempts fail.
Failure Logging: If the analysis cannot be completed successfully within the retry window, the failure is logged, and counters are updated accordingly.
Metrics and Analytics
The Active Probe integrates with OpenTelemetry to provide detailed metrics on network performance:
active_probe_attempt_count
: Total number of analysis attempts.active_probe_analysis_count
: Total number of successfully completed analyses.
These metrics provide insights into probe performance and diagnostics, with additional labels for classification.
Troubleshooting
For troubleshooting, follow these steps:
SFTP/S3 Configuration: Ensure that file locations are accessible by the Active Probe.
API Connectivity: Verify that the AGILITY API is responding and providing expected data.
Telemetry Monitoring: Confirm that OpenTelemetry metrics are correctly forwarded to monitoring systems.
Log Review: Examine logs for errors related to analysis collection or comparison failures.
Dependencies
Ensure the following dependencies are installed for proper operation:
APScheduler==3.10.4
requests==2.31.0
PyYAML==6.0
opentelemetry-api==1.21.0
opentelemetry-sdk==1.21.0
opentelemetry-exporter-otlp==1.21.0
boto3==1.26.96
Add Comment