gitee.com/ks-custle/core-gm@v0.0.0-20230922171213-b83bdd97b62c/thrid_licenses/github.com/prometheus/client_golang/README.md (about)

     1  # Prometheus Go client library
     2  
     3  [![Build Status](https://travis-ci.org/prometheus/client_golang.svg?branch=master)](https://travis-ci.org/prometheus/client_golang)
     4  [![Go Report Card](https://goreportcard.com/badge/github.com/prometheus/client_golang)](https://goreportcard.com/report/github.com/prometheus/client_golang)
     5  [![go-doc](https://godoc.org/github.com/prometheus/client_golang?status.svg)](https://godoc.org/github.com/prometheus/client_golang)
     6  
     7  This is the [Go](http://golang.org) client library for
     8  [Prometheus](http://prometheus.io). It has two separate parts, one for
     9  instrumenting application code, and one for creating clients that talk to the
    10  Prometheus HTTP API.
    11  
    12  __This library requires Go1.13 or later.__
    13  
    14  ## Important note about releases and stability
    15  
    16  This repository generally follows [Semantic
    17  Versioning](https://semver.org/). However, the API client in
    18  prometheus/client_golang/api/… is still considered experimental. Breaking
    19  changes of the API client will _not_ trigger a new major release. The same is
    20  true for selected other new features explicitly marked as **EXPERIMENTAL** in
    21  CHANGELOG.md.
    22  
    23  Features that require breaking changes in the stable parts of the repository
    24  are being batched up and tracked in the [v2
    25  milestone](https://github.com/prometheus/client_golang/milestone/2). The v2
    26  development happens in a [separate
    27  branch](https://github.com/prometheus/client_golang/tree/dev-v2) for the time
    28  being. v2 releases off that branch will happen once sufficient stability is
    29  reached. In view of the widespread use of this repository, v1 and v2 will
    30  coexist for a while to enable a convenient transition.
    31  
    32  ## Instrumenting applications
    33  
    34  [![code-coverage](http://gocover.io/_badge/github.com/prometheus/client_golang/prometheus)](http://gocover.io/github.com/prometheus/client_golang/prometheus) [![go-doc](https://godoc.org/github.com/prometheus/client_golang/prometheus?status.svg)](https://godoc.org/github.com/prometheus/client_golang/prometheus)
    35  
    36  The
    37  [`prometheus` directory](https://github.com/prometheus/client_golang/tree/master/prometheus)
    38  contains the instrumentation library. See the
    39  [guide](https://prometheus.io/docs/guides/go-application/) on the Prometheus
    40  website to learn more about instrumenting applications.
    41  
    42  The
    43  [`examples` directory](https://github.com/prometheus/client_golang/tree/master/examples)
    44  contains simple examples of instrumented code.
    45  
    46  ## Client for the Prometheus HTTP API
    47  
    48  [![code-coverage](http://gocover.io/_badge/github.com/prometheus/client_golang/api/prometheus/v1)](http://gocover.io/github.com/prometheus/client_golang/api/prometheus/v1) [![go-doc](https://godoc.org/github.com/prometheus/client_golang/api/prometheus?status.svg)](https://godoc.org/github.com/prometheus/client_golang/api)
    49  
    50  The
    51  [`api/prometheus` directory](https://github.com/prometheus/client_golang/tree/master/api/prometheus)
    52  contains the client for the
    53  [Prometheus HTTP API](http://prometheus.io/docs/querying/api/). It allows you
    54  to write Go applications that query time series data from a Prometheus
    55  server. It is still in alpha stage.
    56  
    57  ## Where is `model`, `extraction`, and `text`?
    58  
    59  The `model` packages has been moved to
    60  [`prometheus/common/model`](https://github.com/prometheus/common/tree/master/model).
    61  
    62  The `extraction` and `text` packages are now contained in
    63  [`prometheus/common/expfmt`](https://github.com/prometheus/common/tree/master/expfmt).
    64  
    65  ## Contributing and community
    66  
    67  See the [contributing guidelines](CONTRIBUTING.md) and the
    68  [Community section](http://prometheus.io/community/) of the homepage.