mirror of
https://github.com/prometheus/prometheus.git
synced 2025-12-05 01:21:23 +01:00
e894a22b88
Adds a `config` label (similar to `prometheus_sd_discovered_targets`) to refresh metrics to help identify the source of refresh issues or performance stats. In particular for HTTP SD, it can be common to have multiple disparate HTTP SD sources that should be identified and not lumped together. For example if one HTTP SD service has failures, that should be evident in its own time series seperate from other HTTP SD sources. `config` seemed more appropriate than `endpoint` as a general standard for `prometheus_sd` metrics. Docs were also updated for HTTP SD to point at the new refresh metrics rather than the older metrics. Signed-off-by: Will Bollock <wbollock@linode.com>
269 lines
7.1 KiB
Go
269 lines
7.1 KiB
Go
// Copyright 2016 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 triton
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"net"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"net/url"
|
|
"strconv"
|
|
"testing"
|
|
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
"github.com/prometheus/common/config"
|
|
"github.com/prometheus/common/model"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/prometheus/prometheus/discovery"
|
|
)
|
|
|
|
var (
|
|
conf = SDConfig{
|
|
Account: "testAccount",
|
|
Role: "container",
|
|
DNSSuffix: "triton.example.com",
|
|
Endpoint: "127.0.0.1",
|
|
Port: 443,
|
|
Version: 1,
|
|
RefreshInterval: 1,
|
|
TLSConfig: config.TLSConfig{InsecureSkipVerify: true},
|
|
}
|
|
badconf = SDConfig{
|
|
Account: "badTestAccount",
|
|
Role: "container",
|
|
DNSSuffix: "bad.triton.example.com",
|
|
Endpoint: "127.0.0.1",
|
|
Port: 443,
|
|
Version: 1,
|
|
RefreshInterval: 1,
|
|
TLSConfig: config.TLSConfig{
|
|
InsecureSkipVerify: false,
|
|
KeyFile: "shouldnotexist.key",
|
|
CAFile: "shouldnotexist.ca",
|
|
CertFile: "shouldnotexist.cert",
|
|
},
|
|
}
|
|
groupsconf = SDConfig{
|
|
Account: "testAccount",
|
|
Role: "container",
|
|
DNSSuffix: "triton.example.com",
|
|
Endpoint: "127.0.0.1",
|
|
Groups: []string{"foo", "bar"},
|
|
Port: 443,
|
|
Version: 1,
|
|
RefreshInterval: 1,
|
|
TLSConfig: config.TLSConfig{InsecureSkipVerify: true},
|
|
}
|
|
cnconf = SDConfig{
|
|
Account: "testAccount",
|
|
Role: "cn",
|
|
DNSSuffix: "triton.example.com",
|
|
Endpoint: "127.0.0.1",
|
|
Port: 443,
|
|
Version: 1,
|
|
RefreshInterval: 1,
|
|
TLSConfig: config.TLSConfig{InsecureSkipVerify: true},
|
|
}
|
|
)
|
|
|
|
func newTritonDiscovery(c SDConfig) (*Discovery, discovery.DiscovererMetrics, error) {
|
|
reg := prometheus.NewRegistry()
|
|
refreshMetrics := discovery.NewRefreshMetrics(reg)
|
|
// TODO(ptodev): Add the ability to unregister refresh metrics.
|
|
metrics := c.NewDiscovererMetrics(reg, refreshMetrics)
|
|
err := metrics.Register()
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
|
|
d, err := New(&c, discovery.DiscovererOptions{
|
|
Logger: nil,
|
|
Metrics: metrics,
|
|
SetName: "triton",
|
|
})
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
|
|
return d, metrics, nil
|
|
}
|
|
|
|
func TestTritonSDNew(t *testing.T) {
|
|
td, m, err := newTritonDiscovery(conf)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, td)
|
|
require.NotNil(t, td.client)
|
|
require.NotZero(t, td.interval)
|
|
require.NotNil(t, td.sdConfig)
|
|
require.Equal(t, conf.Account, td.sdConfig.Account)
|
|
require.Equal(t, conf.DNSSuffix, td.sdConfig.DNSSuffix)
|
|
require.Equal(t, conf.Endpoint, td.sdConfig.Endpoint)
|
|
require.Equal(t, conf.Port, td.sdConfig.Port)
|
|
m.Unregister()
|
|
}
|
|
|
|
func TestTritonSDNewBadConfig(t *testing.T) {
|
|
td, _, err := newTritonDiscovery(badconf)
|
|
require.Error(t, err)
|
|
require.Nil(t, td)
|
|
}
|
|
|
|
func TestTritonSDNewGroupsConfig(t *testing.T) {
|
|
td, m, err := newTritonDiscovery(groupsconf)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, td)
|
|
require.NotNil(t, td.client)
|
|
require.NotZero(t, td.interval)
|
|
require.NotNil(t, td.sdConfig)
|
|
require.Equal(t, groupsconf.Account, td.sdConfig.Account)
|
|
require.Equal(t, groupsconf.DNSSuffix, td.sdConfig.DNSSuffix)
|
|
require.Equal(t, groupsconf.Endpoint, td.sdConfig.Endpoint)
|
|
require.Equal(t, groupsconf.Groups, td.sdConfig.Groups)
|
|
require.Equal(t, groupsconf.Port, td.sdConfig.Port)
|
|
m.Unregister()
|
|
}
|
|
|
|
func TestTritonSDNewCNConfig(t *testing.T) {
|
|
td, m, err := newTritonDiscovery(cnconf)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, td)
|
|
require.NotNil(t, td.client)
|
|
require.NotZero(t, td.interval)
|
|
require.NotZero(t, td.sdConfig)
|
|
require.Equal(t, cnconf.Role, td.sdConfig.Role)
|
|
require.Equal(t, cnconf.Account, td.sdConfig.Account)
|
|
require.Equal(t, cnconf.DNSSuffix, td.sdConfig.DNSSuffix)
|
|
require.Equal(t, cnconf.Endpoint, td.sdConfig.Endpoint)
|
|
require.Equal(t, cnconf.Port, td.sdConfig.Port)
|
|
m.Unregister()
|
|
}
|
|
|
|
func TestTritonSDRefreshNoTargets(t *testing.T) {
|
|
tgts := testTritonSDRefresh(t, conf, "{\"containers\":[]}")
|
|
require.Nil(t, tgts)
|
|
}
|
|
|
|
func TestTritonSDRefreshMultipleTargets(t *testing.T) {
|
|
dstr := `{"containers":[
|
|
{
|
|
"groups":["foo","bar","baz"],
|
|
"server_uuid":"44454c4c-5000-104d-8037-b7c04f5a5131",
|
|
"vm_alias":"server01",
|
|
"vm_brand":"lx",
|
|
"vm_image_uuid":"7b27a514-89d7-11e6-bee6-3f96f367bee7",
|
|
"vm_uuid":"ad466fbf-46a2-4027-9b64-8d3cdb7e9072"
|
|
},
|
|
{
|
|
"server_uuid":"a5894692-bd32-4ca1-908a-e2dda3c3a5e6",
|
|
"vm_alias":"server02",
|
|
"vm_brand":"kvm",
|
|
"vm_image_uuid":"a5894692-bd32-4ca1-908a-e2dda3c3a5e6",
|
|
"vm_uuid":"7b27a514-89d7-11e6-bee6-3f96f367bee7"
|
|
}]
|
|
}`
|
|
|
|
tgts := testTritonSDRefresh(t, conf, dstr)
|
|
require.NotNil(t, tgts)
|
|
require.Len(t, tgts, 2)
|
|
}
|
|
|
|
func TestTritonSDRefreshNoServer(t *testing.T) {
|
|
td, m, _ := newTritonDiscovery(conf)
|
|
|
|
_, err := td.refresh(context.Background())
|
|
require.ErrorContains(t, err, "an error occurred when requesting targets from the discovery endpoint")
|
|
m.Unregister()
|
|
}
|
|
|
|
func TestTritonSDRefreshCancelled(t *testing.T) {
|
|
td, m, _ := newTritonDiscovery(conf)
|
|
|
|
ctx, cancel := context.WithCancel(context.Background())
|
|
cancel()
|
|
_, err := td.refresh(ctx)
|
|
require.ErrorContains(t, err, context.Canceled.Error())
|
|
m.Unregister()
|
|
}
|
|
|
|
func TestTritonSDRefreshCNsUUIDOnly(t *testing.T) {
|
|
dstr := `{"cns":[
|
|
{
|
|
"server_uuid":"44454c4c-5000-104d-8037-b7c04f5a5131"
|
|
},
|
|
{
|
|
"server_uuid":"a5894692-bd32-4ca1-908a-e2dda3c3a5e6"
|
|
}]
|
|
}`
|
|
|
|
tgts := testTritonSDRefresh(t, cnconf, dstr)
|
|
require.NotNil(t, tgts)
|
|
require.Len(t, tgts, 2)
|
|
}
|
|
|
|
func TestTritonSDRefreshCNsWithHostname(t *testing.T) {
|
|
dstr := `{"cns":[
|
|
{
|
|
"server_uuid":"44454c4c-5000-104d-8037-b7c04f5a5131",
|
|
"server_hostname": "server01"
|
|
},
|
|
{
|
|
"server_uuid":"a5894692-bd32-4ca1-908a-e2dda3c3a5e6",
|
|
"server_hostname": "server02"
|
|
}]
|
|
}`
|
|
|
|
tgts := testTritonSDRefresh(t, cnconf, dstr)
|
|
require.NotNil(t, tgts)
|
|
require.Len(t, tgts, 2)
|
|
}
|
|
|
|
func testTritonSDRefresh(t *testing.T, c SDConfig, dstr string) []model.LabelSet {
|
|
var (
|
|
td, m, _ = newTritonDiscovery(c)
|
|
s = httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
|
|
fmt.Fprintln(w, dstr)
|
|
}))
|
|
)
|
|
|
|
defer s.Close()
|
|
|
|
u, err := url.Parse(s.URL)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, u)
|
|
|
|
host, strport, err := net.SplitHostPort(u.Host)
|
|
require.NoError(t, err)
|
|
require.NotEmpty(t, host)
|
|
require.NotEmpty(t, strport)
|
|
|
|
port, err := strconv.Atoi(strport)
|
|
require.NoError(t, err)
|
|
require.NotZero(t, port)
|
|
|
|
td.sdConfig.Port = port
|
|
|
|
tgs, err := td.refresh(context.Background())
|
|
require.NoError(t, err)
|
|
require.Len(t, tgs, 1)
|
|
tg := tgs[0]
|
|
require.NotNil(t, tg)
|
|
|
|
m.Unregister()
|
|
|
|
return tg.Targets
|
|
}
|