gcp

README

GCP Resource detection library (DEPRECATED)

[!WARNING] This package is deprecated and will no longer be maintained. Please use upstream go.opentelemetry.io/contrib/detectors/gcp instead.

This is a library intended to be used by Upstream OpenTelemetry resource detectors. It exists within this repository to allow for integration testing of the detection functions in real GCP environments.

Documentation

Overview

Package gcp provides functions for detecting the GCP platform and resources.

Deprecated: This package is deprecated and will no longer be maintained. Use go.opentelemetry.io/contrib/detectors/gcp instead.

Index

• type Detector
  • func NewDetector() *Detector
  • func (d *Detector) AppEngineFlexAvailabilityZoneAndRegion() (string, string, error)
  • func (d *Detector) AppEngineServiceInstance() (string, error)
  • func (d *Detector) AppEngineServiceName() (string, error)
  • func (d *Detector) AppEngineServiceVersion() (string, error)
  • func (d *Detector) AppEngineStandardAvailabilityZone() (string, error)
  • func (d *Detector) AppEngineStandardCloudRegion() (string, error)
  • func (d *Detector) BareMetalSolutionCloudRegion() (string, error)
  • func (d *Detector) BareMetalSolutionInstanceID() (string, error)
  • func (d *Detector) BareMetalSolutionProjectID() (string, error)
  • func (d *Detector) CloudPlatform() Platform
  • func (d *Detector) CloudRunJobExecution() (string, error)
  • func (d *Detector) CloudRunJobTaskIndex() (string, error)
  • func (d *Detector) FaaSCloudRegion() (string, error)
  • func (d *Detector) FaaSID() (string, error)
  • func (d *Detector) FaaSName() (string, error)
  • func (d *Detector) FaaSVersion() (string, error)
  • func (d *Detector) GCEAvailabilityZoneAndRegion() (string, string, error)
  • func (d *Detector) GCEHostID() (string, error)
  • func (d *Detector) GCEHostName() (string, error)
  • func (d *Detector) GCEHostType() (string, error)
  • func (d *Detector) GCEInstanceHostname() (string, error)
  • func (d *Detector) GCEInstanceName() (string, error)
  • func (d *Detector) GCEManagedInstanceGroup() (ManagedInstanceGroup, error)
  • func (d *Detector) GKEAvailabilityZoneOrRegion() (string, LocationType, error)
  • func (d *Detector) GKEClusterName() (string, error)
  • func (d *Detector) GKEHostID() (string, error)
  • func (d *Detector) GKEHostType() (string, error)
  • func (d *Detector) ProjectID() (string, error)
• type LocationType
• type ManagedInstanceGroup
• type Platform

Types

type Detector

type Detector struct {
	// contains filtered or unexported fields
}

Detector collects resource information for all GCP platforms.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func NewDetector

func NewDetector() *Detector

NewDetector returns a *Detector which can get detect the platform, and fetch attributes of the platform on which it is running.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) AppEngineFlexAvailabilityZoneAndRegion

func (d *Detector) AppEngineFlexAvailabilityZoneAndRegion() (string, string, error)

AppEngineFlexAvailabilityZoneAndRegion returns the zone and region in which this program is running.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) AppEngineServiceInstance

func (d *Detector) AppEngineServiceInstance() (string, error)

AppEngineServiceInstance returns the service instance of the app engine service.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) AppEngineServiceName

func (d *Detector) AppEngineServiceName() (string, error)

AppEngineServiceName returns the service name of the app engine service.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) AppEngineServiceVersion

func (d *Detector) AppEngineServiceVersion() (string, error)

AppEngineServiceVersion returns the service version of the app engine service.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) AppEngineStandardAvailabilityZone

func (d *Detector) AppEngineStandardAvailabilityZone() (string, error)

AppEngineStandardAvailabilityZone returns the zone the app engine service is running in.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) AppEngineStandardCloudRegion

func (d *Detector) AppEngineStandardCloudRegion() (string, error)

AppEngineStandardCloudRegion returns the region the app engine service is running in.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) BareMetalSolutionCloudRegion

func (d *Detector) BareMetalSolutionCloudRegion() (string, error)

BareMetalSolutionCloudRegion returns the region from the BMS_REGION environment variable.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) BareMetalSolutionInstanceID

func (d *Detector) BareMetalSolutionInstanceID() (string, error)

BareMetalSolutionInstanceID returns the instance ID from the BMS_INSTANCE_ID environment variable.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) BareMetalSolutionProjectID

