bda3c861b9
- Add python/tests/test_ntopng_sdk.py with 86 unit tests covering:
- Ntopng: constructor (auth_token / user+pass), request/post_request wrappers,
all getter methods, debug flag, URL building
- Interface: all data, alert, flow, L7/L4 and host methods
- Host: get_host_data, get_l7_stats, get_dscp_stats (both directions), VLAN handling
- Historical: all alert family delegates, timeseries, flows, conversations
- Fix bug in historical.py get_host_top_protocols(): self.ifid (int) was
concatenated with strings without str() conversion, causing TypeError at runtime
- Add scripts/lua/modules/timeseries/tests/ts_common_test.lua with 11 test cases:
- upsampleSerie: no-op when target <= source length, empty serie
- calculateMinMax: basic, single element, NaN-skipping
- calculateStatistics: counter (total*step), gauge+keep_total, gauge no-total, NaN-skipping
- ninetififthPercentile: single element, all-NaN
- Register ts_common_test in the Lua test runner (run.lua)
Agent-Logs-Url: https://github.com/ntop/ntopng/sessions/32da23c3-306c-4100-9bbe-64b91191653b
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: lucaderi <4493366+lucaderi@users.noreply.github.com>
|
||
|---|---|---|
| .. | ||
| docs | ||
| examples | ||
| ntopng | ||
| tests | ||
| __init__.py.in | ||
| Makefile | ||
| README.md | ||
| requirements.txt | ||
| setup.py.in | ||
| test.py | ||
Python API
This directory contains the Python 3.x API for querying ntopng using the Python language.
This API is based on ntopng's REST API and it allows users to perform operations such as:
- Read host statistics
- Get the active flows list
- Query network interface stats and time series
- Search historical data including alerts and flows
Prerequisites
The API is using Pandas and NumPy for working with time series data, plotly and fpdf for generating reports in PDF format. The examples are using additional modules, including redmail for sending reports by email.
In order to install prerequisites please do
pip3 install -r requirements.txt
API Information
For each ntopng REST API call there is a corresponding Python method for the defined Python classes:
The ntopng class is used to store information such as ntopng IP address and credentials used to connect it.
The test application can be used as example of the Python API
Installation
For you convenience, ntop periodically builds pip packages. You can install the latest available package as:
pip3 install ntopng
Developing the Python API
We encourage our users to extend this API. For your convenience we are sharing a Makefile that you can use as skeleton for installing the package locally or creating test packages.
The Makefile can be also used to update the upstream library. The build and twine modules are required.
pip install build twinemake upload
Documentation
For detailed documentation on each API class please visit:
For further information please visit the API documentation available at: