package metricexport

Import Path
	go.opencensus.io/metric/metricexport (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 3 packages

Involved Source Files

	   d➜ doc.go
		Package metricexport contains support for exporting metric data.

		This is an EXPERIMENTAL package, and may change in arbitrary ways without
		notice.

	      export.go
	      reader.go
Package-Level Type Names (total 5, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Exporter (interface)
		Exporter is an interface that exporters implement to export the metric data.

		Methods (only one, which is exported)
			( T) ExportMetrics(ctx context.Context, data []*metricdata.Metric) error
		Implemented By (at least 4, in which 1 are exported)
			*contrib.go.opencensus.io/exporter/stackdriver.Exporter
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*contrib.go.opencensus.io/exporter/prometheus.descExporter
			*contrib.go.opencensus.io/exporter/prometheus.metricExporter
			*contrib.go.opencensus.io/exporter/stackdriver.statsExporter
		As Inputs Of (at least 2, both are exported)
			func NewIntervalReader(reader *Reader, exporter Exporter) (*IntervalReader, error)
			func (*Reader).ReadAndExport(exporter Exporter)

	 type IntervalReader (struct)
		IntervalReader periodically reads metrics from all producers registered
		with producer manager and exports those metrics using provided
		exporter. Call Reader.Stop() to stop the reader.

		Fields (total 7, in which 1 are exported)
			ReportingInterval time.Duration
				ReportingInterval it the time duration between two consecutive
				metrics reporting. defaultReportingDuration  is used if it is not set.
				It cannot be set lower than minimumReportingDuration.

			/* 6 unexporteds ... *//* 6 unexporteds: */
			done chan bool
			exporter Exporter
			mu sync.RWMutex
			quit chan bool
			reader *Reader
			timer *time.Ticker
		Methods (total 3, in which 2 are exported)
			(*T) Start() error
				Start starts the IntervalReader which periodically reads metrics from all
				producers registered with global producer manager. If the reporting interval
				is not set prior to calling this function then default reporting interval
				is used.

			(*T) Stop()
				Stop stops the reader from reading and exporting metrics.
				Additional call to Stop are no-ops.

			/* one unexported ... *//* one unexported: */
			(*T) startInternal()
		As Outputs Of (at least one exported)
			func NewIntervalReader(reader *Reader, exporter Exporter) (*IntervalReader, error)

	 type Reader (struct)
		Reader reads metrics from all producers registered
		with producer manager and exports those metrics using provided
		exporter.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			sampler trace.Sampler
			spanName string
		Methods (only one, which is exported)
			(*T) ReadAndExport(exporter Exporter)
				ReadAndExport reads metrics from all producer registered with
				producer manager and then exports them using provided exporter.

		As Outputs Of (at least one exported)
			func NewReader(o ...ReaderOption) *Reader
		As Inputs Of (at least one exported)
			func NewIntervalReader(reader *Reader, exporter Exporter) (*IntervalReader, error)
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var golang.org/x/pkgsite/cmd/prober.metricReader *metricexport.Reader

	 type ReaderOption (func)
		ReaderOption apply changes to ReaderOptions.

		As Outputs Of (at least one exported)
			func WithSpanName(spanName string) ReaderOption
		As Inputs Of (at least one exported)
			func NewReader(o ...ReaderOption) *Reader

	 type ReaderOptions (struct)
		ReaderOptions contains options pertaining to metrics reader.

		Fields (only one, which is exported)
			SpanName string
				SpanName is the name used for span created to export metrics.



Package-Level Functions (total 3, all are exported)

	 func NewIntervalReader(reader *Reader, exporter Exporter) (*IntervalReader, error)
		NewIntervalReader creates a reader. Once started it periodically
		reads metrics from all producers and exports them using provided exporter.

	 func NewReader(o ...ReaderOption) *Reader
		NewReader returns a reader configured with specified options.

	 func WithSpanName(spanName string) ReaderOption
		WithSpanName makes new reader to use given span name when exporting metrics.


Package-Level Variables (total 6, none are exported)

	/* 6 unexporteds ... *//* 6 unexporteds: */
	  var defaultSampler trace.Sampler
	  var errAlreadyStarted error
	  var errExporterNil error
	  var errIntervalReaderNil error
	  var errReaderNil error
	  var errReportingIntervalTooLow error
Package-Level Constants (total 3, none are exported)

	/* 3 unexporteds ... *//* 3 unexporteds: */
	const defaultReportingDuration time.Duration = 60000000000
	const defaultSpanName = "ExportMetrics"
	const minimumReportingDuration time.Duration = 1000000000

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.