├── examples ├── job-1.sh └── job-2.sh ├── pkg └── run │ ├── params.go │ └── run.go ├── .gitignore ├── Dockerfile ├── README.md ├── cmd └── bash-exporter │ └── bash-exporter.go └── LICENSE /examples/job-1.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | echo '{"labels": {"env": "dev"}, "results": {"items": 21} }' 4 | 5 | exit 0 6 | -------------------------------------------------------------------------------- /examples/job-2.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | echo '{"labels": {"hostname": "node-1"}, "results": {"get": 0.003, "put": 0.13, "time": 0.5} }' 4 | 5 | exit 0 6 | -------------------------------------------------------------------------------- /pkg/run/params.go: -------------------------------------------------------------------------------- 1 | package run 2 | 3 | import "sync" 4 | 5 | // Type Params stores parameters. 6 | type Params struct { 7 | Path *string 8 | UseWg bool 9 | Wg *sync.WaitGroup 10 | } 11 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Binaries for programs and plugins 2 | *.exe 3 | *.exe~ 4 | *.dll 5 | *.so 6 | *.dylib 7 | 8 | # Test binary, build with `go test -c` 9 | *.test 10 | 11 | # Output of the go coverage tool, specifically when used with LiteIDE 12 | *.out 13 | 14 | cmd/bash-exporter/bash-exporter 15 | cmd/bash-exporter/bash-exporter-linux 16 | cmd/bash-exporter/bash-exporter-macos 17 | cmd/bash-exporter/*.sh 18 | examples/.* 19 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM golang:1.10.1 2 | RUN go get -d -v github.com/gree-gorey/bash-exporter/cmd/bash-exporter 3 | WORKDIR /go/src/github.com/gree-gorey/bash-exporter/cmd/bash-exporter 4 | RUN CGO_ENABLED=0 GOOS=linux go build -a -installsuffix cgo -o bash-exporter . 5 | 6 | FROM alpine:3.7 7 | WORKDIR /root/ 8 | COPY --from=0 /go/src/github.com/gree-gorey/bash-exporter/cmd/bash-exporter/bash-exporter . 9 | COPY ./examples/* /scripts/ 10 | CMD ["./bash-exporter"] 11 | -------------------------------------------------------------------------------- /pkg/run/run.go: -------------------------------------------------------------------------------- 1 | package run 2 | 3 | import ( 4 | "encoding/json" 5 | "log" 6 | "os/exec" 7 | ) 8 | 9 | type Output struct { 10 | Schema Schema `json:""` 11 | Job string `json:""` 12 | } 13 | 14 | type Schema struct { 15 | Results map[string]float64 `json:"results"` 16 | Labels map[string]string `json:"labels"` 17 | } 18 | 19 | func (o *Output) RunJob(p *Params) { 20 | if p.UseWg { 21 | defer p.Wg.Done() 22 | } 23 | o.RunExec(p.Path) 24 | } 25 | 26 | func (o *Output) RunExec(path *string) { 27 | 28 | out, err := exec.Command(*path).Output() 29 | if err != nil { 30 | log.Fatal(err) 31 | } 32 | 33 | err = json.Unmarshal(out, &o.Schema) 34 | if err != nil { 35 | log.Fatal(err) 36 | } 37 | 38 | } 39 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Prometheus bash exporter 2 | 3 | Simple & minimalistic Prometheus exporter for bash scripts. 4 | 5 | [![Go Report Card](https://goreportcard.com/badge/github.com/gree-gorey/bash-exporter)](https://goreportcard.com/report/github.com/gree-gorey/bash-exporter) 6 | [![](https://images.microbadger.com/badges/image/greegorey/bash-exporter.svg)](https://microbadger.com/images/greegorey/bash-exporter "Get your own image badge on microbadger.com") 7 | [![](https://images.microbadger.com/badges/version/greegorey/bash-exporter.svg)](https://microbadger.com/images/greegorey/bash-exporter "Get your own version badge on microbadger.com") 8 | 9 | ## Installation 10 | Use [Docker image](https://hub.docker.com/r/greegorey/bash-exporter/) or binary file from [releases](https://github.com/gree-gorey/bash-exporter/releases). 11 | 12 | ## Docker quick start 13 | 14 | ```console 15 | $ docker run -v $PWD/examples:/scripts -p 9300:9300 greegorey/bash-exporter:2.0.0 16 | ``` 17 | 18 | ```console 19 | $ curl -s 127.1:9300/metrics | grep ^bash 20 | bash{env="",hostname="node-1",job="job-2",verb="get"} 0.003 21 | bash{env="",hostname="node-1",job="job-2",verb="put"} 0.13 22 | bash{env="",hostname="node-1",job="job-2",verb="time"} 0.5 23 | bash{env="dev",hostname="",job="job-1",verb="items"} 21 24 | ``` 25 | 26 | ## Usage 27 | 28 | ```console 29 | Usage of ./bash-exporter: 30 | -debug 31 | Debug log level 32 | -interval int 33 | Interval for metrics collection in seconds (default 300) 34 | -labels string 35 | additioanal labels (default "hostname,env") 36 | -path string 37 | path to directory with bash scripts (default "/scripts") 38 | -prefix string 39 | Prefix for metrics (default "bash") 40 | -web.listen-address string 41 | Address on which to expose metrics (default ":9300") 42 | ``` 43 | 44 | Just point `-path` flag to the directory with your bash scripts. Names of the files (`(.*).sh`) will be used as the `job` label. Bash scripts should return valid json (see [examples](https://github.com/gree-gorey/bash-exporter/tree/master/examples)). 45 | 46 | Example output: 47 | ```console 48 | # HELP bash bash exporter metrics 49 | # TYPE bash gauge 50 | bash{job="job-1",verb="items"} 21 51 | bash{job="job-2",verb="get"} 0.003 52 | bash{job="job-2",verb="put"} 0.13 53 | bash{job="job-2",verb="time"} 0.5 54 | ... 55 | ``` 56 | 57 | ## TODO 58 | - [x] Docker image 59 | - [x] Several scripts 60 | -------------------------------------------------------------------------------- /cmd/bash-exporter/bash-exporter.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | // "encoding/json" 5 | "flag" 6 | "fmt" 7 | "io/ioutil" 8 | "log" 9 | "net/http" 10 | "strings" 11 | "sync" 12 | "time" 13 | 14 | "github.com/gree-gorey/bash-exporter/pkg/run" 15 | "github.com/prometheus/client_golang/prometheus" 16 | "github.com/prometheus/client_golang/prometheus/promhttp" 17 | ) 18 | 19 | var ( 20 | verbMetrics *prometheus.GaugeVec 21 | ) 22 | 23 | func main() { 24 | addr := flag.String("web.listen-address", ":9300", "Address on which to expose metrics") 25 | interval := flag.Int("interval", 300, "Interval for metrics collection in seconds") 26 | path := flag.String("path", "/scripts", "path to directory with bash scripts") 27 | labels := flag.String("labels", "hostname,env", "additioanal labels") 28 | prefix := flag.String("prefix", "bash", "Prefix for metrics") 29 | debug := flag.Bool("debug", false, "Debug log level") 30 | flag.Parse() 31 | 32 | var labelsArr []string 33 | 34 | labelsArr = strings.Split(*labels, ",") 35 | labelsArr = append(labelsArr, "verb", "job") 36 | 37 | verbMetrics = prometheus.NewGaugeVec( 38 | prometheus.GaugeOpts{ 39 | Name: fmt.Sprintf("%s", *prefix), 40 | Help: "bash exporter metrics", 41 | }, 42 | // []string{"verb", "job"}, 43 | labelsArr, 44 | ) 45 | prometheus.MustRegister(verbMetrics) 46 | 47 | files, err := ioutil.ReadDir(*path) 48 | if err != nil { 49 | log.Fatal(err) 50 | } 51 | 52 | var names []string 53 | for _, f := range files { 54 | if f.Name()[0:1] != "." { 55 | names = append(names, f.Name()) 56 | } 57 | } 58 | 59 | http.Handle("/metrics", promhttp.Handler()) 60 | go Run(int(*interval), *path, names, labelsArr, *debug) 61 | log.Fatal(http.ListenAndServe(*addr, nil)) 62 | } 63 | 64 | func Run(interval int, path string, names []string, labelsArr []string, debug bool) { 65 | for { 66 | var wg sync.WaitGroup 67 | oArr := []*run.Output{} 68 | wg.Add(len(names)) 69 | for _, name := range names { 70 | o := run.Output{} 71 | o.Job = strings.Split(name, ".")[0] 72 | oArr = append(oArr, &o) 73 | thisPath := path + "/" + name 74 | p := run.Params{UseWg: true, Wg: &wg, Path: &thisPath} 75 | go o.RunJob(&p) 76 | } 77 | wg.Wait() 78 | // if debug == true { 79 | // ser, err := json.Marshal(o) 80 | // if err != nil { 81 | // log.Println(err) 82 | // } 83 | // log.Println(string(ser)) 84 | // } 85 | verbMetrics.Reset() 86 | for _, o := range oArr { 87 | 88 | for metric, value := range o.Schema.Results { 89 | for _, label := range labelsArr { 90 | if _, ok := o.Schema.Labels[label]; !ok { 91 | o.Schema.Labels[label] = "" 92 | } 93 | } 94 | o.Schema.Labels["verb"] = metric 95 | o.Schema.Labels["job"] = o.Job 96 | fmt.Println(o.Schema.Labels) 97 | verbMetrics.With(prometheus.Labels(o.Schema.Labels)).Set(float64(value)) 98 | } 99 | } 100 | time.Sleep(time.Duration(interval) * time.Second) 101 | } 102 | } 103 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------