Metadata-Version: 2.4
Name: moat-link-metrics
Version: 0.0.6
Summary: Metrics time-series connector for MoaT-Link
Author-email: Matthias Urlichs <matthias@urlichs.de>
Project-URL: homepage, https://m-o-a-t.org
Project-URL: repository, https://github.com/M-o-a-T/moat
Keywords: MoaT
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Framework :: AsyncIO
Classifier: Framework :: Trio
Classifier: Framework :: AnyIO
Classifier: Development Status :: 4 - Beta
Requires-Python: >=3.13
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: anyio~=4.2
Requires-Dist: asyncclick~=8.3
Requires-Dist: attrs
Requires-Dist: moat-util~=0.63.0
Requires-Dist: moat-link~=0.6.0
Requires-Dist: moat-lib-config~=0.2.0
Provides-Extra: akumuli
Requires-Dist: moat-link-metrics-akumuli~=0.0.1; extra == "akumuli"
Provides-Extra: victoria
Requires-Dist: moat-link-metrics-victoria~=0.0.1; extra == "victoria"
Dynamic: license-file

# Metrics time-series connector

% start synopsis
Forwards MoaT-Link values to metrics time-series storage backends.
% end synopsis

% start main

This module watches MoaT-Link entries and writes their values to metrics backends
whenever they change. It replaces the legacy ``moat-kv-akumuli`` and ``moat-link-akumuli`` packages.

## Features

- Pluggable backend support (currently: Akumuli)
- Per-server configuration stored in MoaT-Link
- Dynamic series management: add, remove, or modify series at runtime
- Configurable scaling (factor/offset) and rate limiting (t_min)
- Attribute extraction from nested source values

## Quick start

1. Configure a metrics server:

   ```shell
   moat link metrics add myserver my.entry source.path series_name host=myhost
   ```

2. Run the connector:

   ```shell
   moat link metrics monitor myserver
   ```

## Backends

The default backend is Akumuli. To specify a different backend, set the `backend`
field in the server configuration to the backend module name (e.g., `akumuli`).

## Deprecation

This package supersedes ``moat-kv-akumuli`` and ``moat-link-akumuli``.  The raw
MQTT topic monitoring feature has been removed; use MoaT-Link's native data paths instead.

% end main
