Merge branch 'main' into sparsehistogram

Author: beorn7

.circleci/config.yml

@@ -1,7 +1,7 @@
 version: 2.1
 orbs:
-  go: circleci/go@0.2.0
-  prometheus: prometheus/prometheus@0.15.0
+  go: circleci/go@1.7.1
+  prometheus: prometheus/prometheus@0.16.0
 jobs:
   test:
     parameters:
@@ -17,8 +17,7 @@ jobs:
         type: boolean
         default: true
     docker:
-      - image: circleci/golang:<< parameters.go_version >>
-    working_directory: /go/src/github.com/prometheus/client_golang
+      - image: cimg/go:<< parameters.go_version >>
     steps:
       - checkout
       - when:
@@ -47,18 +46,6 @@ workflows:
   client_golang:
     jobs:
       # Refer to README.md for the currently supported versions.
-      - test:
-          name: go-1-13
-          go_version: "1.13"
-          run_lint: true
-      - test:
-          name: go-1-14
-          go_version: "1.14"
-          run_lint: true
-      - test:
-          name: go-1-15
-          go_version: "1.15"
-          run_lint: true
       - test:
           name: go-1-16
           go_version: "1.16"
@@ -67,4 +54,10 @@ workflows:
           name: go-1-17
           go_version: "1.17"
           run_lint: true
+      - test:
+          name: go-1-18
+          go_version: "1.18"
+          run_lint: true
+          # Style and unused/missing packages are only checked against
+          # the latest supported Go version.
           run_style_and_unused: true

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "gomod"
+    directory: "/"
+    schedule:
+      interval: "monthly"

.github/stale.yml

@@ -0,0 +1,88 @@
+# Configuration for probot-stale - https://github.com/probot/stale
+
+# Number of days of inactivity before an Issue or Pull Request becomes stale
+# daysUntilStale: 30
+
+# Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
+# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
+# daysUntilClose: 7
+
+# NOTICE: Check below for the individual settings for each type of event.
+
+# Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled)
+onlyLabels: []
+
+# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
+exemptLabels:
+  - pinned
+  - security
+  - keep-open
+  - wip
+  - "[Status] Maybe Later"
+
+# Set to true to ignore issues in a project (defaults to false)
+exemptProjects: true # default: false
+
+# Set to true to ignore issues in a milestone (defaults to false)
+exemptMilestones: true # default: false
+
+# Set to true to ignore issues with an assignee (defaults to false)
+exemptAssignees: false
+
+# Label to use when marking as stale
+staleLabel: stale
+
+# Comment to post when marking as stale. Set to `false` to disable
+# markComment: >
+#  This issue has been automatically marked as stale because it has not had
+#  recent activity. It will be closed if no further activity occurs. Thank you
+#  for your contributions.
+
+# Comment to post when removing the stale label.
+# unmarkComment: >
+#   Your comment here.
+
+# Comment to post when closing a stale Issue or Pull Request.
+# closeComment: >
+#   Your comment here.
+
+# Limit the number of actions per hour, from 1-30. Default is 30
+limitPerRun: 30
+
+# Limit to only `issues` or `pulls`
+# only: issues
+
+# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls':
+# pulls:
+#   daysUntilStale: 30
+#   markComment: >
+#     This pull request has been automatically marked as stale because it has not had
+#     recent activity. It will be closed if no further activity occurs. Thank you
+#     for your contributions.
+
+# issues:
+#   exemptLabels:
+#     - confirmed
+
+pull:
+  daysUntilClose: 14
+  daysUntilStale: 60
+  markComment: >
+    Hello 👋 Looks like there was no activity on this amazing PR for the last 60 days.
+    **Do you mind updating us on the status?** Is there anything we can help with? If you plan to still work on it, just comment on this PR or push a commit. Thanks! 🤗
+    
+    If there will be no activity in the next 2 weeks, this issue will be closed (we can always reopen a PR if you get back to this!).
+  # unmarkComment: No need for unmark comment.
+  closeComment: >
+    Closing for now as promised, let us know if you need this to be reopened! 🤗
+issues:
+  daysUntilClose: 90
+  daysUntilStale: 180
+  markComment: >
+    Hello 👋 Looks like there was no activity on this issue for the last 3 months.
+    **Do you mind updating us on the status?** Is this still reproducible or needed? If yes, just comment on this PR or push a commit. Thanks! 🤗
+    
+    If there will be no activity in the next 4 weeks, this issue will be closed (we can always reopen an issue if we need!).
+  # unmarkComment: No need for unmark comment.
+  closeComment: >
+    Closing for now as promised, let us know if you need this to be reopened! 🤗

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '31 21 * * 6'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'go' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/golangci-lint.yml

@@ -9,23 +9,22 @@ on:
       - ".github/workflows/golangci-lint.yml"
       - ".golangci.yml"
   pull_request:
