https://github.com/xmidt-org/touchstone

https://github.com/xmidt-org/touchstone

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/xmidt-org/touchstone
• Owner: xmidt-org
• License: apache-2.0
• Created: 2021-03-17T00:04:44.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2025-03-14T16:24:33.000Z (2 months ago)
• Last Synced: 2025-03-23T12:32:54.439Z (2 months ago)
• Language: Go
• Size: 412 KB
• Stars: 0
• Watchers: 12
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# touchstone

Touchstone is an integration between go.uber.org/fx and prometheus.

[![Build Status](https://github.com/xmidt-org/touchstone/actions/workflows/ci.yml/badge.svg)](https://github.com/xmidt-org/touchstone/actions/workflows/ci.yml)

[![codecov.io](http://codecov.io/github/xmidt-org/touchstone/coverage.svg?branch=main)](http://codecov.io/github/xmidt-org/touchstone?branch=main)

[![Go Report Card](https://goreportcard.com/badge/github.com/xmidt-org/touchstone)](https://goreportcard.com/report/github.com/xmidt-org/touchstone)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xmidt-org_touchstone&metric=alert_status)](https://sonarcloud.io/dashboard?id=xmidt-org_touchstone)

[![Apache V2 License](http://img.shields.io/badge/license-Apache%20V2-blue.svg)](https://github.com/xmidt-org/touchstone/blob/main/LICENSE)

[![GitHub Release](https://img.shields.io/github/release/xmidt-org/touchstone.svg)](CHANGELOG.md)

[![GoDoc](https://pkg.go.dev/badge/github.com/xmidt-org/touchstone)](https://pkg.go.dev/github.com/xmidt-org/touchstone)

## Summary

Touchstone provides easy bootstrapping of a prometheus client environment within a go.uber.org/fx application container.  Key features include:

- External configuration that can drive how the Registry and other components are initialized

- Simple constructors that allow individual metrics to fully participate in dependency injection

- Prebundled HTTP metrics with a simpler and more efficient instrumentation than what promhttp provides

## Table of Contents

- [Code of Conduct](#code-of-conduct)

- [Details](#details)

- [Install](#install)

- [Contributing](#contributing)

## Code of Conduct

This project and everyone participating in it are governed by the [XMiDT Code Of Conduct](https://xmidt.io/code_of_conduct/). 

By participating, you agree to this Code.

## Install

go get -u github.com/xmidt-org/touchstone

## Contributing

Refer to [CONTRIBUTING.md](CONTRIBUTING.md).