func (d *Detector) BareMetalSolutionProjectID() (string, error)

BareMetalSolutionProjectID returns the project ID from the BMS_PROJECT_ID environment variable.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) CloudPlatform

func (d *Detector) CloudPlatform() Platform

CloudPlatform returns the platform on which this program is running.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) CloudRunJobExecution

func (d *Detector) CloudRunJobExecution() (string, error)

CloudRunJobExecution returns the execution id of the Cloud Run jobs.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) CloudRunJobTaskIndex

func (d *Detector) CloudRunJobTaskIndex() (string, error)

CloudRunJobTaskIndex returns the task index for the execution of the Cloud Run jobs.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) FaaSCloudRegion

func (d *Detector) FaaSCloudRegion() (string, error)

FaaSCloudRegion detects region from the metadata server. It is in the format /projects/<project_number>/regions/<region>.

https://cloud.google.com/run/docs/reference/container-contract#metadata-server

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) FaaSID

func (d *Detector) FaaSID() (string, error)

FaaSID returns the instance id of the Cloud Run or Cloud Function.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) FaaSName

func (d *Detector) FaaSName() (string, error)

FaaSName returns the name of the Cloud Run, Cloud Run jobs or Cloud Functions service.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) FaaSVersion

func (d *Detector) FaaSVersion() (string, error)

FaaSVersion returns the revision of the Cloud Run or Cloud Functions service.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) GCEAvailabilityZoneAndRegion

func (d *Detector) GCEAvailabilityZoneAndRegion() (string, string, error)

GCEAvailabilityZoneAndRegion returns the zone and region in which this program is running.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) GCEHostID

func (d *Detector) GCEHostID() (string, error)

GCEHostID returns the instance ID of the instance on which this program is running.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) GCEHostName

func (d *Detector) GCEHostName() (string, error)

GCEHostName returns the instance name of the instance on which this program is running. Recommended to use GCEInstanceName() or GCEInstanceHostname() to more accurately reflect which value is returned.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) GCEHostType

func (d *Detector) GCEHostType() (string, error)

GCEHostType returns the machine type of the instance on which this program is running.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) GCEInstanceHostname

func (d *Detector) GCEInstanceHostname() (string, error)

GCEInstanceHostname returns the full value of the default or custom hostname of the instance on which this program is running. See https://cloud.google.com/compute/docs/instances/custom-hostname-vm.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) GCEInstanceName

func (d *Detector) GCEInstanceName() (string, error)

GCEInstanceName returns the instance name of the instance on which this program is running. This is the value visible in the Cloud Console UI, and the prefix for the default hostname of the instance as defined by the default internal DNS name (see https://cloud.google.com/compute/docs/internal-dns#instance-fully-qualified-domain-names).

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) GCEManagedInstanceGroup

func (d *Detector) GCEManagedInstanceGroup() (ManagedInstanceGroup, error)

GCEManagedInstanceGroup returns the managed instance group that created this VM, if any.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) GKEAvailabilityZoneOrRegion

func (d *Detector) GKEAvailabilityZoneOrRegion() (string, LocationType, error)

GKEAvailabilityZoneOrRegion returns the location of the cluster and whether the cluster is zonal or regional.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) GKEClusterName

func (d *Detector) GKEClusterName() (string, error)

GKEClusterName returns the name if the GKE cluster in which this program is running.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) GKEHostID

func (d *Detector) GKEHostID() (string, error)

GKEHostID returns the instance ID of the instance on which this program is running.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) GKEHostType

func (d *Detector) GKEHostType() (string, error)

GKEHostType returns the machine type of the instance on which this program is running.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

func (*Detector) ProjectID

func (d *Detector) ProjectID() (string, error)

ProjectID returns the ID of the project in which this program is running.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

type LocationType

type LocationType int64

LocationType represents the location type (Zone or Region).

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

const (
	UndefinedLocation LocationType = iota
	Zone
	Region
)

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

type ManagedInstanceGroup

type ManagedInstanceGroup struct {
	Name     string
	Location string
	Type     LocationType
}

ManagedInstanceGroup describes a Google Compute Engine Managed Instance Group.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

type Platform

type Platform int64

Platform represents a Google Cloud platform type.

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.

const (
	UnknownPlatform Platform = iota
	GKE
	GCE
	CloudRun
	CloudRunJob
	CloudRunWorkerPool
	CloudFunctions
	AppEngineStandard
	AppEngineFlex
	BareMetalSolution
)

Deprecated: Use go.opentelemetry.io/contrib/detectors/gcp instead.