package resource

Import Path
	go.opencensus.io/resource (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 3 packages

Involved Source Files

	   d➜ resource.go
		Package resource provides functionality for resource, which capture
		identifying information about the entities for which signals are exported.
Package-Level Type Names (total 2, both are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Detector (func)
		Detector attempts to detect resource information.
		If the detector cannot find resource information, the returned resource is nil but no
		error is returned.
		An error is only returned on unexpected failures.

		As Outputs Of (at least one exported)
			func MultiDetector(detectors ...Detector) Detector
		As Inputs Of (at least 2, in which 1 are exported)
			func MultiDetector(detectors ...Detector) Detector
			/* at least one unexported ... *//* at least one unexported: */
			func detectAll(ctx context.Context, detectors ...Detector) (*Resource, error)

	 type Resource (struct)
		Resource describes an entity about which identifying information and metadata is exposed.
		For example, a type "k8s.io/container" may hold labels describing the pod name and namespace.

		Fields (total 2, both are exported)
			Labels map[string]string
			Type string
		As Outputs Of (at least 4, in which 1 are exported)
			func FromEnv(context.Context) (*Resource, error)
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			func detectAll(ctx context.Context, detectors ...Detector) (*Resource, error)
			func merge(a, b *Resource) *Resource
			func contrib.go.opencensus.io/exporter/stackdriver.resourcepbToResource(rsc *resourcepb.Resource) *Resource
		As Inputs Of (at least 4, in which 2 are exported)
			func go.opencensus.io/stats/view.Meter.SetResource(*Resource)
			func contrib.go.opencensus.io/exporter/stackdriver.DefaultMapResource(res *Resource) *monitoredrespb.MonitoredResource
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func merge(a, b *Resource) *Resource
			func go.opencensus.io/stats/view.viewToMetric(v *view.viewInternal, r *Resource, now time.Time, startTime time.Time) *metricdata.Metric
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var contrib.go.opencensus.io/exporter/stackdriver.globalResource *Resource


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

	 func DecodeLabels(s string) (map[string]string, error)
		DecodeLabels decodes a serialized label map as used in the OC_RESOURCE_LABELS variable.
		A list of labels of the form `<key1>="<value1>",<key2>="<value2>",...` is accepted.
		Domain names and paths are accepted as label keys.
		Most users will want to use FromEnv instead.

	 func EncodeLabels(labels map[string]string) string
		EncodeLabels encodes a labels map to a string as provided via the OC_RESOURCE_LABELS environment variable.

	 func FromEnv(context.Context) (*Resource, error)
		FromEnv is a detector that loads resource information from the OC_RESOURCE_TYPE
		and OC_RESOURCE_labelS environment variables.

	 func MultiDetector(detectors ...Detector) Detector
		MultiDetector returns a Detector that calls all input detectors in order and
		merges each result with the previous one. In case a type of label key is already set,
		the first set value is takes precedence.
		It returns on the first error that a sub-detector encounters.

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 func detectAll(ctx context.Context, detectors ...Detector) (*Resource, error)
		detectall calls all input detectors sequentially an merges each result with the previous one.
		It returns on the first error that a sub-detector encounters.

	 func merge(a, b *Resource) *Resource
		merge resource information from b into a. In case of a collision, a takes precedence.


Package-Level Variables (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	  var labelRegex *regexp.Regexp
Package-Level Constants (total 2, both are exported)

	const EnvVarLabels = "OC_RESOURCE_LABELS"
		Environment variables used by FromEnv to decode a resource.

	const EnvVarType = "OC_RESOURCE_TYPE"
		Environment variables used by FromEnv to decode a resource.

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.