client_golang/README.md

31 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2012-05-20 01:59:25 +04:00
# Overview
This is the [Prometheus](http://www.prometheus.io)
[Go](http://golang.org) client library. It provides several distinct
functions, and there is separate documentation for each respective
component. You will want to select the appropriate topic below to
continue your journey:
2012-05-20 01:59:25 +04:00
1. See the [exposition library](prometheus/README.md) if you want to
export metrics to a Prometheus server or pushgateway
2012-05-20 01:59:25 +04:00
2. See the [consumption library](https://godoc.org/github.com/prometheus/client_golang/extraction) if you want to
process metrics exported by a Prometheus client. (The Prometheus server
is using that library.)
2012-05-20 01:59:25 +04:00
[![GoDoc](https://godoc.org/github.com/prometheus/client_golang?status.png)](https://godoc.org/github.com/prometheus/client_golang)
# Getting Started
* The source code is periodically indexed: [Go Exposition Client](http://godoc.org/github.com/prometheus/client_golang).
* All of the core developers are accessible via the [Prometheus Developers Mailinglist](https://groups.google.com/forum/?fromgroups#!forum/prometheus-developers).
2012-05-20 01:59:25 +04:00
# Testing
$ go test ./...
# Continuous Integration
[![Build Status](https://secure.travis-ci.org/prometheus/client_golang.png?branch=master)]()
## Contributing
2015-01-22 18:13:15 +03:00
See the [contributing guidelines](CONTRIBUTING.md).