go: github.com/prometheus/client_golang

• Homepage: https://github.com/prometheus/client_golang
• Documentation: https://pkg.go.dev/github.com/prometheus/client_golang#section-documentation
• Licenses: Apache-2.0
• Latest release: v1.18.0 (published 11 months ago)
• Last Synced: 2024-11-11T01:18:06.894Z (2 days ago)
• Versions: 44
• Dependent Packages: 36,473
• Dependent Repositories: 107,337
• Docker Downloads: 71,621,389,002
• Rankings:
  • Docker downloads count: 0.002%
  • Dependent packages count: 0.003%
  • Dependent repos count: 0.009%
  • Average: 0.366%
  • Forks count: 0.824%
  • Stargazers count: 0.993%
• Advisories:
  • Uncontrolled Resource Consumption in promhttp

go: github.com/prometheus/client_golang/prometheus/internal

Copyright (c) 2015 Björn Rabenstein Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. The code in this package is copy/paste to avoid a dependency. Hence this file carries the copyright of the original repo. https://github.com/beorn7/floats Copyright 2022 The Prometheus Authors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. It provides tools to compare sequences of strings and generate textual diffs. Maintaining `GetUnifiedDiffString` here because original repository (https://github.com/pmezard/go-difflib) is no longer maintained.

• Homepage: https://github.com/prometheus/client_golang
• Documentation: https://pkg.go.dev/github.com/prometheus/client_golang/prometheus/internal#section-documentation
• Licenses: Apache-2.0
• Latest release:
• Last Synced: 2024-11-09T00:07:49.431Z (4 days ago)
• Versions: 0
• Dependent Packages: 0
• Dependent Repositories: 0
• Rankings:
  • Forks count: 0.713%
  • Stargazers count: 0.84%
  • Average: 3.567%
  • Dependent packages count: 6.151%
  • Dependent repos count: 6.563%

go: github.com/Prometheus/client_golang

• Homepage: https://github.com/Prometheus/client_golang
• Documentation: https://pkg.go.dev/github.com/Prometheus/client_golang#section-documentation
• Licenses: Apache-2.0
• Latest release: v1.19.1 (published 6 months ago)
• Last Synced: 2024-11-11T01:17:59.490Z (2 days ago)
• Versions: 43
• Dependent Packages: 0
• Dependent Repositories: 0
• Rankings:
  • Forks count: 0.583%
  • Stargazers count: 0.624%
  • Average: 4.388%
  • Dependent packages count: 6.999%
  • Dependent repos count: 9.346%

go: github.com/prometheus/client_goLang

• Homepage: https://github.com/prometheus/client_goLang
• Documentation: https://pkg.go.dev/github.com/prometheus/client_goLang#section-documentation
• Licenses: Apache-2.0
• Latest release: v1.19.1 (published 6 months ago)
• Last Synced: 2024-11-11T01:18:00.607Z (2 days ago)
• Versions: 43
• Dependent Packages: 0
• Dependent Repositories: 0
• Rankings:
  • Forks count: 0.583%
  • Stargazers count: 0.624%
  • Average: 4.388%
  • Dependent packages count: 6.999%
  • Dependent repos count: 9.346%

go: github.com/prometheus/Client_golang

• Homepage: https://github.com/prometheus/Client_golang
• Documentation: https://pkg.go.dev/github.com/prometheus/Client_golang#section-documentation
• Licenses: Apache-2.0
• Latest release: v1.19.1 (published 6 months ago)
• Last Synced: 2024-11-11T01:18:04.836Z (2 days ago)
• Versions: 43
• Dependent Packages: 0
• Dependent Repositories: 0
• Rankings:
  • Forks count: 0.583%
  • Stargazers count: 0.624%
  • Average: 4.388%
  • Dependent packages count: 6.999%
  • Dependent repos count: 9.346%

go: github.com/prometheus/client_Golang

• Homepage: https://github.com/prometheus/client_Golang
• Documentation: https://pkg.go.dev/github.com/prometheus/client_Golang#section-documentation
• Licenses: Apache-2.0
• Latest release: v1.19.1 (published 6 months ago)
• Last Synced: 2024-11-11T01:18:17.460Z (2 days ago)
• Versions: 43
• Dependent Packages: 0
• Dependent Repositories: 0
• Rankings:
  • Forks count: 0.583%
  • Stargazers count: 0.624%
  • Average: 4.388%
  • Dependent packages count: 6.999%
  • Dependent repos count: 9.346%

