Simple dashboard to visualize ERDDAP usage metrics from log files
Project description
Simple ERDDAP Metrics
Simple ERDDAP Metrics is a lightweight tool to analyze ERDDAP server log files and visualize usage metrics through an interactive dashboard or export the parsed data as CSV.
Features
- Parse ERDDAP log files automatically
- Detect dataset views and downloads
- Track file formats used
- Aggregate usage statistics (daily, monthly, yearly)
- Optional IP geolocation
- Interactive dashboard
- CSV export via CLI
- User-configurable formats and endpoints via YAML configuration
[!IMPORTANT] This project is currently in beta and requires additional testing with large ERDDAP log archives.
Installation
The package can be installed with:
pip install simple-erddap-metrics
YAML Configuration File
Users can customize parsing behavior through a YAML configuration file.
Fields
data_formats: Defines which file extensions count as downloads (e.g., .csv, .nc). If a request uses one of these formats, it is classified as a download.system_endpoints: Defines ERDDAP internal endpoints that should be ignored (e.g., index, documentation). These are not counted as dataset interactions.
Command Line Interface
The tool can be used either to launch the interactive dashboard or to export parsed logs to CSV.
Interactive dashboard mode
Launch the dashboard:
simple-erddap-metrics
This will start the Streamlit interface.
Export mode
Export parsed logs to CSV:
simple-erddap-metrics -e -l ./logs
This will generate the out.csv file.
CLI Arguments
| Argument | Required | Description |
|---|---|---|
-l, --logs |
in export mode | Directory containing ERDDAP log files |
-e, --export |
optional | Export parsed logs to CSV |
-c, --config |
optional | YAML configuration file |
--enable-geo |
optional | Enable IP geolocation |
Expected Log Files
The parser expects ERDDAP access logs such as:
log.txt
logArchivedAt...
logPreviousArchivedAt...
All files starting with log will be parsed.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file simple_erddap_metrics-0.1.1.tar.gz.
File metadata
- Download URL: simple_erddap_metrics-0.1.1.tar.gz
- Upload date:
- Size: 22.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3e63ac429368fa1e29522583d5797415f4fba5da5f6f1ae30bf8f31ddaae1779
|
|
| MD5 |
d3d6ee562abe4612f4204af85ff70a71
|
|
| BLAKE2b-256 |
e5ee8d9cd239d8cfdf3a80689ea163a802ec951f28441a326e4f0a3d3b2bf108
|
File details
Details for the file simple_erddap_metrics-0.1.1-py3-none-any.whl.
File metadata
- Download URL: simple_erddap_metrics-0.1.1-py3-none-any.whl
- Upload date:
- Size: 24.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0afbe6ddde14c8cba4c6816a22e7dc478a792225e3c07c1b673f00ad08be0d73
|
|
| MD5 |
2f74960be1b08e3af281019f71ee1b61
|
|
| BLAKE2b-256 |
e04c163f81d618651b17cc5c43a1419a91541686c3fc94699c1aa04e1c274388
|