-    paths:
-      - "go.sum"
-      - "go.mod"
-      - "**.go"
-      - "scripts/errcheck_excludes.txt"
-      - ".github/workflows/golangci-lint.yml"
-      - ".golangci.yml"
 
 jobs:
   golangci:
     name: lint
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v2
-
+        uses: actions/checkout@v3
+      - name: install Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.18.x
+      - name: Install snmp_exporter/generator dependencies
+        run: sudo apt-get update && sudo apt-get -y install libsnmp-dev
+        if: github.repository == 'prometheus/snmp_exporter'
       - name: Lint
-        uses: golangci/golangci-lint-action@v2
+        uses: golangci/golangci-lint-action@v3.1.0
         with:
-          version: v1.42.0
+          version: v1.45.2

.gitignore

@@ -1,6 +1,7 @@
 # Examples
 examples/simple/simple
 examples/random/random
+examples/gocollector/gocollector
 
 # Typical backup/temporary files of editors
 *~
@@ -11,7 +12,7 @@ examples/random/random
 vendor/
 
 # The remainder of this file is taken from
-# https://github.com/github/gitignore/blob/master/Go.gitignore
+# https://github.com/github/gitignore/blob/main/Go.gitignore
 
 # Binaries for programs and plugins
 *.exe

CHANGELOG.md

@@ -1,3 +1,17 @@
+## Unreleased
+
+* [CHANGE] Minimum required Go version is now 1.16.
+
+## 1.12.2 / 2022-05-13
+
+* [CHANGE] Added `collectors.WithGoCollections` that allows to choose what collection of Go runtime metrics user wants: Equivalent of [`MemStats` structure](https://pkg.go.dev/runtime#MemStats) configured using `GoRuntimeMemStatsCollection`, new based on dedicated [runtime/metrics](https://pkg.go.dev/runtime/metrics) metrics represented by `GoRuntimeMetricsCollection` option, or both by specifying `GoRuntimeMemStatsCollection | GoRuntimeMetricsCollection` flag.
+* [CHANGE] :warning: Change in `collectors.NewGoCollector` metrics: Reverting addition of new ~80 runtime metrics by default. You can enable this back with `GoRuntimeMetricsCollection` option or `GoRuntimeMemStatsCollection | GoRuntimeMetricsCollection` for smooth transition.
+* [BUGFIX] Fixed the bug that causes generated histogram metric names to end with `_total`. ⚠️ This changes 3 metric names in the new Go collector that was reverted from default in this release.
+  * `go_gc_heap_allocs_by_size_bytes_total` -> `go_gc_heap_allocs_by_size_bytes`,
+  * `go_gc_heap_frees_by_size_bytes_total` -> `go_gc_heap_allocs_by_size_bytes`
+  * `go_gc_pauses_seconds_total` -> `go_gc_pauses_seconds`.
+* [CHANCE] Removed `-Inf` buckets from new Go Collector histograms.
+
 ## 1.12.1 / 2022-01-29
 
 * [BUGFIX] Make the Go 1.17 collector concurrency-safe #969

CODE_OF_CONDUCT.md

@@ -1,3 +1,3 @@
-## Prometheus Community Code of Conduct
+# Prometheus Community Code of Conduct
 
-Prometheus follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
+Prometheus follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/main/code-of-conduct.md).

Dockerfile

@@ -1,7 +1,15 @@
 # This Dockerfile builds an image for a client_golang example.
 #
 # Use as (from the root for the client_golang repository):
-#    docker build -f examples/$name/Dockerfile -t prometheus/golang-example-$name .
+#    docker build -f Dockerfile -t prometheus/golang-example .
+
+# Run as
+#    docker run -P prometheus/golang-example /random
+# or
+#    docker run -P prometheus/golang-example /simple
+
+# Test as
+#    curl $ip:$port/metrics
 
 # Builder image, where we build the example.
 FROM golang:1 AS builder
@@ -13,11 +21,14 @@ WORKDIR /go/src/github.com/prometheus/client_golang/examples/random
 RUN CGO_ENABLED=0 GOOS=linux go build -a -tags netgo -ldflags '-w'
 WORKDIR /go/src/github.com/prometheus/client_golang/examples/simple
 RUN CGO_ENABLED=0 GOOS=linux go build -a -tags netgo -ldflags '-w'
+WORKDIR /go/src/github.com/prometheus/client_golang/examples/gocollector
+RUN CGO_ENABLED=0 GOOS=linux go build -a -tags netgo -ldflags '-w'
 
 # Final image.
 FROM quay.io/prometheus/busybox:latest
 LABEL maintainer="The Prometheus Authors <prometheus-developers@googlegroups.com>"
 COPY --from=builder /go/src/github.com/prometheus/client_golang/examples/random \
