From 60e8f761ef08105f9b695b32f23297fa84873631 Mon Sep 17 00:00:00 2001 From: Eugene Chertikhin Date: Thu, 12 Mar 2015 18:08:13 +0300 Subject: [PATCH] initial --- .gitignore | 7 ++ LICENSE | 202 +++++++++++++++++++++++++++++++++++++++++++ Makefile | 17 ++++ Makefile.COMMON | 107 +++++++++++++++++++++++ NOTICE | 5 ++ README.md | 26 +++++- mysqld_exporter.conf | 5 ++ mysqld_exporter.go | 191 ++++++++++++++++++++++++++++++++++++++++ 8 files changed, 559 insertions(+), 1 deletion(-) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 Makefile.COMMON create mode 100644 NOTICE create mode 100644 mysqld_exporter.conf create mode 100644 mysqld_exporter.go diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..ec2101ab7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,7 @@ +.build +mysqld_exporter +*.tar.gz +*.test +*-stamp +.idea +*.iml diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..e06d20818 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ +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/Makefile b/Makefile new file mode 100644 index 000000000..077811c3c --- /dev/null +++ b/Makefile @@ -0,0 +1,17 @@ +# Copyright 2013 The Prometheus Authors +# 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. + +VERSION := 0.1.0 +TARGET := mysqld_exporter + +include Makefile.COMMON diff --git a/Makefile.COMMON b/Makefile.COMMON new file mode 100644 index 000000000..7576f1114 --- /dev/null +++ b/Makefile.COMMON @@ -0,0 +1,107 @@ +# Copyright 2015 The Prometheus Authors +# 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. + +# This file provides common Makefile infrastructure for several Prometheus +# components. This includes make tasks for downloading Go, setting up a +# self-contained build environment, fetching Go dependencies, building +# binaries, running tests, and doing release management. This file is intended +# to be included from a project's Makefile, which needs to define the following +# variables, at a minimum: +# +# * VERSION - The current version of the project in question. +# * TARGET - The desired name of the built binary. +# +# Many of the variables defined below are defined conditionally (using '?'), +# which allows the project's main Makefile to override any of these settings, if +# needed. See also: +# +# https://www.gnu.org/software/make/manual/html_node/Flavors.html#Flavors. +# +# The including Makefile may define any number of extra targets that are +# specific to that project. + +VERSION ?= $(error VERSION not set in including Makefile) +TARGET ?= $(error TARGET not set in including Makefile) + +SRC ?= $(shell find . -type f -name "*.go" ! -path "./.build/*") +GOOS := $(shell uname | tr A-Z a-z) +GOARCH := $(subst x86_64,amd64,$(patsubst i%86,386,$(shell uname -m))) + +ifeq ($(GOOS),darwin) + RELEASE_SUFFIX ?= -osx$(shell sw_vers -productVersion) +endif + +GO_VERSION ?= 1.4.1 +GOURL ?= https://golang.org/dl +GOPKG ?= go$(GO_VERSION).$(GOOS)-$(GOARCH)$(RELEASE_SUFFIX).tar.gz +GOPATH := $(CURDIR)/.build/gopath +GOCC ?= $(GOROOT)/bin/go +GO ?= GOROOT=$(GOROOT) GOPATH=$(GOPATH) $(GOCC) +GOFMT ?= $(GOROOT)/bin/gofmt + +ifeq ($(shell type go >/dev/null && go version | sed 's/.*go\([0-9.]*\).*/\1/'), $(GO_VERSION)) + GOROOT := $(shell go env GOROOT) +else + GOROOT := $(CURDIR)/.build/go$(GO_VERSION) +endif + +# Never honor GOBIN, should it be set at all. +unexport GOBIN + +SUFFIX ?= $(GOOS)-$(GOARCH) +BINARY ?= $(TARGET) +ARCHIVE ?= $(TARGET)-$(VERSION).$(SUFFIX).tar.gz +ROOTPKG ?= github.com/prometheus/$(TARGET) +SELFLINK ?= $(GOPATH)/src/$(ROOTPKG) + +default: $(BINARY) + +$(GOCC): + @echo Go version $(GO_VERSION) required but not found in PATH. + @echo About to download and install go$(GO_VERSION) to $(GOROOT) + @echo Abort now if you want to manually install it system-wide instead. + @echo + @sleep 5 + mkdir -p $(GOROOT) + curl -L $(GOURL)/$(GOPKG) | tar -C $(GOROOT) --strip 1 -xz + +$(SELFLINK): + mkdir -p $(dir $@) + ln -s $(CURDIR) $@ + +dependencies-stamp: $(SRC) | $(SELFLINK) + $(GO) get -d + touch $@ + +$(BINARY): $(GOCC) $(SRC) dependencies-stamp Makefile Makefile.COMMON + $(GO) build $(GOFLAGS) -o $@ + +$(ARCHIVE): $(BINARY) + tar -czf $@ $< + +.PHONY: tag +tag: + git tag $(VERSION) + git push --tags + +.PHONY: test +test: $(GOCC) dependencies-stamp + $(GO) test ./... + +.PHONY: format +format: + find . -iname '*.go' | egrep -v "^\./\.build|./generated|\./Godeps|\.(l|y)\.go" | xargs -n1 $(GOFMT) -w -s=true + +.PHONY: clean +clean: + rm -rf $(BINARY) $(ARCHIVE) .build *-stamp diff --git a/NOTICE b/NOTICE new file mode 100644 index 000000000..e282f157c --- /dev/null +++ b/NOTICE @@ -0,0 +1,5 @@ +Exporter for mysql daemon +by Eugene Chertikhin + +This product includes software developed at +SoundCloud Ltd. (http://soundcloud.com/). diff --git a/README.md b/README.md index 6c94d5030..c4676e11d 100644 --- a/README.md +++ b/README.md @@ -1 +1,25 @@ -# mysqld_exporter (UNDER CONSTRUCTION) +# mysqld_exporter + +Exporter for MySQL server metrics http://prometheus.io/ + +## Building and running + + make + ./mysqld_exporter + +## Configuration +The configuration is in JSON. An example with all possible options: +``` +{ + "config" : { + "mysql_connection" : "login:password@host/dbname" + } +} +``` +Name | Description +---------|------------ +login | Login name for connect with server +password | Password for connect with server +host | Server hostname or ip. May be omitted +dbname | Name of database + diff --git a/mysqld_exporter.conf b/mysqld_exporter.conf new file mode 100644 index 000000000..8cb3046ca --- /dev/null +++ b/mysqld_exporter.conf @@ -0,0 +1,5 @@ +{ + "config" : { + "mysql_connection" : "root:123@/mysql" + } +} diff --git a/mysqld_exporter.go b/mysqld_exporter.go new file mode 100644 index 000000000..708d13ead --- /dev/null +++ b/mysqld_exporter.go @@ -0,0 +1,191 @@ +package main + +import ( + "encoding/json" + "flag" + "io/ioutil" + "log" + "net/http" + "strconv" + "sync" + + "database/sql" + _ "github.com/go-sql-driver/mysql" + + "github.com/prometheus/client_golang/prometheus" +) + +const ( + namespace = "mysql" +) + +var ( + listenAddress = flag.String("web.listen-address", ":9091", "Address to listen on for web interface and telemetry.") + metricPath = flag.String("web.telemetry-path", "/metrics", "Path under which to expose metrics.") + configFile = flag.String("config.file", "mysqld_exporter.conf", "Path to config file.") +) + +type Config struct { + Config map[string]string `json:"config"` +} + +type Exporter struct { + config Config + mutex sync.RWMutex + up prometheus.Gauge + totalScrapes, errorScrapes prometheus.Counter + metrics map[string]prometheus.Gauge +} + +func getConfig(file string) (*Config, error) { + config := &Config{} + + bytes, err := ioutil.ReadFile(file) + if err != nil { + return nil, err + } + + return config, json.Unmarshal(bytes, &config) +} + +// return new empty exporter +func NewMySQLExporter(config *Config) *Exporter { + return &Exporter{ + config: *config, + up: prometheus.NewGauge(prometheus.GaugeOpts{ + Namespace: namespace, + Name: "up", + Help: "Was the last scrape of mysqld successful.", + }), + totalScrapes: prometheus.NewCounter(prometheus.CounterOpts{ + Namespace: namespace, + Name: "exporter_total_scrapes", + Help: "Current total mysqld scrapes.", + }), + errorScrapes: prometheus.NewCounter(prometheus.CounterOpts{ + Namespace: namespace, + Name: "exporter_error_scrapes", + Help: "Error mysqld scrapes.", + }), + metrics: map[string]prometheus.Gauge{}, + } +} + +func (e *Exporter) Describe(ch chan<- *prometheus.Desc) { + for _, m := range e.metrics { + m.Describe(ch) + } + + ch <- e.up.Desc() + ch <- e.totalScrapes.Desc() + ch <- e.errorScrapes.Desc() +} + +func (e *Exporter) Collect(ch chan<- prometheus.Metric) { + scrapes := make(chan []string) + + go e.scrape(scrapes) + + e.mutex.Lock() + defer e.mutex.Unlock() + e.setMetrics(scrapes) + ch <- e.up + ch <- e.totalScrapes + ch <- e.errorScrapes + e.collectMetrics(ch) +} + +func (e *Exporter) scrape(scrapes chan<- []string) { + defer close(scrapes) + + e.totalScrapes.Inc() + e.up.Set(0) + + db, err := sql.Open("mysql", e.config.Config["mysql_connection"]) + if err != nil { + log.Printf("error open connection to db using %s", e.config.Config["mysql_connection"]) + return + } + defer db.Close() + + rows, err := db.Query("SHOW STATUS") + if err != nil { + log.Printf("error running query on db %s", e.config.Config["mysql_connection"]) + return + } + defer rows.Close() + + e.up.Set(1) // from this point db is ok + + var key, val []byte + for rows.Next() { + // get RawBytes from data + err = rows.Scan(&key, &val) + if err != nil { + log.Printf("error getting result set ") + return + } + + var res []string = make([]string, 2) + res[0] = string(key) + res[1] = string(val) + + scrapes <- res + } + + return +} + +func (e *Exporter) setMetrics(scrapes <-chan []string) { + for row := range scrapes { + + name := row[0] + value, err := strconv.ParseInt(row[1], 10, 64) + if err != nil { + // not really important + // log.Printf("Error while parsing field value %s (%s): %v", row[0], row[1], err) + e.errorScrapes.Inc() + continue + } + + if _, ok := e.metrics[name]; !ok { + e.metrics[name] = prometheus.NewGauge(prometheus.GaugeOpts{ + Namespace: namespace, + Name: name, + }) + } + + e.metrics[name].Set(float64(value)) + } +} + +func (e *Exporter) collectMetrics(metrics chan<- prometheus.Metric) { + for _, m := range e.metrics { + m.Collect(metrics) + } +} + +func main() { + flag.Parse() + + config, err := getConfig(*configFile) + if err != nil { + log.Fatal("couldn't read config file ", *configFile, " : ", err) + } + + exporter := NewMySQLExporter(config) + prometheus.MustRegister(exporter) + http.Handle(*metricPath, prometheus.Handler()) + http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) { + w.Write([]byte(` +MySQLd exporter + +

MySQLd exporter

+

Metrics

+ + +`)) + }) + + log.Fatal(http.ListenAndServe(*listenAddress, nil)) +}