Merge branch 'main' into add-code-coverage-integration

Author: BupycHuk

.github/workflows/go.yml

@@ -22,8 +22,15 @@ jobs:
         image:
           - mongo:4.4
           - mongo:5.0
+          - mongo:6.0
+          - mongo:7.0
+          - mongo:8.0
+          - mongo:latest
           - percona/percona-server-mongodb:4.4
           - percona/percona-server-mongodb:5.0
+          - percona/percona-server-mongodb:6.0
+          - percona/percona-server-mongodb:7.0
+          - percona/percona-server-mongodb:latest
 
     runs-on: ubuntu-latest
 
@@ -32,7 +39,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Set up Go
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
           go-version-file: ${{ github.workspace }}/go.mod
 
@@ -43,10 +50,25 @@ jobs:
           make test-cover
           make test-cluster-clean
 
+
       - name: Upload coverage results
         uses: codecov/codecov-action@v3
         with:
           file: cover.out
           flags: agent
           env_vars: GO_VERSION,TEST_MONGODB_IMAGE
           fail_ci_if_error: false
+
+      - name: Run debug commands on failure
+        if: ${{ failure() }}
+        run: |
+          echo "--- Environment variables ---"
+          env | sort
+          echo "--- GO Environment ---"
+          go env | sort
+          echo "--- Git status ---"
+          git status
+          echo "--- Docker logs ---"
+          docker compose logs
+          echo "--- Docker ps ---"
+          docker compose ps -a

.github/workflows/lint.yml

@@ -23,7 +23,7 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Set up Go
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
           go-version-file: ${{ github.workspace }}/go.mod
 

.github/workflows/release.yml

@@ -18,7 +18,7 @@ jobs:
           fetch-depth: 0
 
       - name: Set up Go
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
           go-version-file: ${{ github.workspace }}/go.mod
 
@@ -43,9 +43,9 @@ jobs:
         uses: docker/setup-buildx-action@v3
 
       - name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v5
+        uses: goreleaser/goreleaser-action@v6
         with:
-          version: v1.18.2
-          args: release --rm-dist
+          version: "~> v2"
+          args: release --clean
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.goreleaser.yml

@@ -1,11 +1,13 @@
 dist: build
+version: 2
 builds:
   - binary: mongodb_exporter
     env:
       - CGO_ENABLED=0
     goos:
       - linux
       - darwin
+      - windows
     goarch:
       - amd64
       - arm
@@ -23,9 +25,9 @@ archives:
   - name_template: "{{ .ProjectName }}-{{ .Version }}.{{ .Os }}-{{ .Arch }}"
     wrap_in_directory: true
 snapshot:
-  name_template: "{{ .ShortCommit }}"
+  version_template: "{{ .ShortCommit }}"
 changelog:
-  skip: true
+  use: github
 release:
   github:
     owner: percona
@@ -77,8 +79,9 @@ docker_manifests:
     image_templates:
     - ghcr.io/percona/mongodb_exporter:{{.Version}}-arm64v8
     - ghcr.io/percona/mongodb_exporter:{{.Version}}-amd64
+
 nfpms:
-  - file_name_template: "{{ .ProjectName }}-{{ .Version }}.{{ .Os }}-{{ .Arch }}"
+  - file_name_template: "{{ .ProjectName }}-{{ .Version }}.{{ .Os }}-{{- if eq .Arch `amd64` }}64-bit{{- else }}{{ .Arch }}{{ end }}"
     homepage:  https://www.percona.com/
     description: MongoDB exporter for Prometheus
     maintainer: Percona
@@ -88,8 +91,6 @@ nfpms:
     - deb
     - rpm
     bindir: /usr/bin
-    replacements:
-      amd64: 64-bit
     scripts:
       postinstall: ".scripts/postinst"
     contents:

CHANGELOG