go: github.com/prometheus/client_golang/prometheus

Package prometheus is the core instrumentation package. It provides metrics primitives to instrument code for monitoring. It also offers a registry for metrics. Sub-packages allow to expose the registered metrics via HTTP (package promhttp) or push them to a Pushgateway (package push). There is also a sub-package promauto, which provides metrics constructors with automatic registration. All exported functions and methods are safe to be used concurrently unless specified otherwise. As a starting point, a very basic usage example: This is a complete program that exports two metrics, a Gauge and a Counter, the latter with a label attached to turn it into a (one-dimensional) vector. It register the metrics using a custom registry and exposes them via an HTTP server on the /metrics endpoint. The number of exported identifiers in this package might appear a bit overwhelming. However, in addition to the basic plumbing shown in the example above, you only need to understand the different metric types and their vector versions for basic usage. Furthermore, if you are not concerned with fine-grained control of when and how to register metrics with the registry, have a look at the promauto package, which will effectively allow you to ignore registration altogether in simple cases. Above, you have already touched the Counter and the Gauge. There are two more advanced metric types: the Summary and Histogram. A more thorough description of those four metric types can be found in the Prometheus docs: https://prometheus.io/docs/concepts/metric_types/ In addition to the fundamental metric types Gauge, Counter, Summary, and Histogram, a very important part of the Prometheus data model is the partitioning of samples along dimensions called labels, which results in metric vectors. The fundamental types are GaugeVec, CounterVec, SummaryVec, and HistogramVec. While only the fundamental metric types implement the Metric interface, both the metrics and their vector versions implement the Collector interface. A Collector manages the collection of a number of Metrics, but for convenience, a Metric can also “collect itself”. Note that Gauge, Counter, Summary, and Histogram are interfaces themselves while GaugeVec, CounterVec, SummaryVec, and HistogramVec are not. To create instances of Metrics and their vector versions, you need a suitable …Opts struct, i.e. GaugeOpts, CounterOpts, SummaryOpts, or HistogramOpts. While you could create your own implementations of Metric, most likely you will only ever implement the Collector interface on your own. At a first glance, a custom Collector seems handy to bundle Metrics for common registration (with the prime example of the different metric vectors above, which bundle all the metrics of the same name but with different labels). There is a more involved use case, too: If you already have metrics available, created outside of the Prometheus context, you don't need the interface of the various Metric types. You essentially want to mirror the existing numbers into Prometheus Metrics during collection. An own implementation of the Collector interface is perfect for that. You can create Metric instances “on the fly” using NewConstMetric, NewConstHistogram, and NewConstSummary (and their respective Must… versions). NewConstMetric is used for all metric types with just a float64 as their value: Counter, Gauge, and a special “type” called Untyped. Use the latter if you are not sure if the mirrored metric is a Counter or a Gauge. Creation of the Metric instance happens in the Collect method. The Describe method has to return separate Desc instances, representative of the “throw-away” metrics to be created later. NewDesc comes in handy to create those Desc instances. Alternatively, you could return no Desc at all, which will mark the Collector “unchecked”. No checks are performed at registration time, but metric consistency will still be ensured at scrape time, i.e. any inconsistencies will lead to scrape errors. Thus, with unchecked Collectors, the responsibility to not collect metrics that lead to inconsistencies in the total scrape result lies with the implementer of the Collector. While this is not a desirable state, it is sometimes necessary. The typical use case is a situation where the exact metrics to be returned by a Collector cannot be predicted at registration time, but the implementer has sufficient knowledge of the whole system to guarantee metric consistency. The Collector example illustrates the use case. You can also look at the source code of the processCollector (mirroring process metrics), the goCollector (mirroring Go metrics), or the expvarCollector (mirroring expvar metrics) as examples that are used in this package itself. If you just need to call a function to get a single float value to collect as a metric, GaugeFunc, CounterFunc, or UntypedFunc might be interesting shortcuts. While MustRegister is the by far most common way of registering a Collector, sometimes you might want to handle the errors the registration might cause. As suggested by the name, MustRegister panics if an error occurs. With the Register function, the error is returned and can be handled. An error is returned if the registered Collector is incompatible or inconsistent with already registered metrics. The registry aims for consistency of the collected metrics according to the Prometheus data model. Inconsistencies are ideally detected at registration time, not at collect time. The former will usually be detected at start-up time of a program, while the latter will only happen at scrape time, possibly not even on the first scrape if the inconsistency only becomes relevant later. That is the main reason why a Collector and a Metric have to describe themselves to the registry. So far, everything we did operated on the so-called default registry, as it can be found in the global DefaultRegisterer variable. With NewRegistry, you can create a custom registry, or you can even implement the Registerer or Gatherer interfaces yourself. The methods Register and Unregister work in the same way on a custom registry as the global functions Register and Unregister on the default registry. There are a number of uses for custom registries: You can use registries with special properties, see NewPedanticRegistry. You can avoid global state, as it is imposed by the DefaultRegisterer. You can use multiple registries at the same time to expose different metrics in different ways. You can use separate registries for testing purposes. Also note that the DefaultRegisterer comes registered with a Collector for Go runtime metrics (via NewGoCollector) and a Collector for process metrics (via NewProcessCollector). With a custom registry, you are in control and decide yourself about the Collectors to register. The Registry implements the Gatherer interface. The caller of the Gather method can then expose the gathered metrics in some way. Usually, the metrics are served via HTTP on the /metrics endpoint. That's happening in the example above. The tools to expose metrics via HTTP are in the promhttp sub-package. Function for pushing to the Pushgateway can be found in the push sub-package. Functions and examples to push metrics from a Gatherer to Graphite can be found in the graphite sub-package. More ways of exposing metrics can easily be added by following the approaches of the existing implementations.

