Merge exporter updates back

.github/workflows/build.yml

@@ -3,11 +3,11 @@ name: Build
 on:
   push:
     branches:
-      - master
+      - main
       - develop
   pull_request:
     branches:
-      - master
+      - main
       - develop
 
 jobs:

.golangci.yml

@@ -18,7 +18,7 @@ linters-settings:
   lll:
     line-length: 160
   goimports:
-    local-prefixes: github.com/avarabyeu/sonarqube-prometheus-exporter
+    local-prefixes: github.com/fleetframework/sonarqube-prometheus-exporter
   gocritic:
     enabled-tags:
       - performance
@@ -35,28 +35,9 @@ linters-settings:
       - whyNoLint
 
 linters:
-  enable-all: true
-  disable:
-    - prealloc
-    - gochecknoglobals
-    - gocyclo
-    #    - gocritic
-    - interfacer
-    - wsl
-    - funlen
-    - unused
-    - gomnd
-    #    - maligned
-    - goerr113
-    - godot
-    - nestif
-    - nlreturn
-    - sqlclosecheck
-    - exhaustive
-    - gci
-    - exhaustivestruct
-    - godox
-    - gochecknoglobals
+  presets:
+    - bugs
+    - performance
 
 run:
   concurrency: 1

.goreleaser.yml

@@ -44,8 +44,8 @@ dockers:
 
     # Templates of the Docker image names.
     image_templates:
-      - "ghcr.io/avarabyeu/sonarqube-prometheus-exporter:latest"
-      - "ghcr.io/avarabyeu/sonarqube-prometheus-exporter:{{ .Tag }}"
+      - "ghcr.io/fleetframework/sonarqube-prometheus-exporter:latest"
+      - "ghcr.io/fleetframework/sonarqube-prometheus-exporter:{{ .Tag }}"
 
     # Skips the docker push. Could be useful if you also do draft releases.
     # If set to auto, the release will not be pushed to the docker repository

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2021 FleetFramework Contributors
+
+   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.

Makefile

@@ -17,22 +17,22 @@ build:
 .PHONY: build
 
 lint:
-	docker run --rm -v $(CURR_DIR):/app -w /app golangci/golangci-lint:v1.32.2 golangci-lint run --enable-all --deadline 10m ./...
+	docker run --rm -v $(CURR_DIR):/app -w /app golangci/golangci-lint:v1.58.2 golangci-lint run ./...
 
 fmt:
-	gofumpt -extra -l -w -s ${GOFILES_NOVENDOR}
-	gofumports -local github.com/avarabyeu/sonarqube-prometheus-exporter -l -w ${GOFILES_NOVENDOR}
-	gci -local github.com/avarabyeu/sonarqube-prometheus-exporter -w ${GOFILES_NOVENDOR}
+	gofumpt -extra -l -w ${GOFILES_NOVENDOR}
+	goimports -local github.com/fleetframework/goga -w ${GOFILES_NOVENDOR}
+	gci write --skip-generated --section Standard --section Default --section "Prefix(github.com/fleetframework/sonarqube-prometheus-exporter)" ${GOFILES_NOVENDOR}
 
 test:
 	$(GO) test ${GODIRS_NOVENDOR}
 
 build-image: build
 	DOCKER_BUILDKIT=1 docker build -t sonarqube-prometheus-exporter .
 
-release-image: build-image
-	DOCKER_BUILDKIT=1 docker tag sonarqube-prometheus-exporter:latest quay.io/avarabyeu/sonarqube-prometheus-exporter
-	DOCKER_BUILDKIT=1 docker push quay.io/avarabyeu/sonarqube-prometheus-exporter
-
 run:
-	realize start
+	realize start
+
+tag:
+	git tag ${version}
+	git push origin ${version}

README.md

@@ -1,29 +1,68 @@
 # Prometheus Exporter for Sonarqube
 
