knative.dev/pkg@v0.0.0-20260602142205-ac97e43f6622/test/monitoring/doc.go (about)

     1  /*
     2  Copyright 2019 The Knative Authors
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  /*
    18  Package monitoring provides common methods for all the monitoring components used in the tests
    19  
    20  This package exposes following methods:
    21  
    22  	CheckPortAvailability(port int) error
    23  		Checks if the given port is available
    24  	GetPods(kubeClientset kubernetes.Interface, app string) (*v1.PodList, error)
    25  		Gets the list of pods that satisfy the label selector app=<app>
    26  	Cleanup(pid int) error
    27  		Kill the current port forwarding process running in the background
    28  	PortForward(logf logging.FormatLogger, podList *v1.PodList, localPort, remotePort int) (int, error)
    29  		Create a background process that will port forward the first pod from the local to remote port
    30  		It returns the process id for the background process created.
    31  */
    32  package monitoring