Welcome to MetricQ’s documentation!

Contents:

• How to use this library
  • Building a MetricQ Sink
    • Defining a new Sink: using metricq.Sink
    • Running a Sink
    • Complete example
    • Durable / persistent sinks
  • Building a MetricQ Source
    • Defining a new Source: using metricq.Source
    • Improving constant-rate sources: using IntervalSource
    • Running a Source
    • Complete Example
  • Fetching historical metric data
    • Connecting to the network
    • Fetching metric metadata
    • Getting the last value of a metric
    • Aggregates – summarizing a metric
    • Multiple aggregates
    • Fetching raw values
    • Getting Pandas DataFrames
  • Building a MetricQ Drain
    • What is a Drain?
    • Subscribe to metrics
    • Stop the measurement and receive the buffered metric data
  • Metric lookup
    • Search by regex
    • Search by prefix/infix
  • Creating a new project for MetricQ
    • Dependencies, building and installation
    • Command line interfaces
    • Project versioning
    • Development setup
• API Reference
  • Sink
    • Sink
    • DurableSink
  • Source
    • Source
    • IntervalSource
    • SynchronousSource
  • History Client
    • HistoryClient
    • HistoryRequestType
    • HistoryResponse
    • HistoryResponseType
    • InvalidHistoryResponse
  • Pandas History Client
    • PandasHistoryClient
  • Drain
    • Drain
  • Subscriber
    • Subscriber
  • Common client operation
    • Client
    • DataClient
    • Agent
  • Exceptions
    • AgentStopped
    • ConnectFailed
    • HistoryError
    • InvalidHistoryResponse
    • MessageError
    • NonMonotonicTimestamps
    • PublishFailed
    • RPCError
    • ReceivedSignal
    • ReconnectTimeout
    • RemoteError
  • Miscellaneous
    • Timestamps
    • Timedeltas (Durations)
    • Time-value pairs and aggregates
    • Helper types
    • RPC handling
  • CLI
    • Decorators
    • Parameter
• Metric Metadata
  • Reserved Fields
  • Standardized Fields
• Upgrading metricq
  • 1.x → 2.0
    • Changed required Python version to 3.8
    • Location of exception classes
    • Removed exceptions
    • Validation of Source chunk sizes
    • Removal of previously deprecated methods
    • Type changes to reduce ambiguity
    • Deprecation of TimeAggregate.integral
  • 2.x → 3.0
    • Removal of TimeAggregate.integral
  • 3.x → 4.0
    • Dropping support for older Python versions
    • Removal of Asyncio Loop
  • 4.x → 5.0
    • Removing internal types module
    • Return value of get_metrics
    • Deprecation of dict methods
    • Agent management_url renamed to url
    • Agent stop / _close
    • Internal Agent changes
    • Renaming of setup.py options
• Glossary

Quickstart

Installation

Install metricq from PyPI:

$ pip install metricq

Upgrading from an older version

See Upgrading metricq for instruction on how to upgrade to a newer version of this library.

Indices and tables

• Index

• Module Index

• Search Page

• Glossary