Skip to main content

Inter-region latency statistics plugin for az-scout

Project description

az-scout-plugin-latency-stats

Inter-region latency statistics plugin for az-scout.

image

Features

  • Latency dataset — static latency matrix based on Microsoft published statistics
  • API endpointsPOST /plugins/latency-stats/matrix for pairwise latency matrices, GET /plugins/latency-stats/pairs to list all known pairs
  • MCP toolregion_latency(source_region, target_region) returns indicative RTT between two Azure regions
  • UI tab — interactive D3.js force-directed graph where regions are nodes and edges show latency in ms
  • URL hash routing#latency selects the plugin tab

Setup

pip install az-scout-plugin-latency-stats
az-scout  # plugin is auto-discovered

For development:

git clone https://github.com/lrivallain/az-scout-plugin-latency-stats
cd az-scout-plugin-latency-stats
uv sync --group dev
uv pip install -e .
az-scout  # plugin is auto-discovered

Structure

az-scout-plugin-latency-stats/
├── .github/
│   ├── copilot-instructions.md  # Copilot context for this plugin
│   └── workflows/
│       ├── ci.yml               # CI pipeline (lint + test, Python 3.11–3.13)
│       └── publish.yml          # Publish to PyPI on version tags
├── pyproject.toml
├── README.md
└── src/
    └── az_scout_latency_stats/
        ├── __init__.py          # Plugin class + module-level `plugin` instance
        ├── latency.py           # Static latency dataset + public API
        ├── routes.py            # FastAPI APIRouter (optional)
        ├── tools.py             # MCP tool functions (optional)
        └── static/
            ├── css/
            │   └── latency.css      # Plugin styles (auto-loaded via css_entry)
            ├── html/
            │   └── latency-tab.html # HTML fragment (fetched by JS at runtime)
            └── js/
                └── latency-tab.js   # Tab UI logic (auto-loaded via js_entry)

How it works

  1. The plugin JS loads the HTML fragment into #plugin-tab-latency.
  2. Regions are populated from the main app's regions global.
  3. The user selects 2+ regions and clicks Show Latency Graph.
  4. The plugin calls POST /plugins/latency-stats/matrix with the selected regions.
  5. A D3.js force-directed graph renders regions as nodes with RTT-labelled edges.

API

# Pairwise matrix
curl -X POST http://localhost:8080/plugins/latency-stats/matrix \
  -H "Content-Type: application/json" \
  -d '{"regions": ["francecentral", "westeurope", "eastus"]}'

# All known pairs
curl http://localhost:8080/plugins/latency-stats/pairs

MCP tool

region_latency(source_region="francecentral", target_region="westeurope")

Quality checks

The scaffold includes GitHub Actions workflows in .github/workflows/:

  • ci.yml — Runs lint (ruff + mypy) and tests (pytest) on Python 3.11–3.13, triggered on push/PR to main.
  • publish.yml — Builds, creates a GitHub Release, and publishes to PyPI via trusted publishing (OIDC). Triggered on version tags (v*). Requires a pypi environment configured in your repo settings with OIDC trusted publishing.

Run the same checks locally:

uv run ruff check src/ tests/
uv run ruff format --check src/ tests/
uv run mypy src/
uv run pytest

To publish a release:

git tag v2026.2.0
git push origin v2026.2.0

Copilot support

The .github/copilot-instructions.md file provides context to GitHub Copilot about the plugin structure, conventions, and az-scout plugin API. It helps Copilot generate code that follows the project patterns.

Data source

Latency values are approximate median round-trip times from the Azure Network Latency page. Always validate with in-tenant measurements.

License

MIT

Disclaimer

This tool is not affiliated with Microsoft. All capacity, pricing, and latency information are indicative and not a guarantee of deployment success. Spot placement scores are probabilistic. Quota values and pricing are dynamic and may change between planning and actual deployment. Latency values are based on Microsoft published statistics and must be validated with in-tenant measurements.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

az_scout_plugin_latency_stats-2026.3.0.tar.gz (137.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file az_scout_plugin_latency_stats-2026.3.0.tar.gz.

File metadata

File hashes

Hashes for az_scout_plugin_latency_stats-2026.3.0.tar.gz
Algorithm Hash digest
SHA256 db4f41afe3754aa38b8e30b80850c8bd1a25fe17379d2551c765415a8bd006b4
MD5 a8cda63aed02a21524f83f5b2f95087d
BLAKE2b-256 445e035b43f4e852bfd4e91809e57bb9e2c0920b5e94d755ffa59cca469cd0c8

See more details on using hashes here.

Provenance

The following attestation bundles were made for az_scout_plugin_latency_stats-2026.3.0.tar.gz:

Publisher: publish.yml on lrivallain/az-scout-plugin-latency-stats

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file az_scout_plugin_latency_stats-2026.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for az_scout_plugin_latency_stats-2026.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d9a46a11eb2b941053a9207fdcaf117fbea523610256cb41c7563c8632472a17
MD5 8d5e465032ee2b31a77736af96c8b8a6
BLAKE2b-256 bbb579e96969ba321f7b0f6a3cf7b95fc577003304c3445420adcd6f901d8efa

See more details on using hashes here.

Provenance

The following attestation bundles were made for az_scout_plugin_latency_stats-2026.3.0-py3-none-any.whl:

Publisher: publish.yml on lrivallain/az-scout-plugin-latency-stats

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page