@@ -1,3 +1,28 @@
+Release 0.41.1
+- Fix panic (regression bug in v0.41.0) occuring when fcv collector is enabled
+
+Release 0.41.0
+
+- Add extra label for replicaset metrics
+- Add information about supported MongoDB versions
+- Add command line flag to disable metrics about the exporter it-self
+- Add PBM metrics collector
+- Add cluster role label for mongodb_up
+- Add feature compatibility version collector
+- Migrate chunks metrics from v1 compatibility to shards collector
+- Correctly recognize arbiter nodes
+- Fix node type detection
+- Collstats, indexstats iterate only over collections, not views.
+- Fix case where users are prefixed with mongodb
+- Reconsider inclusion of opid in mongodb_currentop_query_uptime
+- List only authorized collections
+- Correctly evaluate balancer metrics
+- Reduce error logs from diagnostic data on arbiter nodes
+- Refactoring currentop_collector
+- Remove system colections from index stats
+- Update Go version
+- Update dependencies
+
 Release 0.40.0
 
 - Multi-target support

CONTRIBUTING.md

@@ -91,18 +91,24 @@ It will install `goimports`, `goreleaser`, `golangci-lint` and `reviewdog`.
 
 The testing sandbox starts `n` MongoDB instances as follows:
 
-- 3 Instances for shard 1 at ports 17001, 17002, 17003
-- 3 instances for shard 2 at ports 17004, 17005, 17006
+- 3 Instances for shard 1 at ports 17001, 17002, 17003 (with no authentication)
+- 3 instances for shard 2 at ports 17004, 17005, 17006 (with authentication enabled)
 - 3 config servers at ports 17007, 17008, 17009
 - 1 mongos server at port 17000
 - 1 stand alone instance at port 27017
 
-All instances are currently running without user and password so for example, to connect to the **mongos** you can just use:
+To connect to the **mongos** on shard 1, you can use:
 
 ```
 mongo mongodb://127.0.0.1:17001/admin
 ```
 
+To connect to the **mongos** on shard 2 (with authentication enabled), you can use:
+
+```
+mongo mongodb://admin:[email protected]:17001/admin
+```
+
 The sandbox can be started using the provided Makefile using: `make test-cluster` and it can be stopped using `make test-cluster-clean`.
 
 ### Running tests

Makefile

@@ -17,7 +17,7 @@ REPO ?= percona/$(NAME)
 GORELEASER_FLAGS ?=
 UID ?= $(shell id -u)
 
-export TEST_MONGODB_IMAGE?=mongo:4.2
+export TEST_MONGODB_IMAGE?=mongo:4.4
 export TEST_MONGODB_ADMIN_USERNAME?=
 export TEST_MONGODB_ADMIN_PASSWORD?=
 export TEST_MONGODB_USERNAME?=
@@ -76,8 +76,9 @@ build:                      ## Compile using plain go build
 release:                      ## Build the binaries using goreleaser
 	docker run --rm --privileged \
 		-v ${PWD}:/go/src/github.com/user/repo \
+		-v /var/run/docker.sock:/var/run/docker.sock \
 		-w /go/src/github.com/user/repo \
-		goreleaser/goreleaser release --snapshot --skip-publish --rm-dist 
+		goreleaser/goreleaser release --snapshot --skip=publish --clean
 
 FILES = $(shell find . -type f -name '*.go' -not -path "./vendor/*")
 
@@ -107,7 +108,8 @@ test-cover: env              ## Run tests and collect cross-package coverage inf
 	go test -race -timeout 30s -coverprofile=cover.out -covermode=atomic -coverpkg=./... ./...
 
 test-cluster: env           ## Starts MongoDB test cluster. Use env var TEST_MONGODB_IMAGE to set flavor and version. Example: TEST_MONGODB_IMAGE=mongo:3.6 make test-cluster
-	docker compose up -d --wait
+	docker compose up --build -d
+	./docker/scripts/setup-pbm.sh
 
 test-cluster-clean: env     ## Stops MongoDB test cluster.
-	docker compose down --remove-orphans --volumes --timeout 1
+	docker compose down --remove-orphans --volumes

README.md

@@ -16,6 +16,10 @@ Currently, these metric sources are implemented:
 - replSetGetStatus
 - serverStatus
 
+## Supported MongoDB versions
+
+The exporter works with Percona Server for MongoDB and MongoDB Community or Enterprise Edition versions 4.4 and newer. Older versions might also work but are not tested anymore.
+
 ## Info on Percona MongoDB exporter versions
 
 The old 0.1x.y version (ex `master` branch) has been moved to the `release-0.1x` branch.
