1
0
Fork 1
mirror of https://github.com/thatmattlove/hyperglass.git synced 2026-01-29 13:29:20 +00:00
thatmattlove-hyperglass/docs
Wilhelm Schonfeldt 4a1057651f
feat: comprehensive IP enrichment and traceroute improvements
MAJOR ENHANCEMENTS:

IP Enrichment Service (hyperglass/external/ip_enrichment.py):
- Increase IXP data cache duration from 24 hours to 7 days (604800s) for better performance
- Fix critical cache refresh logic: ensure_data_loaded() now properly checks expiry before using existing pickle files
- Remove 'force' refresh parameters from public APIs and admin endpoints to prevent potential abuse/DDOS
- Implement automatic refresh based on file timestamps and cache duration
- Add comprehensive debug logging gated by Settings.debug throughout the module
- Clean up verbose comments and improve code readability
- Update configuration model to enforce 7-day minimum cache timeout

MikroTik Traceroute Processing:
- Refactor trace_route_mikrotik plugin to use garbage cleaner before structured parsing
- Only log raw router output when Settings.debug is enabled to reduce log verbosity
- Simplify MikrotikTracerouteTable parser to expect pre-cleaned input from garbage cleaner
- Remove complex multi-table detection, format detection, and deduplication logic (handled by cleaner)
- Add concise debug messages for processing decisions and configuration states

Traceroute IP Enrichment (traceroute_ip_enrichment.py):
- Implement concurrent reverse DNS lookups using asyncio.to_thread and asyncio.gather
- Add async wrapper for reverse DNS with proper error handling and fallbacks
- Significant performance improvement for multi-hop traceroutes (parallel vs sequential DNS)
- Proper debug logging gates: only detailed logs when Settings.debug=True
- Upgrade operational messages to log.info level (start/completion status)
- Maintain compatibility with different event loop contexts and runtime environments

Configuration Updates:
- Update structured.ip_enrichment.cache_timeout default to 604800 seconds
- Update documentation to reflect new cache defaults and behavior
- Remove force refresh options from admin API endpoints

MIGRATION NOTES:
- Operators should ensure /etc/hyperglass/ip_enrichment directory is writable
- Any code relying on force refresh parameters must be updated
- Monitor logs for automatic refresh behavior and performance improvements
- The 7-day cache significantly reduces PeeringDB API load

PERFORMANCE BENEFITS:
- Faster traceroute enrichment due to concurrent DNS lookups
- Reduced external API calls with longer IXP cache duration
- More reliable refresh logic prevents stale cache usage
- Cleaner, more focused debug output when debug mode is disabled

TECHNICAL DETAILS:
- Uses asyncio.to_thread for non-blocking DNS operations
- Implements process-wide file locking for safe concurrent cache updates
- Robust fallbacks for various asyncio execution contexts
- Maintains backward compatibility while improving performance

FILES MODIFIED:
- hyperglass/external/ip_enrichment.py
- hyperglass/models/config/structured.py
- hyperglass/api/routes.py
- hyperglass/plugins/_builtin/trace_route_mikrotik.py
- hyperglass/models/parsing/mikrotik.py
- hyperglass/plugins/_builtin/traceroute_ip_enrichment.py
- docs/pages/configuration/config/structured-output.mdx
2025-10-05 21:25:58 +02:00
..
components update docs 2024-03-25 00:01:16 -04:00
pages feat: comprehensive IP enrichment and traceroute improvements 2025-10-05 21:25:58 +02:00
public clean up unused parameters and start work on 2.0.0 docs 2022-12-12 18:52:39 -05:00
.gitignore include changelog with docs 2024-05-28 14:56:28 -04:00
favicon-formats.ts update docs backend 2024-05-28 21:30:33 -04:00
global.d.ts add noindex nofollow tags to docs 2022-12-19 15:11:39 -05:00
global.module.css clean up unused parameters and start work on 2.0.0 docs 2022-12-12 18:52:39 -05:00
next-env.d.ts clean up unused parameters and start work on 2.0.0 docs 2022-12-12 18:52:39 -05:00
next.config.mjs update docs backend 2024-05-28 21:30:33 -04:00
package.json update docs backend 2024-05-28 21:30:33 -04:00
platforms.json update docs & examples 2024-03-20 00:57:11 -04:00
pnpm-lock.yaml update docs backend 2024-05-28 21:30:33 -04:00
theme.config.tsx fix docs opengraph tags 2024-05-28 21:35:58 -04:00
tsconfig.json update docs backend 2024-05-28 21:30:33 -04:00