• Homepage: https://github.com/prometheus/client_golang
• Documentation: https://pkg.go.dev/github.com/prometheus/client_golang/prometheus#section-documentation
• Licenses: Apache-2.0
• Latest release:
• Last Synced: 2024-11-09T00:07:45.044Z (4 days ago)
• Versions: 0
• Dependent Packages: 0
• Dependent Repositories: 0
• Rankings:
  • Dependent packages count: 6.151%
  • Average: 6.357%
  • Dependent repos count: 6.563%

go: github.com/prometheus/client_golang/prometheus/promhttp

Package promhttp provides tooling around HTTP servers and clients. First, the package allows the creation of http.Handler instances to expose Prometheus metrics via HTTP. promhttp.Handler acts on the prometheus.DefaultGatherer. With HandlerFor, you can create a handler for a custom registry or anything that implements the Gatherer interface. It also allows the creation of handlers that act differently on errors or allow to log errors. Second, the package provides tooling to instrument instances of http.Handler via middleware. Middleware wrappers follow the naming scheme InstrumentHandlerX, where X describes the intended use of the middleware. See each function's doc comment for specific details. Finally, the package allows for an http.RoundTripper to be instrumented via middleware. Middleware wrappers follow the naming scheme InstrumentRoundTripperX, where X describes the intended use of the middleware. See each function's doc comment for specific details.

• Homepage: https://github.com/prometheus/client_golang
• Documentation: https://pkg.go.dev/github.com/prometheus/client_golang/prometheus/promhttp#section-documentation
• Licenses: Apache-2.0
• Latest release:
• Last Synced: 2024-11-09T00:07:46.984Z (4 days ago)
• Versions: 0
• Dependent Packages: 0
• Dependent Repositories: 0
• Rankings:
  • Dependent packages count: 6.151%
  • Average: 6.357%
  • Dependent repos count: 6.563%

go: github.com/prometheus/client_golang/tutorials/whatsup

• Homepage: https://github.com/prometheus/client_golang
• Documentation: https://pkg.go.dev/github.com/prometheus/client_golang/tutorials/whatsup#section-documentation
• Licenses: Apache-2.0
• Latest release:
• Last Synced: 2024-11-08T05:18:32.032Z (5 days ago)
• Versions: 0
• Dependent Packages: 0
• Dependent Repositories: 0
• Rankings:
  • Dependent packages count: 6.226%
  • Average: 6.435%
  • Dependent repos count: 6.643%

go: github.com/prometheus/client_golang/examples/middleware

• Homepage: https://github.com/prometheus/client_golang
• Documentation: https://pkg.go.dev/github.com/prometheus/client_golang/examples/middleware#section-documentation
• Licenses: Apache-2.0
• Latest release: (published 6 months ago)
• Last Synced: 2024-11-09T00:07:47.673Z (4 days ago)
• Versions: 0
• Dependent Packages: 0
• Dependent Repositories: 0
• Rankings:
  • Dependent packages count: 7.054%
  • Average: 7.505%
  • Dependent repos count: 7.956%