-
Notifications
You must be signed in to change notification settings - Fork 197
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Make the working of this exporter similar to that of the blackbox_exporter to allow probing multiple targets. * Add functionality to add headers to the request * Update the example config to use `headers` as well as the `metrics` keys in alignment with the new code * Add default header 'Accept: application/json' Signed-off-by: rustyclock <[email protected]>
- Loading branch information
1 parent
2c09f42
commit 4ea7ef2
Showing
20 changed files
with
579 additions
and
806 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,142 @@ | ||
// Copyright 2020 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. | ||
|
||
package cmd | ||
|
||
import ( | ||
"context" | ||
"encoding/json" | ||
"fmt" | ||
"net/http" | ||
"time" | ||
|
||
"github.com/prometheus-community/json_exporter/config" | ||
"github.com/prometheus-community/json_exporter/internal" | ||
"github.com/prometheus/client_golang/prometheus" | ||
"github.com/prometheus/client_golang/prometheus/promhttp" | ||
log "github.com/sirupsen/logrus" | ||
"github.com/urfave/cli" | ||
) | ||
|
||
var ( | ||
defaultOpts = []cli.Flag{ | ||
cli.IntFlag{ | ||
Name: "port", | ||
Usage: "The port number used to expose metrics via http", | ||
Value: 7979, | ||
}, | ||
cli.StringFlag{ | ||
Name: "log-level", | ||
Usage: "Set Logging level", | ||
Value: "info", | ||
}, | ||
} | ||
) | ||
|
||
func MakeApp() *cli.App { | ||
|
||
app := cli.NewApp() | ||
app.Name = "json_exporter" | ||
app.Version = internal.Version | ||
app.Usage = "A prometheus exporter for scraping metrics from JSON REST API endpoints" | ||
app.UsageText = "[OPTIONS] CONFIG_PATH" | ||
app.Action = main | ||
app.Flags = defaultOpts | ||
|
||
return app | ||
} | ||
|
||
func main(c *cli.Context) { | ||
setupLogging(c.String("log-level")) | ||
|
||
internal.Init(c) | ||
|
||
config, err := config.LoadConfig(c.Args()[0]) | ||
if err != nil { | ||
log.Fatal(err) | ||
} | ||
configJson, err := json.MarshalIndent(config, "", "\t") | ||
if err != nil { | ||
log.Errorf("Failed to marshal loaded config to JSON. ERROR: '%s'", err) | ||
} | ||
log.Infof("Config:\n%s", string(configJson)) | ||
|
||
http.Handle("/metrics", promhttp.Handler()) | ||
http.HandleFunc("/probe", func(w http.ResponseWriter, req *http.Request) { | ||
probeHandler(w, req, config) | ||
}) | ||
if err := http.ListenAndServe(fmt.Sprintf(":%d", c.Int("port")), nil); err != nil { | ||
log.Fatal(err) | ||
} | ||
} | ||
|
||
func probeHandler(w http.ResponseWriter, r *http.Request, config config.Config) { | ||
|
||
ctx, cancel := context.WithTimeout(r.Context(), time.Duration(config.Global.TimeoutSeconds*float64(time.Second))) | ||
defer cancel() | ||
r = r.WithContext(ctx) | ||
|
||
registry := prometheus.NewPedanticRegistry() | ||
|
||
metrics, err := internal.CreateMetricsList(registry, config) | ||
if err != nil { | ||
log.Fatalf("Failed to create metrics from config. Error: %s", err) | ||
} | ||
|
||
probeSuccessGauge := prometheus.NewGauge(prometheus.GaugeOpts{ | ||
Name: "probe_success", | ||
Help: "Displays whether or not the probe was a success", | ||
}) | ||
probeDurationGauge := prometheus.NewGauge(prometheus.GaugeOpts{ | ||
Name: "probe_duration_seconds", | ||
Help: "Returns how long the probe took to complete in seconds", | ||
}) | ||
|
||
target := r.URL.Query().Get("target") | ||
if target == "" { | ||
http.Error(w, "Target parameter is missing", http.StatusBadRequest) | ||
return | ||
} | ||
|
||
start := time.Now() | ||
registry.MustRegister(probeSuccessGauge) | ||
registry.MustRegister(probeDurationGauge) | ||
|
||
data, err := internal.FetchJson(ctx, target, config.Headers) | ||
if err != nil { | ||
log.Error(err) | ||
duration := time.Since(start).Seconds() | ||
log.Errorf("Probe failed. duration_seconds: %f", duration) | ||
} else { | ||
internal.Scrape(metrics, data) | ||
|
||
duration := time.Since(start).Seconds() | ||
probeDurationGauge.Set(duration) | ||
probeSuccessGauge.Set(1) | ||
} | ||
|
||
h := promhttp.HandlerFor(registry, promhttp.HandlerOpts{}) | ||
h.ServeHTTP(w, r) | ||
|
||
} | ||
|
||
func setupLogging(level string) { | ||
log.SetFormatter(&log.TextFormatter{ | ||
FullTimestamp: true, | ||
}) | ||
logLevel, err := log.ParseLevel(level) | ||
if err != nil { | ||
log.Fatalf("could not set log level to '%s';err:<%s>", level, err) | ||
} | ||
log.SetLevel(logLevel) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,88 @@ | ||
// Copyright 2020 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. | ||
|
||
package config | ||
|
||
import ( | ||
"io/ioutil" | ||
|
||
log "github.com/sirupsen/logrus" | ||
|
||
"gopkg.in/yaml.v2" | ||
) | ||
|
||
// Metric contains values that define a metric | ||
type Metric struct { | ||
Name string | ||
Path string | ||
Labels map[string]string | ||
Type MetricType | ||
Help string | ||
Values map[string]string | ||
} | ||
|
||
type MetricType string | ||
|
||
const ( | ||
ValueScrape MetricType = "value" // default | ||
ObjectScrape MetricType = "object" | ||
) | ||
|
||
// Config contains metrics and headers defining a configuration | ||
type Config struct { | ||
Headers map[string]string | ||
Metrics []Metric | ||
Global GlobalConfig | ||
} | ||
|
||
type GlobalConfig struct { | ||
TimeoutSeconds float64 | ||
} | ||
|
||
func (metric *Metric) LabelNames() []string { | ||
var labelNames []string | ||
for name := range metric.Labels { | ||
labelNames = append(labelNames, name) | ||
} | ||
return labelNames | ||
} | ||
|
||
func LoadConfig(configPath string) (Config, error) { | ||
var config Config | ||
data, err := ioutil.ReadFile(configPath) | ||
if err != nil { | ||
log.Errorf("Failed to load config: %s, Error: %s", configPath, err) | ||
return config, err | ||
} | ||
|
||
if err := yaml.Unmarshal(data, &config); err != nil { | ||
log.Errorf("Failed to parse YAML: %s", err) | ||
return config, err | ||
} | ||
|
||
// Complete Defaults | ||
for i := 0; i < len(config.Metrics); i++ { | ||
if config.Metrics[i].Type == "" { | ||
config.Metrics[i].Type = ValueScrape | ||
//config.Metrics[i].Type = "DefaultScrapeType" | ||
} | ||
if config.Metrics[i].Help == "" { | ||
config.Metrics[i].Help = config.Metrics[i].Name | ||
} | ||
} | ||
if config.Global.TimeoutSeconds == 0 { | ||
config.Global.TimeoutSeconds = 10 | ||
} | ||
|
||
return config, nil | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,6 +18,7 @@ | |
"count": 3, | ||
"some_boolean": false, | ||
"state": "ACTIVE" | ||
}, | ||
] | ||
} | ||
], | ||
"location": "mars" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.