-    /go/src/github.com/prometheus/client_golang/examples/simple ./
+    /go/src/github.com/prometheus/client_golang/examples/simple \
+    /go/src/github.com/prometheus/client_golang/examples/gocollector ./
 EXPOSE 8080
-CMD ["echo", "Please run an example. Either /random or /simple"]
+CMD ["echo", "Please run an example. Either /random, /simple or /gocollector"]

Makefile.common

@@ -83,7 +83,7 @@ PROMU_URL     := https://github.com/prometheus/promu/releases/download/v$(PROMU_
 
 GOLANGCI_LINT :=
 GOLANGCI_LINT_OPTS ?=
-GOLANGCI_LINT_VERSION ?= v1.42.0
+GOLANGCI_LINT_VERSION ?= v1.45.2
 # golangci-lint only supports linux, darwin and windows platforms on i386/amd64.
 # windows isn't included here because of the path separator being different.
 ifeq ($(GOHOSTOS),$(filter $(GOHOSTOS),linux darwin))

README.md

@@ -1,15 +1,16 @@
 # Prometheus Go client library
 
-[![CircleCI](https://circleci.com/gh/prometheus/client_golang/tree/master.svg?style=svg)](https://circleci.com/gh/prometheus/client_golang/tree/master)
+[![CircleCI](https://circleci.com/gh/prometheus/client_golang/tree/main.svg?style=svg)](https://circleci.com/gh/prometheus/client_golang/tree/main)
 [![Go Report Card](https://goreportcard.com/badge/github.com/prometheus/client_golang)](https://goreportcard.com/report/github.com/prometheus/client_golang)
 [![Go Reference](https://pkg.go.dev/badge/github.com/prometheus/client_golang.svg)](https://pkg.go.dev/github.com/prometheus/client_golang)
+[![Slack](https://img.shields.io/badge/join%20slack-%23prometheus--client_golang-brightgreen.svg)](https://slack.cncf.io/)
 
 This is the [Go](http://golang.org) client library for
 [Prometheus](http://prometheus.io). It has two separate parts, one for
 instrumenting application code, and one for creating clients that talk to the
 Prometheus HTTP API.
 
-__This library requires Go1.13 or later.__
+__This library requires Go1.16 or later.__
 
 ## Important note about releases and stability
 
@@ -34,21 +35,21 @@ coexist for a while to enable a convenient transition.
 [![code-coverage](http://gocover.io/_badge/github.com/prometheus/client_golang/prometheus)](http://gocover.io/github.com/prometheus/client_golang/prometheus) [![Go Reference](https://pkg.go.dev/badge/github.com/prometheus/client_golang/prometheus.svg)](https://pkg.go.dev/github.com/prometheus/client_golang/prometheus)
 
 The
-[`prometheus` directory](https://github.com/prometheus/client_golang/tree/master/prometheus)
+[`prometheus` directory](https://github.com/prometheus/client_golang/tree/main/prometheus)
 contains the instrumentation library. See the
 [guide](https://prometheus.io/docs/guides/go-application/) on the Prometheus
 website to learn more about instrumenting applications.
 
 The
-[`examples` directory](https://github.com/prometheus/client_golang/tree/master/examples)
+[`examples` directory](https://github.com/prometheus/client_golang/tree/main/examples)
 contains simple examples of instrumented code.
 
 ## Client for the Prometheus HTTP API
 
 [![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 Reference](https://pkg.go.dev/badge/github.com/prometheus/client_golang/api.svg)](https://pkg.go.dev/github.com/prometheus/client_golang/api)
 
 The
-[`api/prometheus` directory](https://github.com/prometheus/client_golang/tree/master/api/prometheus)
+[`api/prometheus` directory](https://github.com/prometheus/client_golang/tree/main/api/prometheus)
 contains the client for the
 [Prometheus HTTP API](http://prometheus.io/docs/querying/api/). It allows you
 to write Go applications that query time series data from a Prometheus
@@ -57,12 +58,14 @@ server. It is still in alpha stage.
 ## Where is `model`, `extraction`, and `text`?
 
 The `model` packages has been moved to
-[`prometheus/common/model`](https://github.com/prometheus/common/tree/master/model).
+[`prometheus/common/model`](https://github.com/prometheus/common/tree/main/model).
 
 The `extraction` and `text` packages are now contained in
-[`prometheus/common/expfmt`](https://github.com/prometheus/common/tree/master/expfmt).
+[`prometheus/common/expfmt`](https://github.com/prometheus/common/tree/main/expfmt).
 
 ## Contributing and community
 
 See the [contributing guidelines](CONTRIBUTING.md) and the
 [Community section](http://prometheus.io/community/) of the homepage.
+
+`clint_golang` community is also present on the CNCF Slack `#prometheus-client_golang`.