+![Build Status](https://github.com/fleetframework/sonarqube-prometheus-exporter/actions/workflows/build.yml/badge.svg)
+![Release](https://img.shields.io/github/v/release/fleetframework/sonarqube-prometheus-exporter)
+
 ## Usage
 
+### CLI arguments
+
 ```
+Usage of bin/sonarqube-prometheus-exporter:
   -help
         Show help
-  -label-separator string
-        Label Separator. For instance, for Sonar with Label 'key#value', Prometheus attribute {project="my-project-name"} (default "#")
+  -labels string
+        Static labels to be added to all metrics. In form 'label1=labelvalue,label2=labelValue'
+  -log string
+        Logging level, e.g. debug,info. Default: debug (default "info")
+  -metrics-ns string
+        Prometheus metrics namespace. Default: sonar (default "sonar")
   -password string
-        Sonarqube Password
-  -port int
-        Exporter port (default 8080)
-  -scrape-timeout duration
-        Metrics scraper timeout (default 1m0s)
+        Required. Sonarqube Password
+  -port string
+        Exporter port. Default 8080 (default "8080")
+  -scrape-timeout string
+        Metrics scraper timeout. Default: 1m (default "1m")
+  -tag-export-empty string
+        Export projects that does not have tags defined in 'TAG_KEYS'. Prometheus labels will be set to empty in this case (default "TRUE")
+  -tag-keys string
+        List of tag keys to be used as metric labels
+  -tag-separator string
+        Tag Separator. For instance, for Sonar project with tag 'key#value', Prometheus will have label {project="my-project-name"} if defined in TAG_KEYS list (default "#")
   -url string
-        Sonarqube URL
+        Required. Sonarqube URL
   -user string
-        Sonarqube User
+        Required. Sonarqube User
   -version
         Show version
-
 ```
 
+### Environment Variables
+| Variable Name        | Default Value | Description                                                                                                        |
+|----------------------|---------------|--------------------------------------------------------------------------------------------------------------------|
+| SONAR_URL            |               | Sonarqube URL                                                                                                      |
+| SONAR_USER           |               | Sonarqube User                                                                                                     |
+| SONAR_PASSWORD       |               | Sonarqube Password                                                                                                 |
+| PORT                 | 8080          | Exporter port                                                                                                      |
+| SONAR_SCRAPE_TIMEOUT | 1m            | Metrics scraper timeout                                                                                            |
+| TAG_SEPARATOR        | #             | Tag Separator. For instance, for Sonar with tag 'key#value', Prometheus label {project="my-project-name"}          |
+| TAG_KEYS             |               | List of tag keys to be used as metric labels. For instance, 'module,product'                                       |
+| TAG_EXPORT_EMPTY     | TRUE          | Export projects that does not have tags defined in 'TAG_KEYS'. Prometheus labels will be set to empty in this case |
+| LABELS               |               | Static labels to be added to all metrics. In form 'label1=labelvalue,label2=labelValue'                            |
+| METRICS_NAMESPACE    | sonar         | Prometheus metrics namespace                                                                                       |
+| LOGGING_LEVEL        | info          | Logging level, e.g. debug,info                                                                                     |
+
 ## Run As Docker Container
 
 ```sh
-  docker run -p 8080:8080 ghcr.io/avarabyeu/sonarqube-prometheus-exporter:v0.0.1 -port 8080 -url <sonar-url> -user <sonar-user> -password <sonar-password>
-```
+  docker run -p 8080:8080 ghcr.io/fleetframework/sonarqube-prometheus-exporter:v0.0.6 -port 8080 -url <sonar-url> -user <sonar-user> -password <sonar-password>
+```
+
+or with environment variables
+
+```sh
+  docker run -p 8080:8080 -e PORT=8080 -e SONAR_URL=<sonar-url> \
+  -e SONAR_USER=<sonar-user> \
+  -e SONAR_PASSWORD=<sonar-password> \
+  ghcr.io/fleetframework/sonarqube-prometheus-exporter:v0.0.6
+```