@@ -48,10 +52,10 @@ A docker image is available on the [official percona repository](https://hub.doc
 
 ```sh
 # with podman
-podman run -d -p 9216:9216 -p 17001:17001 percona/mongodb_exporter:0.20 --mongodb.uri=mongodb://127.0.0.1:17001
+podman run -d -p 9216:9216 percona/mongodb_exporter:0.40 --mongodb.uri=mongodb://127.0.0.1:17001
 
 # with docker
-docker run -d -p 9216:9216 -p 17001:17001 percona/mongodb_exporter:0.20 --mongodb.uri=mongodb://127.0.0.1:17001
+docker run -d -p 9216:9216 percona/mongodb_exporter:0.40 --mongodb.uri=mongodb://127.0.0.1:17001
 ```
 
 #### Permissions
@@ -91,11 +95,28 @@ You can run the exporter specifying multiple URIs, devided by a comma in --mongo
 ```sh
 --mongodb.uri=mongodb://user:[email protected]:27017/admin,mongodb://user2:[email protected]:27018/admin
 ```
-In this case you can use the **/scrape** endpoint with the **target** parameter to retreive the specified tartget's metrics.  When querying the data you can use just mongodb://host:port in the targer parameter without other parameters and, of course without host credentials
+In this case you can use the **/scrape** endpoint with the **target** parameter to retreive the specified tartget's metrics.  When querying the data you can use just mongodb://host:port in the target parameter without other parameters and, of course without host credentials
 ```sh
 GET /scrape?target=mongodb://127.0.0.1:27018
 ```
+If your URI is prefixed by mongodb:// or mongodb+srv:// schema, any host not prefixed by it after comma is being treated as part of a cluster rather then as a standalone host. Thus clusters and standalone hosts can be combined like this:
+```
+--mongodb.uri=mongodb+srv://user:pass@host1:27017,host2:27017,host3:27017/admin,mongodb://user2:pass2@host4:27018/admin
+```
+
+You can use the --split-cluster option to split all cluster nodes into separate targets. This mode is useful when cluster nodes are defined as SRV records and the mongodb_exporter is running with mongodb+srv domain specified. In this case SRV records will be queried upon mongodb_exporter start and each cluster node can be queried using the **target** parameter of multitarget endpoint. 
+
+#### Overall targets request endpoint
 
+There is an overall targets endpoint **/scrapeall** that queries all the targets in one request. It can be used to store multiple node metrics without separate target requests. In this case, each node metric will have a **instance** label containing the node name as a host:port pair (or just host if no port was not specified). For example, for mongodb_exporter running with the options:
+```
+--mongodb.uri="mongodb://host1:27015,host2:27016" --split-cluster=true
+``` 
+we get metrics like this:
+```
+mongodb_up{instance="host1:27015"} 1
+mongodb_up{instance="host2:27016"} 1
+```
 
 #### Enabling collstats metrics gathering
 `--mongodb.collstats-colls` receives a list of databases and collections to monitor using collstats.
@@ -128,6 +149,17 @@ Usage example: `db.setProfilingLevel(2)`
 |1| The profiler collects data for operations that take longer than the value of `slowms` or that match a filter.<br> When a filter is set: <ul><li> The `slowms` and `sampleRate` options are not used for profiling.</li><li>The profiler only captures operations that match the filter.</li></ul>
 |2|The profiler collects data for all operations.|
 
+#### Enabling shards metrics gathering
+When shard metrics collection is enabled by `--collector.shards`, the exporter will expose metrics related to sharded Mongo. 
+Example, if shards collector is enabled:
+```
+# HELP mongodb_shards_collection_chunks_count sharded collection chunks.
+# TYPE mongodb_shards_collection_chunks_count counter
+mongodb_shards_collection_chunks_count{collection="system.sessions",database="config",shard="rs1"} 250
+mongodb_shards_collection_chunks_count{collection="system.sessions",database="config",shard="rs2"} 250
+```
+You can see shard name, it's collection, database and count.
+
 #### Cluster role labels
 The exporter sets some topology labels in all metrics.
 The labels are: