mirror of
https://github.com/prometheus/prometheus.git
synced 2024-12-28 23:19:41 -08:00
358 lines
11 KiB
Go
358 lines
11 KiB
Go
// 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 uyuni
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"log/slog"
|
|
"net/http"
|
|
"net/url"
|
|
"path"
|
|
"strconv"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/kolo/xmlrpc"
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
"github.com/prometheus/common/config"
|
|
"github.com/prometheus/common/model"
|
|
|
|
"github.com/prometheus/prometheus/discovery"
|
|
"github.com/prometheus/prometheus/discovery/refresh"
|
|
"github.com/prometheus/prometheus/discovery/targetgroup"
|
|
)
|
|
|
|
const (
|
|
uyuniXMLRPCAPIPath = "/rpc/api"
|
|
|
|
uyuniMetaLabelPrefix = model.MetaLabelPrefix + "uyuni_"
|
|
uyuniLabelMinionHostname = uyuniMetaLabelPrefix + "minion_hostname"
|
|
uyuniLabelPrimaryFQDN = uyuniMetaLabelPrefix + "primary_fqdn"
|
|
uyuniLabelSystemID = uyuniMetaLabelPrefix + "system_id"
|
|
uyuniLabelGroups = uyuniMetaLabelPrefix + "groups"
|
|
uyuniLabelEndpointName = uyuniMetaLabelPrefix + "endpoint_name"
|
|
uyuniLabelExporter = uyuniMetaLabelPrefix + "exporter"
|
|
uyuniLabelProxyModule = uyuniMetaLabelPrefix + "proxy_module"
|
|
uyuniLabelMetricsPath = uyuniMetaLabelPrefix + "metrics_path"
|
|
uyuniLabelScheme = uyuniMetaLabelPrefix + "scheme"
|
|
|
|
tokenDuration = 10 * time.Minute
|
|
)
|
|
|
|
// DefaultSDConfig is the default Uyuni SD configuration.
|
|
var DefaultSDConfig = SDConfig{
|
|
Entitlement: "monitoring_entitled",
|
|
Separator: ",",
|
|
RefreshInterval: model.Duration(1 * time.Minute),
|
|
HTTPClientConfig: config.DefaultHTTPClientConfig,
|
|
}
|
|
|
|
func init() {
|
|
discovery.RegisterConfig(&SDConfig{})
|
|
}
|
|
|
|
// SDConfig is the configuration for Uyuni based service discovery.
|
|
type SDConfig struct {
|
|
Server string `yaml:"server"`
|
|
Username string `yaml:"username"`
|
|
Password config.Secret `yaml:"password"`
|
|
HTTPClientConfig config.HTTPClientConfig `yaml:",inline"`
|
|
Entitlement string `yaml:"entitlement,omitempty"`
|
|
Separator string `yaml:"separator,omitempty"`
|
|
RefreshInterval model.Duration `yaml:"refresh_interval,omitempty"`
|
|
}
|
|
|
|
type systemGroupID struct {
|
|
GroupID int `xmlrpc:"id"`
|
|
GroupName string `xmlrpc:"name"`
|
|
}
|
|
|
|
type networkInfo struct {
|
|
SystemID int `xmlrpc:"system_id"`
|
|
Hostname string `xmlrpc:"hostname"`
|
|
PrimaryFQDN string `xmlrpc:"primary_fqdn"`
|
|
IP string `xmlrpc:"ip"`
|
|
}
|
|
|
|
type endpointInfo struct {
|
|
SystemID int `xmlrpc:"system_id"`
|
|
EndpointName string `xmlrpc:"endpoint_name"`
|
|
Port int `xmlrpc:"port"`
|
|
Path string `xmlrpc:"path"`
|
|
Module string `xmlrpc:"module"`
|
|
ExporterName string `xmlrpc:"exporter_name"`
|
|
TLSEnabled bool `xmlrpc:"tls_enabled"`
|
|
}
|
|
|
|
// Discovery periodically performs Uyuni API requests. It implements the Discoverer interface.
|
|
type Discovery struct {
|
|
*refresh.Discovery
|
|
apiURL *url.URL
|
|
roundTripper http.RoundTripper
|
|
username string
|
|
password string
|
|
token string
|
|
tokenExpiration time.Time
|
|
entitlement string
|
|
separator string
|
|
interval time.Duration
|
|
logger *slog.Logger
|
|
}
|
|
|
|
// NewDiscovererMetrics implements discovery.Config.
|
|
func (*SDConfig) NewDiscovererMetrics(reg prometheus.Registerer, rmi discovery.RefreshMetricsInstantiator) discovery.DiscovererMetrics {
|
|
return &uyuniMetrics{
|
|
refreshMetrics: rmi,
|
|
}
|
|
}
|
|
|
|
// Name returns the name of the Config.
|
|
func (*SDConfig) Name() string { return "uyuni" }
|
|
|
|
// NewDiscoverer returns a Discoverer for the Config.
|
|
func (c *SDConfig) NewDiscoverer(opts discovery.DiscovererOptions) (discovery.Discoverer, error) {
|
|
return NewDiscovery(c, opts.Logger, opts.Metrics)
|
|
}
|
|
|
|
// SetDirectory joins any relative file paths with dir.
|
|
func (c *SDConfig) SetDirectory(dir string) {
|
|
c.HTTPClientConfig.SetDirectory(dir)
|
|
}
|
|
|
|
// UnmarshalYAML implements the yaml.Unmarshaler interface.
|
|
func (c *SDConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
|
*c = DefaultSDConfig
|
|
type plain SDConfig
|
|
err := unmarshal((*plain)(c))
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if c.Server == "" {
|
|
return errors.New("Uyuni SD configuration requires server host")
|
|
}
|
|
|
|
_, err = url.Parse(c.Server)
|
|
if err != nil {
|
|
return fmt.Errorf("Uyuni Server URL is not valid: %w", err)
|
|
}
|
|
|
|
if c.Username == "" {
|
|
return errors.New("Uyuni SD configuration requires a username")
|
|
}
|
|
if c.Password == "" {
|
|
return errors.New("Uyuni SD configuration requires a password")
|
|
}
|
|
return c.HTTPClientConfig.Validate()
|
|
}
|
|
|
|
func login(rpcclient *xmlrpc.Client, user, pass string, duration int) (string, error) {
|
|
var result string
|
|
err := rpcclient.Call("auth.login", []interface{}{user, pass, duration}, &result)
|
|
return result, err
|
|
}
|
|
|
|
func getSystemGroupsInfoOfMonitoredClients(rpcclient *xmlrpc.Client, token, entitlement string) (map[int][]systemGroupID, error) {
|
|
var systemGroupsInfos []struct {
|
|
SystemID int `xmlrpc:"id"`
|
|
SystemGroups []systemGroupID `xmlrpc:"system_groups"`
|
|
}
|
|
|
|
err := rpcclient.Call("system.listSystemGroupsForSystemsWithEntitlement", []interface{}{token, entitlement}, &systemGroupsInfos)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
result := make(map[int][]systemGroupID)
|
|
for _, systemGroupsInfo := range systemGroupsInfos {
|
|
result[systemGroupsInfo.SystemID] = systemGroupsInfo.SystemGroups
|
|
}
|
|
return result, nil
|
|
}
|
|
|
|
func getNetworkInformationForSystems(rpcclient *xmlrpc.Client, token string, systemIDs []int) (map[int]networkInfo, error) {
|
|
var networkInfos []networkInfo
|
|
err := rpcclient.Call("system.getNetworkForSystems", []interface{}{token, systemIDs}, &networkInfos)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
result := make(map[int]networkInfo)
|
|
for _, networkInfo := range networkInfos {
|
|
result[networkInfo.SystemID] = networkInfo
|
|
}
|
|
return result, nil
|
|
}
|
|
|
|
func getEndpointInfoForSystems(
|
|
rpcclient *xmlrpc.Client,
|
|
token string,
|
|
systemIDs []int,
|
|
) ([]endpointInfo, error) {
|
|
var endpointInfos []endpointInfo
|
|
err := rpcclient.Call(
|
|
"system.monitoring.listEndpoints",
|
|
[]interface{}{token, systemIDs}, &endpointInfos)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return endpointInfos, err
|
|
}
|
|
|
|
// NewDiscovery returns a uyuni discovery for the given configuration.
|
|
func NewDiscovery(conf *SDConfig, logger *slog.Logger, metrics discovery.DiscovererMetrics) (*Discovery, error) {
|
|
m, ok := metrics.(*uyuniMetrics)
|
|
if !ok {
|
|
return nil, errors.New("invalid discovery metrics type")
|
|
}
|
|
|
|
apiURL, err := url.Parse(conf.Server)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
apiURL.Path = path.Join(apiURL.Path, uyuniXMLRPCAPIPath)
|
|
|
|
rt, err := config.NewRoundTripperFromConfig(conf.HTTPClientConfig, "uyuni_sd")
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
d := &Discovery{
|
|
apiURL: apiURL,
|
|
roundTripper: rt,
|
|
username: conf.Username,
|
|
password: string(conf.Password),
|
|
entitlement: conf.Entitlement,
|
|
separator: conf.Separator,
|
|
interval: time.Duration(conf.RefreshInterval),
|
|
logger: logger,
|
|
}
|
|
|
|
d.Discovery = refresh.NewDiscovery(
|
|
refresh.Options{
|
|
Logger: logger,
|
|
Mech: "uyuni",
|
|
Interval: time.Duration(conf.RefreshInterval),
|
|
RefreshF: d.refresh,
|
|
MetricsInstantiator: m.refreshMetrics,
|
|
},
|
|
)
|
|
return d, nil
|
|
}
|
|
|
|
func (d *Discovery) getEndpointLabels(
|
|
endpoint endpointInfo,
|
|
systemGroupIDs []systemGroupID,
|
|
networkInfo networkInfo,
|
|
) model.LabelSet {
|
|
var addr, scheme string
|
|
managedGroupNames := getSystemGroupNames(systemGroupIDs)
|
|
addr = fmt.Sprintf("%s:%d", networkInfo.Hostname, endpoint.Port)
|
|
if endpoint.TLSEnabled {
|
|
scheme = "https"
|
|
} else {
|
|
scheme = "http"
|
|
}
|
|
|
|
result := model.LabelSet{
|
|
model.AddressLabel: model.LabelValue(addr),
|
|
uyuniLabelMinionHostname: model.LabelValue(networkInfo.Hostname),
|
|
uyuniLabelPrimaryFQDN: model.LabelValue(networkInfo.PrimaryFQDN),
|
|
uyuniLabelSystemID: model.LabelValue(strconv.Itoa(endpoint.SystemID)),
|
|
uyuniLabelGroups: model.LabelValue(strings.Join(managedGroupNames, d.separator)),
|
|
uyuniLabelEndpointName: model.LabelValue(endpoint.EndpointName),
|
|
uyuniLabelExporter: model.LabelValue(endpoint.ExporterName),
|
|
uyuniLabelProxyModule: model.LabelValue(endpoint.Module),
|
|
uyuniLabelMetricsPath: model.LabelValue(endpoint.Path),
|
|
uyuniLabelScheme: model.LabelValue(scheme),
|
|
}
|
|
|
|
return result
|
|
}
|
|
|
|
func getSystemGroupNames(systemGroupsIDs []systemGroupID) []string {
|
|
managedGroupNames := make([]string, 0, len(systemGroupsIDs))
|
|
for _, systemGroupInfo := range systemGroupsIDs {
|
|
managedGroupNames = append(managedGroupNames, systemGroupInfo.GroupName)
|
|
}
|
|
|
|
return managedGroupNames
|
|
}
|
|
|
|
func (d *Discovery) getTargetsForSystems(
|
|
rpcClient *xmlrpc.Client,
|
|
entitlement string,
|
|
) ([]model.LabelSet, error) {
|
|
result := make([]model.LabelSet, 0)
|
|
|
|
systemGroupIDsBySystemID, err := getSystemGroupsInfoOfMonitoredClients(rpcClient, d.token, entitlement)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to get the managed system groups information of monitored clients: %w", err)
|
|
}
|
|
|
|
systemIDs := make([]int, 0, len(systemGroupIDsBySystemID))
|
|
for systemID := range systemGroupIDsBySystemID {
|
|
systemIDs = append(systemIDs, systemID)
|
|
}
|
|
|
|
endpointInfos, err := getEndpointInfoForSystems(rpcClient, d.token, systemIDs)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to get endpoints information: %w", err)
|
|
}
|
|
|
|
networkInfoBySystemID, err := getNetworkInformationForSystems(rpcClient, d.token, systemIDs)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to get the systems network information: %w", err)
|
|
}
|
|
|
|
for _, endpoint := range endpointInfos {
|
|
systemID := endpoint.SystemID
|
|
labels := d.getEndpointLabels(
|
|
endpoint,
|
|
systemGroupIDsBySystemID[systemID],
|
|
networkInfoBySystemID[systemID])
|
|
result = append(result, labels)
|
|
}
|
|
|
|
return result, nil
|
|
}
|
|
|
|
func (d *Discovery) refresh(_ context.Context) ([]*targetgroup.Group, error) {
|
|
rpcClient, err := xmlrpc.NewClient(d.apiURL.String(), d.roundTripper)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
defer rpcClient.Close()
|
|
|
|
if time.Now().After(d.tokenExpiration) {
|
|
// Uyuni API takes duration in seconds.
|
|
d.token, err = login(rpcClient, d.username, d.password, int(tokenDuration.Seconds()))
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to login to Uyuni API: %w", err)
|
|
}
|
|
// Login again at half the token lifetime.
|
|
d.tokenExpiration = time.Now().Add(tokenDuration / 2)
|
|
}
|
|
|
|
targetsForSystems, err := d.getTargetsForSystems(rpcClient, d.entitlement)
|
|
if err != nil {
|
|
// Force the renewal of the token on next refresh.
|
|
d.tokenExpiration = time.Now()
|
|
return nil, err
|
|
}
|
|
|
|
return []*targetgroup.Group{{Targets: targetsForSystems, Source: d.apiURL.String()}}, nil
|
|
}
|