package monitoredresource

Import Path
	contrib.go.opencensus.io/exporter/stackdriver/monitoredresource (on go.dev)

Dependency Relation
	imports 3 packages, and imported by one package

Involved Source Files

	      deprecated.go
	      monitored_resources.go
Package-Level Type Names (total 4, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type AWSEC2Instance (struct)
		AWSEC2Instance represents aws_ec2_instance type monitored resource.
		For definition refer to
		https://cloud.google.com/monitoring/api/resources#tag_aws_ec2_instance
		Deprecated: please use aws.EC2Container from "contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/aws".

		Fields (total 3, all are exported)
			AWSAccount string
				AWSAccount is the AWS account number for the VM.

			InstanceID string
				InstanceID is the instance id of the instance.

			Region string
				Region is the AWS region for the VM. The format of this field is "aws:{region}",
				where supported values for {region} are listed at
				http://docs.aws.amazon.com/general/latest/gr/rande.html.

		Methods (only one, which is exported)
			(*T) MonitoredResource() (resType string, labels map[string]string)
				MonitoredResource returns resource type and resource labels for AWSEC2Instance

		Implements (at least 3, all are exported)
			*T : Interface
			*T : contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/aws.Interface
			*T : contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/gcp.Interface

	 type GCEInstance (struct)
		GCEInstance represents gce_instance type monitored resource.
		For definition refer to
		https://cloud.google.com/monitoring/api/resources#tag_gce_instance
		Deprecated: please use gcp.GCEInstance from "contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/gcp".

		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/aws.Interface
			*T : contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/gcp.Interface

	 type GKEContainer (struct)
		GKEContainer represents gke_container type monitored resource.
		For definition refer to
		https://cloud.google.com/monitoring/api/resources#tag_gke_container
		Deprecated: please use gcp.GKEContainer from "contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/gcp".

		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/aws.Interface
			*T : contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/gcp.Interface

	 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)
			*AWSEC2Instance
			*GCEInstance
			*GKEContainer
			*contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/aws.EC2Instance
			 contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/aws.Interface (interface)
			*contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/gcp.GCEInstance
			*contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/gcp.GKEContainer
			 contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/gcp.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/aws.Interface
			 T : contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/gcp.Interface
		As Outputs Of (at least one exported)
			func Autodetect() Interface
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func contrib.go.opencensus.io/exporter/stackdriver.convertMonitoredResourceToPB(mr Interface) *monitoredrespb.MonitoredResource
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var autoDetected


Package-Level Functions (only one, which is 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:
		3. aws_ec2_instance:

		Returns MonitoredResInterface which implements getLabels() and getType()
		For resource definition go to https://cloud.google.com/monitoring/api/resources


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 and AWS metadata detect function executes only once.

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.