Package: contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/gcp

package gcp Import Path contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/gcp (on go.dev) Dependency Relation imports 9 packages, and imported by 2 packages

Involved Source Files gcp_metadata_config.go monitored_resources.go

Package-Level Type Names (total 4, in which 3 are exported)

/* sort exporteds by: alphabet | popularity */

type GCEInstance (struct) GCEInstance represents gce_instance type monitored resource. For definition refer to https://cloud.google.com/monitoring/api/resources#tag_gce_instance Fields (total 3, all are exported) InstanceID string InstanceID is the numeric VM instance identifier assigned by Compute Engine. ProjectID string ProjectID is the identifier of the GCP project associated with this resource, such as "my-project". Zone string Zone is the Compute Engine zone in which the VM is running. Methods (only one, which is exported) (*T) MonitoredResource() (resType string, labels map[string]string) MonitoredResource returns resource type and resource labels for GCEInstance Implements (at least 3, all are exported) *T : Interface *T : contrib.go.opencensus.io/exporter/stackdriver/monitoredresource.Interface *T : contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/aws.Interface As Outputs Of (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ func createGCEInstanceMonitoredResource(gcpMetadata *gcpMetadata) *GCEInstance

type GKEContainer (struct) GKEContainer represents gke_container type monitored resource. For definition refer to https://cloud.google.com/monitoring/api/resources#tag_gke_container Fields (total 8, all are exported) ClusterName string ClusterName is the name for the cluster the container is running in. ContainerName string ContainerName is the name of the container. InstanceID string InstanceID is the numeric VM instance identifier assigned by Compute Engine. LoggingMonitoringV2Enabled bool LoggingMonitoringV2Enabled is the identifier if user enabled V2 logging and monitoring for GKE NamespaceID string NamespaceID is the identifier for the cluster namespace the container is running in PodID string PodID is the identifier for the pod the container is running in. ProjectID string ProjectID is the identifier of the GCP project associated with this resource, such as "my-project". Zone string Zone is the Compute Engine zone in which the VM is running. Methods (only one, which is exported) (*T) MonitoredResource() (resType string, labels map[string]string) MonitoredResource returns resource type and resource labels for GKEContainer Implements (at least 3, all are exported) *T : Interface *T : contrib.go.opencensus.io/exporter/stackdriver/monitoredresource.Interface *T : contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/aws.Interface As Outputs Of (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ func createGKEContainerMonitoredResource(gcpMetadata *gcpMetadata) *GKEContainer

type Interface (interface) Interface is a type that represent monitor resource that satisfies monitoredresource.Interface Methods (only one, which is exported) ( T) MonitoredResource() (resType string, labels map[string]string) MonitoredResource returns the resource type and resource labels. Implemented By (at least 9, in which 8 are exported) *GCEInstance *GKEContainer *contrib.go.opencensus.io/exporter/stackdriver/monitoredresource.AWSEC2Instance *contrib.go.opencensus.io/exporter/stackdriver/monitoredresource.GCEInstance *contrib.go.opencensus.io/exporter/stackdriver/monitoredresource.GKEContainer contrib.go.opencensus.io/exporter/stackdriver/monitoredresource.Interface (interface) *contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/aws.EC2Instance contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/aws.Interface (interface) /* at least one unexported ... *//* at least one unexported: */ *golang.org/x/pkgsite/internal/dcensus.monitoredResource Implements (at least 2, both are exported) T : contrib.go.opencensus.io/exporter/stackdriver/monitoredresource.Interface T : contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/aws.Interface As Outputs Of (at least 2, in which 1 are exported) func Autodetect() Interface /* at least one unexported ... *//* at least one unexported: */ func detectResourceType(gcpMetadata *gcpMetadata) Interface As Types Of (only one, which is unexported) /* one unexported ... *//* one unexported: */ var autoDetected

/* one unexported ... *//* one unexported: */

type gcpMetadata (struct) gcpMetadata represents metadata retrieved from GCP (GKE and GCE) environment. Fields (total 8, none are exported) /* 8 unexporteds ... *//* 8 unexporteds: */ clusterName string clusterName is the name for the cluster the container is running in. containerName string containerName is the name of the container. instanceID string instanceID is the numeric VM instance identifier assigned by Compute Engine. monitoringV2 bool namespaceID string namespaceID is the identifier for the cluster namespace the container is running in podID string podID is the identifier for the pod the container is running in. projectID string projectID is the identifier of the GCP project associated with this resource, such as "my-project". zone string zone is the Compute Engine zone in which the VM is running. As Outputs Of (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ func retrieveGCPMetadata() *gcpMetadata As Inputs Of (at least 3, none are exported) /* 3+ unexporteds ... *//* 3+ unexporteds: */ func createGCEInstanceMonitoredResource(gcpMetadata *gcpMetadata) *GCEInstance func createGKEContainerMonitoredResource(gcpMetadata *gcpMetadata) *GKEContainer func detectResourceType(gcpMetadata *gcpMetadata) Interface

Package-Level Functions (total 6, in which 1 are exported)

func Autodetect() Interface Autodetect auto detects monitored resources based on the environment where the application is running. It supports detection of following resource types 1. gke_container: 2. gce_instance: Returns MonitoredResInterface which implements getLabels() and getType() For resource definition go to https://cloud.google.com/monitoring/api/resources

/* 5 unexporteds ... *//* 5 unexporteds: */

func createGCEInstanceMonitoredResource(gcpMetadata *gcpMetadata) *GCEInstance createGCEInstanceMonitoredResource creates a gce_instance monitored resource gcpMetadata contains GCP (GKE or GCE) specific attributes.

func createGKEContainerMonitoredResource(gcpMetadata *gcpMetadata) *GKEContainer createGKEContainerMonitoredResource creates a gke_container monitored resource gcpMetadata contains GCP (GKE or GCE) specific attributes.

func detectResourceType(gcpMetadata *gcpMetadata) Interface detectResourceType determines the resource type. gcpMetadata contains GCP (GKE or GCE) specific attributes.

func logError(err error) logError logs error only if the error is present and it is not 'not defined'

func retrieveGCPMetadata() *gcpMetadata retrieveGCPMetadata retrieves value of each Attribute from Metadata Server in GKE container and GCE instance environment. Some attributes are retrieved from the system environment. This is only executed detectOnce.

Package-Level Variables (total 2, neither is exported) /* 2 unexporteds ... *//* 2 unexporteds: */

var autoDetected Interface autoDetected is the metadata detected after the first execution of Autodetect function.

var detectOnce sync.Once detectOnce is used to make sure GCP metadata detect function executes only once.