Metrics

Capture metrics about code execution in a vendor agnostic way. As the author of many libraries which would benefit from metrics, there are few key priorities: (1) zero overhead if metrics are disabled, minimal overhead if enabled, and (2) a small and opinionated interface with standardised semantics.

Features

Zero-overhead if tracing is disabled and minimal overhead if enabled.
Small opinionated interface with standardised semantics.

Usage

Please browse the source code index or refer to the guides below.

Getting Started

This guide explains how to use metrics for capturing run-time metrics.

Capture

This guide explains how to use metrics for exporting metric definitions from your application.

Testing

This guide explains how to write assertions in your test suite to validate metrics are being emitted correctly.

Releases

Please browse the releases for more details.

v0.12.1

Introduce Metrics::Config to Expose prepare Hook

Contributing

We welcome contributions to this project.

Fork it.
Create your feature branch (git checkout -b my-new-feature).
Commit your changes (git commit -am 'Add some feature').
Push to the branch (git push origin my-new-feature).
Create new Pull Request.

Developer Certificate of Origin

In order to protect users of this project, we require all contributors to comply with the Developer Certificate of Origin. This ensures that all contributions are properly licensed and attributed.

Community Guidelines

This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.