diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/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 [yyyy] [name of copyright owner] + + 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. diff --git a/collector/storage.go b/collector/storage.go index 05c293a..c98e17d 100644 --- a/collector/storage.go +++ b/collector/storage.go @@ -10,7 +10,7 @@ import ( "github.com/prometheus/client_golang/prometheus" ) -type StorageInfo struct { +type storageInfo struct { StorageSummary struct { BinariesSummary struct { BinariesCount string `json:"binariesCount"` @@ -65,8 +65,8 @@ type StorageInfo struct { } `json:"binariesSummary"` } -func (e *Exporter) fetchStorageInfo() (StorageInfo, error) { - var storageInfo StorageInfo +func (e *Exporter) fetchStorageInfo() (storageInfo, error) { + var storageInfo storageInfo resp, err := fetchHTTP(e.URI, "storageinfo", e.bc, e.sslVerify, e.timeout) if err != nil { return storageInfo, err @@ -78,7 +78,7 @@ func (e *Exporter) fetchStorageInfo() (StorageInfo, error) { return storageInfo, nil } -func RemoveCommas(str string) (float64, error) { +func removeCommas(str string) (float64, error) { reg, err := regexp.Compile("[^0-9.]+") if err != nil { @@ -92,11 +92,11 @@ func RemoveCommas(str string) (float64, error) { return convertedStr, nil } -func BytesConverter(str string) (float64, error) { +func bytesConverter(str string) (float64, error) { type errorString struct { s string } - num, err := RemoveCommas(str) + num, err := removeCommas(str) if err != nil { return 0, err } @@ -120,7 +120,7 @@ func (e *Exporter) exportCount(metricName string, metric *prometheus.Desc, count e.jsonParseFailures.Inc() return } - value, _ := RemoveCommas(count) + value, _ := removeCommas(count) ch <- prometheus.MustNewConstMetric(metric, prometheus.GaugeValue, value) } @@ -129,7 +129,7 @@ func (e *Exporter) exportSize(metricName string, metric *prometheus.Desc, size s e.jsonParseFailures.Inc() return } - value, _ := BytesConverter(size) + value, _ := bytesConverter(size) ch <- prometheus.MustNewConstMetric(metric, prometheus.GaugeValue, value) } @@ -138,11 +138,11 @@ func (e *Exporter) exportFilestore(metricName string, metric *prometheus.Desc, s e.jsonParseFailures.Inc() return } - value, _ := BytesConverter(size) + value, _ := bytesConverter(size) ch <- prometheus.MustNewConstMetric(metric, prometheus.GaugeValue, value, fileStoreType, fileStoreDir) } -type RepoSummary struct { +type repoSummary struct { Name string Type string FoldersCount float64 @@ -153,36 +153,36 @@ type RepoSummary struct { Percentage float64 } -func (e *Exporter) extractRepoSummary(storageInfo StorageInfo, ch chan<- prometheus.Metric) { +func (e *Exporter) extractRepoSummary(storageInfo storageInfo, ch chan<- prometheus.Metric) { var err error - repoSummary := RepoSummary{} - repoSummaryList := []RepoSummary{} + rs := repoSummary{} + repoSummaryList := []repoSummary{} for _, repo := range storageInfo.StorageSummary.RepositoriesSummaryList { if repo.RepoKey == "TOTAL" { continue } - repoSummary.Name = repo.RepoKey - repoSummary.Type = strings.ToLower(repo.RepoType) - repoSummary.FoldersCount = float64(repo.FoldersCount) - repoSummary.FilesCount = float64(repo.FilesCount) - repoSummary.ItemsCount = float64(repo.ItemsCount) - repoSummary.PackageType = strings.ToLower(repo.PackageType) - repoSummary.UsedSpace, err = BytesConverter(repo.UsedSpace) + rs.Name = repo.RepoKey + rs.Type = strings.ToLower(repo.RepoType) + rs.FoldersCount = float64(repo.FoldersCount) + rs.FilesCount = float64(repo.FilesCount) + rs.ItemsCount = float64(repo.ItemsCount) + rs.PackageType = strings.ToLower(repo.PackageType) + rs.UsedSpace, err = bytesConverter(repo.UsedSpace) if err != nil { e.jsonParseFailures.Inc() return } - repoSummary.Percentage, err = RemoveCommas(repo.Percentage) + rs.Percentage, err = removeCommas(repo.Percentage) if err != nil { e.jsonParseFailures.Inc() return } - repoSummaryList = append(repoSummaryList, repoSummary) + repoSummaryList = append(repoSummaryList, rs) } e.exportRepo(repoSummaryList, ch) } -func (e *Exporter) exportRepo(repoSummaries []RepoSummary, ch chan<- prometheus.Metric) { +func (e *Exporter) exportRepo(repoSummaries []repoSummary, ch chan<- prometheus.Metric) { for _, repoSummary := range repoSummaries { for metricName, metric := range storageMetrics { diff --git a/collector/users.go b/collector/users.go index 20195ed..c60e79f 100644 --- a/collector/users.go +++ b/collector/users.go @@ -6,13 +6,13 @@ import ( "github.com/prometheus/client_golang/prometheus" ) -type User struct { +type user struct { Name string `json:"name"` Realm string `json:"realm"` } -func (e *Exporter) fetchUsers() ([]User, error) { - var users []User +func (e *Exporter) fetchUsers() ([]user, error) { + var users []user resp, err := fetchHTTP(e.URI, "security/users", e.bc, e.sslVerify, e.timeout) if err != nil { return nil, err @@ -29,7 +29,7 @@ type usersCount struct { realm string } -func (e *Exporter) countUsers(metricName string, metric *prometheus.Desc, users []User, ch chan<- prometheus.Metric) { +func (e *Exporter) countUsers(metricName string, metric *prometheus.Desc, users []user, ch chan<- prometheus.Metric) { userCount := []usersCount{ {0, "saml"}, diff --git a/config/config.go b/config/config.go index 652ae73..6af54bb 100644 --- a/config/config.go +++ b/config/config.go @@ -19,11 +19,13 @@ var ( artiTimeout = kingpin.Flag("artifactory.timeout", "Timeout for trying to get stats from JFrog Artifactory.").Envar("ARTI_TIMEOUT").Default("5s").Duration() ) +// Username and Password for Artifactory HTTP Basic Authentication type BasicCredentials struct { Username string `required:"true" envconfig:"ARTI_USERNAME"` Password string `required:"true" envconfig:"ARTI_PASSWORD"` } +// Config represents all configuration options for running the Exporter. type Config struct { ListenAddress string MetricsPath string @@ -34,6 +36,7 @@ type Config struct { Logger log.Logger } +// Creates new Artifactory exporter Config func NewConfig() (*Config, error) { promlogConfig := &promlog.Config{}