Documentation ¶
Index ¶
- type 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) 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) GKEAvailabilityZoneOrRegion() (string, LocationType, error)
- func (d *Detector) GKEClusterName() (string, error)
- func (d *Detector) GKEHostID() (string, error)
- func (d *Detector) ProjectID() (string, error)
- type LocationType
- type Platform
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Detector ¶
type Detector struct {
// contains filtered or unexported fields
}
Detector collects resource information for all GCP platforms.
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.
func (*Detector) AppEngineFlexAvailabilityZoneAndRegion ¶ added in v0.32.1
AppEngineFlexAvailabilityZoneAndRegion returns the zone and region in which this program is running.
func (*Detector) AppEngineServiceInstance ¶
AppEngineServiceInstance returns the service instance of the app engine service.
func (*Detector) AppEngineServiceName ¶
AppEngineServiceName returns the service name of the app engine service.
func (*Detector) AppEngineServiceVersion ¶
AppEngineServiceVersion returns the service version of the app engine service.
func (*Detector) AppEngineStandardAvailabilityZone ¶ added in v0.32.1
AppEngineStandardAvailabilityZone returns the zone the app engine service is running in.
func (*Detector) AppEngineStandardCloudRegion ¶ added in v0.32.1
AppEngineStandardCloudRegion returns the region the app engine service is running in.
func (*Detector) CloudPlatform ¶
CloudPlatform returns the platform on which this program is running.
func (*Detector) CloudRunJobExecution ¶ added in v1.15.1
CloudRunJobExecution returns the execution id of the Cloud Run jobs.
func (*Detector) CloudRunJobTaskIndex ¶ added in v1.15.1
CloudRunJobTaskIndex returns the task index for the execution of the Cloud Run jobs.
func (*Detector) FaaSCloudRegion ¶
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
func (*Detector) FaaSName ¶
FaaSName returns the name of the Cloud Run, Cloud Run jobs or Cloud Functions service.
func (*Detector) FaaSVersion ¶
FaaSVersion returns the revision of the Cloud Run or Cloud Functions service.
func (*Detector) GCEAvailabilityZoneAndRegion ¶
GCEAvailabilityZoneAndRegion returns the zone and region in which this program is running.
func (*Detector) GCEHostID ¶
GCEHostID returns the instance ID of the instance on which this program is running.
func (*Detector) GCEHostName ¶
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.
func (*Detector) GCEHostType ¶
GCEHostType returns the machine type of the instance on which this program is running.
func (*Detector) GCEInstanceHostname ¶ added in v1.17.0
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.
func (*Detector) GCEInstanceName ¶ added in v1.17.0
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).
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.
func (*Detector) GKEClusterName ¶
GKEClusterName returns the name if the GKE cluster in which this program is running.
type LocationType ¶
type LocationType int64
const ( UndefinedLocation LocationType = iota Zone Region )