RepoMirrors
/
ipmi_exporter
mirror of https://github.com/prometheus-community/ipmi_exporter
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
ipmi_exporter/main.go

166 lines
4.6 KiB
Go
Raw Normal View History

Update for Prometheus Community * Update Makefile.common from prometheus/prometheus. * Switch from Cirrus to CircleCI. * Add CHANGELOG.md and VERSION. * Drop inline /vendor. * Update references to old github URL. * Update copyrights. * Update Go version. * Skip building on aix (undefined: syscall.Mkfifo) Signed-off-by: SuperQ <superq@gmail.com>
2021-09-21 10:18:34 +00:00
// Copyright 2021 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.
Initial public release
2017-07-25 14:17:57 +00:00
package main
import (
"fmt"
"net/http"
"os"
"os/signal"
"syscall"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promhttp"
"github.com/prometheus/common/log"
Supply proper version information This only adds the facilities to do so, the version information itself is currently only a git hash, as we have not tagged any releases so far. With this in place, let's set up some CI system, maybe a few test stubs and then we can do a 1.0 release.
2019-07-15 08:43:46 +00:00
"github.com/prometheus/common/version"
Switch to kingpin command line parser Unfortunately this is a breaking change, as this means going from `-config.file` to `--config.file` syntax, but it needs to happen eventually. It better aligns the IPMI exporter with the rest of the Prometheus eco-system. As a first benefit, expose the command line parameters that control the logging library.
2019-02-20 19:11:49 +00:00
kingpin "gopkg.in/alecthomas/kingpin.v2"
Initial public release
2017-07-25 14:17:57 +00:00
)
var (
Switch to kingpin command line parser Unfortunately this is a breaking change, as this means going from `-config.file` to `--config.file` syntax, but it needs to happen eventually. It better aligns the IPMI exporter with the rest of the Prometheus eco-system. As a first benefit, expose the command line parameters that control the logging library.
2019-02-20 19:11:49 +00:00
configFile = kingpin.Flag(
"config.file",
Initial public release
2017-07-25 14:17:57 +00:00
"Path to configuration file.",
Refactor mapping of target to IPMI settings Specifically, allow definition of a set of settings as module in the configuration file, and the ability to use these settings by setting the `module` URL parameter to the respective module name when scraping. THIS COMMIT CHANGES THE CONFIG FORMAT IN A NON-BACKWARDS-COMPATIBLE WAY! Based on this, the following "side effects" are noteworthy: - the exporter no longer requires a config file - the IPMI "privilege level" can be set in the config file - collectors can be enabled/disabled in the config file - anonymous IPMI access is now theoretically possible - there are now two example configurations (local & remote) This fixes #10 by allowing to set the privilege level.
2018-09-21 19:50:30 +00:00
).String()
Switch to kingpin command line parser Unfortunately this is a breaking change, as this means going from `-config.file` to `--config.file` syntax, but it needs to happen eventually. It better aligns the IPMI exporter with the rest of the Prometheus eco-system. As a first benefit, expose the command line parameters that control the logging library.
2019-02-20 19:11:49 +00:00
executablesPath = kingpin.Flag(
"freeipmi.path",
Initial public release
2017-07-25 14:17:57 +00:00
"Path to FreeIPMI executables (default: rely on $PATH).",
Switch to kingpin command line parser Unfortunately this is a breaking change, as this means going from `-config.file` to `--config.file` syntax, but it needs to happen eventually. It better aligns the IPMI exporter with the rest of the Prometheus eco-system. As a first benefit, expose the command line parameters that control the logging library.
2019-02-20 19:11:49 +00:00
).String()
listenAddress = kingpin.Flag(
"web.listen-address",
Initial public release
2017-07-25 14:17:57 +00:00
"Address to listen on for web interface and telemetry.",
Switch to kingpin command line parser Unfortunately this is a breaking change, as this means going from `-config.file` to `--config.file` syntax, but it needs to happen eventually. It better aligns the IPMI exporter with the rest of the Prometheus eco-system. As a first benefit, expose the command line parameters that control the logging library.
2019-02-20 19:11:49 +00:00
).Default(":9290").String()
Initial public release
2017-07-25 14:17:57 +00:00
sc = &SafeConfig{
C: &Config{},
}
reloadCh chan chan error
)
Minor style fixes
2018-09-21 09:41:59 +00:00
func remoteIPMIHandler(w http.ResponseWriter, r *http.Request) {
Initial public release
2017-07-25 14:17:57 +00:00
target := r.URL.Query().Get("target")
if target == "" {
http.Error(w, "'target' parameter must be specified", 400)
return
}
Refactor mapping of target to IPMI settings Specifically, allow definition of a set of settings as module in the configuration file, and the ability to use these settings by setting the `module` URL parameter to the respective module name when scraping. THIS COMMIT CHANGES THE CONFIG FORMAT IN A NON-BACKWARDS-COMPATIBLE WAY! Based on this, the following "side effects" are noteworthy: - the exporter no longer requires a config file - the IPMI "privilege level" can be set in the config file - collectors can be enabled/disabled in the config file - anonymous IPMI access is now theoretically possible - there are now two example configurations (local & remote) This fixes #10 by allowing to set the privilege level.
2018-09-21 19:50:30 +00:00
// Remote scrape will not work without some kind of config, so be pedantic about it
module := r.URL.Query().Get("module")
if module == "" {
module = "default"
}
if !sc.HasModule(module) {
http.Error(w, fmt.Sprintf("Unknown module %q", module), http.StatusBadRequest)
return
}
log.Debugf("Scraping target '%s' with module '%s'", target, module)
Initial public release
2017-07-25 14:17:57 +00:00
registry := prometheus.NewRegistry()
The great refactoring - Move every collector into its own file - Move FreeIPMI code into own package - Allow more customization of commands executed by collectors - Split up documentation, so README is a little less overwhelming A single commit message does not do justice to the amount of changes here, but hey... :)
2021-05-19 21:27:29 +00:00
remoteCollector := metaCollector{target: target, module: module, config: sc}
Support collecting local IPMI metrics This enables the standard `/metrics` endpoint. A scrape will trigger the collection of IPMI metrics from the local machine (that the exporter is running on).
2018-08-03 14:23:35 +00:00
registry.MustRegister(remoteCollector)
Initial public release
2017-07-25 14:17:57 +00:00
h := promhttp.HandlerFor(registry, promhttp.HandlerOpts{})
h.ServeHTTP(w, r)
}
func updateConfiguration(w http.ResponseWriter, r *http.Request) {
switch r.Method {
case "POST":
rc := make(chan error)
reloadCh <- rc
if err := <-rc; err != nil {
http.Error(w, fmt.Sprintf("failed to reload config: %s", err), http.StatusInternalServerError)
}
default:
fixes soundcloud/ipmi_exporter#8
2018-08-10 15:42:19 +00:00
log.Errorf("Only POST requests allowed for %s", r.URL)
w.Header().Set("Allow", "POST")
http.Error(w, "Only POST requests allowed", http.StatusMethodNotAllowed)
Initial public release
2017-07-25 14:17:57 +00:00
}
}
func main() {
Switch to kingpin command line parser Unfortunately this is a breaking change, as this means going from `-config.file` to `--config.file` syntax, but it needs to happen eventually. It better aligns the IPMI exporter with the rest of the Prometheus eco-system. As a first benefit, expose the command line parameters that control the logging library.
2019-02-20 19:11:49 +00:00
log.AddFlags(kingpin.CommandLine)
kingpin.HelpFlag.Short('h')
Supply proper version information This only adds the facilities to do so, the version information itself is currently only a git hash, as we have not tagged any releases so far. With this in place, let's set up some CI system, maybe a few test stubs and then we can do a 1.0 release.
2019-07-15 08:43:46 +00:00
kingpin.Version(version.Print("ipmi_exporter"))
Switch to kingpin command line parser Unfortunately this is a breaking change, as this means going from `-config.file` to `--config.file` syntax, but it needs to happen eventually. It better aligns the IPMI exporter with the rest of the Prometheus eco-system. As a first benefit, expose the command line parameters that control the logging library.
2019-02-20 19:11:49 +00:00
kingpin.Parse()
Initial public release
2017-07-25 14:17:57 +00:00
log.Infoln("Starting ipmi_exporter")
// Bail early if the config is bad.
if err := sc.ReloadConfig(*configFile); err != nil {
log.Fatalf("Error parsing config file: %s", err)
}
hup := make(chan os.Signal)
reloadCh = make(chan chan error)
signal.Notify(hup, syscall.SIGHUP)
go func() {
for {
select {
case <-hup:
if err := sc.ReloadConfig(*configFile); err != nil {
log.Errorf("Error reloading config: %s", err)
}
case rc := <-reloadCh:
if err := sc.ReloadConfig(*configFile); err != nil {
log.Errorf("Error reloading config: %s", err)
rc <- err
} else {
rc <- nil
}
}
}
}()
The great refactoring - Move every collector into its own file - Move FreeIPMI code into own package - Allow more customization of commands executed by collectors - Split up documentation, so README is a little less overwhelming A single commit message does not do justice to the amount of changes here, but hey... :)
2021-05-19 21:27:29 +00:00
localCollector := metaCollector{target: targetLocal, module: "default", config: sc}
Support collecting local IPMI metrics This enables the standard `/metrics` endpoint. A scrape will trigger the collection of IPMI metrics from the local machine (that the exporter is running on).
2018-08-03 14:23:35 +00:00
prometheus.MustRegister(&localCollector)
http.Handle("/metrics", promhttp.Handler()) // Regular metrics endpoint for local IPMI metrics.
Minor style fixes
2018-09-21 09:41:59 +00:00
http.HandleFunc("/ipmi", remoteIPMIHandler) // Endpoint to do IPMI scrapes.
Initial public release
2017-07-25 14:17:57 +00:00
http.HandleFunc("/-/reload", updateConfiguration) // Endpoint to reload configuration.
http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte(`<html>
<head>
<title>IPMI Exporter</title>
<style>
label{
display:inline-block;
width:75px;
}
form label {
margin: 10px;
}
form input {
margin: 10px;
}
</style>
</head>
<body>
<h1>IPMI Exporter</h1>
<form action="/ipmi">
<label>Target:</label> <input type="text" name="target" placeholder="X.X.X.X" value="1.2.3.4"><br>
<input type="submit" value="Submit">
Support collecting local IPMI metrics This enables the standard `/metrics` endpoint. A scrape will trigger the collection of IPMI metrics from the local machine (that the exporter is running on).
2018-08-03 14:23:35 +00:00
</form>
<p><a href="/metrics">Local metrics</a></p>
<p><a href="/config">Config</a></p>
Initial public release
2017-07-25 14:17:57 +00:00
</body>
</html>`))
})
log.Infof("Listening on %s", *listenAddress)
err := http.ListenAndServe(*listenAddress, nil)
if err != nil {
log.Fatal(err)
}
}