-
Notifications
You must be signed in to change notification settings - Fork 4.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
MON-3513: Add availability test for Metrics API #28737
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,130 @@ | ||
package disruptionmetricsapi | ||
|
||
import ( | ||
"context" | ||
"fmt" | ||
"time" | ||
|
||
"github.com/openshift/origin/pkg/monitortestframework" | ||
|
||
appsv1 "k8s.io/api/apps/v1" | ||
apierrors "k8s.io/apimachinery/pkg/api/errors" | ||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
"k8s.io/client-go/kubernetes" | ||
"k8s.io/client-go/rest" | ||
|
||
"github.com/openshift/origin/pkg/monitor/backenddisruption" | ||
"github.com/openshift/origin/pkg/monitor/monitorapi" | ||
"github.com/openshift/origin/pkg/monitortestlibrary/disruptionlibrary" | ||
"github.com/openshift/origin/pkg/test/ginkgo/junitapi" | ||
) | ||
|
||
const ( | ||
monitoringNamespace = "openshift-monitoring" | ||
prometheusAdapterDeployentName = "prometheus-adapter" | ||
metricsServerDeploymentName = "metrics-server" | ||
) | ||
|
||
type availability struct { | ||
disruptionChecker *disruptionlibrary.Availability | ||
notSupportedReason error | ||
} | ||
|
||
func NewAvailabilityInvariant() monitortestframework.MonitorTest { | ||
return &availability{} | ||
} | ||
|
||
func createBackendSampler(clusterConfig *rest.Config, disruptionBackendName, url string, connectionType monitorapi.BackendConnectionType) (*backenddisruption.BackendSampler, error) { | ||
backendSampler, err := backenddisruption.NewAPIServerBackend(clusterConfig, disruptionBackendName, url, connectionType) | ||
if err != nil { | ||
return nil, err | ||
} | ||
backendSampler = backendSampler.WithUserAgent(fmt.Sprintf("openshift-external-backend-sampler-%s-%s", connectionType, disruptionBackendName)) | ||
return backendSampler, nil | ||
} | ||
|
||
func (w *availability) StartCollection(ctx context.Context, adminRESTConfig *rest.Config, recorder monitorapi.RecorderWriter) error { | ||
var err error | ||
|
||
kubeClient, err := kubernetes.NewForConfig(adminRESTConfig) | ||
if err != nil { | ||
return err | ||
} | ||
var deployment *appsv1.Deployment | ||
deployment, err = kubeClient.AppsV1().Deployments(monitoringNamespace).Get(ctx, metricsServerDeploymentName, metav1.GetOptions{}) | ||
if apierrors.IsNotFound(err) { | ||
// TODO: remove this in 4.17 | ||
deployment, err = kubeClient.AppsV1().Deployments(monitoringNamespace).Get(ctx, prometheusAdapterDeployentName, metav1.GetOptions{}) | ||
if err != nil { | ||
return err | ||
} | ||
} else if err != nil { | ||
return err | ||
} | ||
// Skip for single replica Deployments. | ||
if deployment.Spec.Replicas != nil && *deployment.Spec.Replicas == 1 { | ||
w.notSupportedReason = &monitortestframework.NotSupportedError{Reason: fmt.Sprintf("%s only has a single replica", deployment.Name)} | ||
return w.notSupportedReason | ||
} | ||
|
||
disruptionBackedName := "metrics-api" | ||
newConnectionTestName := fmt.Sprintf("[sig-instrumentation] disruption/%s connection/new should be available throughout the test", disruptionBackedName) | ||
reusedConnectionTestName := fmt.Sprintf("[sig-instrumentation] disruption/%s connection/reused should be available throughout the test", disruptionBackedName) | ||
url := "/apis/metrics.k8s.io/v1beta1" | ||
|
||
newConnections, err := createBackendSampler(adminRESTConfig, disruptionBackedName, url, monitorapi.NewConnectionType) | ||
if err != nil { | ||
return err | ||
} | ||
reusedConnections, err := createBackendSampler(adminRESTConfig, disruptionBackedName, url, monitorapi.ReusedConnectionType) | ||
if err != nil { | ||
return err | ||
} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It looks like you're re-using the disruptionBackedName here, which is probably a bug as both results are probably getting muddled or ignored, but do you actually need a second set of endpoints being monitored here? Typically we'd only have one pair, making sure the APIserver handling the request is up, not that the various APIs within that server are working. Assuming these are handled by the same APIServer, I'd pitch dropping one of these sets and just hit one new+reused pair. The cpu and network load of these requests every second is not insignificant. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I agree, as mentioned in the description #28737 (comment), we're only interested in the availability (codes 200-399), pushed a new version. |
||
|
||
w.disruptionChecker = disruptionlibrary.NewAvailabilityInvariant( | ||
newConnectionTestName, reusedConnectionTestName, | ||
newConnections, reusedConnections, | ||
) | ||
|
||
if err := w.disruptionChecker.StartCollection(ctx, adminRESTConfig, recorder); err != nil { | ||
return err | ||
} | ||
|
||
return nil | ||
} | ||
|
||
func (w *availability) CollectData(ctx context.Context, storageDir string, beginning, end time.Time) (monitorapi.Intervals, []*junitapi.JUnitTestCase, error) { | ||
if w.notSupportedReason != nil { | ||
return nil, nil, w.notSupportedReason | ||
} | ||
// we failed and indicated it during setup. | ||
if w.disruptionChecker == nil { | ||
return nil, nil, nil | ||
} | ||
|
||
return w.disruptionChecker.CollectData(ctx) | ||
} | ||
|
||
func (w *availability) ConstructComputedIntervals(ctx context.Context, startingIntervals monitorapi.Intervals, recordedResources monitorapi.ResourcesMap, beginning, end time.Time) (monitorapi.Intervals, error) { | ||
return nil, w.notSupportedReason | ||
} | ||
|
||
func (w *availability) EvaluateTestsFromConstructedIntervals(ctx context.Context, finalIntervals monitorapi.Intervals) ([]*junitapi.JUnitTestCase, error) { | ||
if w.notSupportedReason != nil { | ||
return nil, w.notSupportedReason | ||
} | ||
// we failed and indicated it during setup. | ||
if w.disruptionChecker == nil { | ||
return nil, nil | ||
} | ||
|
||
return w.disruptionChecker.EvaluateTestsFromConstructedIntervals(ctx, finalIntervals) | ||
} | ||
|
||
func (w *availability) WriteContentToStorage(ctx context.Context, storageDir string, timeSuffix string, finalIntervals monitorapi.Intervals, finalResourceState monitorapi.ResourcesMap) error { | ||
return w.notSupportedReason | ||
} | ||
|
||
func (w *availability) Cleanup(ctx context.Context) error { | ||
return w.notSupportedReason | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TODO: open ticket for this before merge