istio.io/istio@v0.0.0-20240520182934-d79c90f27776/pkg/test/framework/components/opentelemetry/opentelemetry-collector.go (about)

     1  // Copyright Istio Authors
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package opentelemetry
    16  
    17  import (
    18  	"testing"
    19  
    20  	"istio.io/istio/pkg/test/framework/components/cluster"
    21  	"istio.io/istio/pkg/test/framework/resource"
    22  )
    23  
    24  // Config represents the configuration for setting up an opentelemetry
    25  // collector.
    26  type Config struct {
    27  	// Cluster to be used in a multicluster environment
    28  	Cluster cluster.Cluster
    29  
    30  	// HTTP Address of ingress gateway of the cluster to be used to install open telemetry collector in.
    31  	IngressAddr string
    32  }
    33  
    34  // Instance represents a opencensus collector deployment on kubernetes.
    35  type Instance interface {
    36  	resource.Resource
    37  }
    38  
    39  // New creates and returns a new instance of otel.
    40  func New(ctx resource.Context, c Config) (Instance, error) {
    41  	return newCollector(ctx, c)
    42  }
    43  
    44  // NewOrFail returns a new otel instance or fails the test.
    45  func NewOrFail(t *testing.T, ctx resource.Context, c Config) Instance {
    46  	t.Helper()
    47  	i, err := New(ctx, c)
    48  	if err != nil {
    49  		t.Fatalf("opentelemetry.NewOrFail: %v", err)
    50  	}
    51  	return i
    52  }