detectors/gcp/app_engine.go

// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package gcp

import "context"

const (
	// See https://cloud.google.com/appengine/docs/flexible/python/migrating#modules
	// for the environment variables available in GAE environments.
	gaeServiceEnv  = "GAE_SERVICE"
	gaeVersionEnv  = "GAE_VERSION"
	gaeInstanceEnv = "GAE_INSTANCE"
	gaeEnv         = "GAE_ENV"
	gaeStandard    = "standard"
)

func (d *Detector) onAppEngineStandard() bool {
	// See https://cloud.google.com/appengine/docs/standard/go111/runtime#environment_variables.
	env, found := d.os.LookupEnv(gaeEnv)
	return found && env == gaeStandard
}

func (d *Detector) onAppEngine() bool {
	_, found := d.os.LookupEnv(gaeServiceEnv)
	return found
}

// AppEngineServiceName returns the service name of the app engine service.
func (d *Detector) AppEngineServiceName() (string, error) {
	if name, found := d.os.LookupEnv(gaeServiceEnv); found {
		return name, nil
	}
	return "", errEnvVarNotFound
}

// AppEngineServiceVersion returns the service version of the app engine service.
func (d *Detector) AppEngineServiceVersion() (string, error) {
	if version, found := d.os.LookupEnv(gaeVersionEnv); found {
		return version, nil
	}
	return "", errEnvVarNotFound
}

// AppEngineServiceInstance returns the service instance of the app engine service.
func (d *Detector) AppEngineServiceInstance() (string, error) {
	if instanceID, found := d.os.LookupEnv(gaeInstanceEnv); found {
		return instanceID, nil
	}
	return "", errEnvVarNotFound
}

// AppEngineFlexAvailabilityZoneAndRegion returns the zone and region in which this program is running.
func (d *Detector) AppEngineFlexAvailabilityZoneAndRegion() (string, string, error) {
	// The GCE metadata server is available on App Engine Flex.
	return d.GCEAvailabilityZoneAndRegion()
}

// AppEngineStandardAvailabilityZone returns the zone the app engine service is running in.
func (d *Detector) AppEngineStandardAvailabilityZone() (string, error) {
	return d.metadata.ZoneWithContext(context.TODO())
}

// AppEngineStandardCloudRegion returns the region the app engine service is running in.
func (d *Detector) AppEngineStandardCloudRegion() (string, error) {
	return d.FaaSCloudRegion()
}