package dcensus

Import Path
	golang.org/x/pkgsite/internal/dcensus (on go.dev)

Dependency Relation
	imports 20 packages, and imported by 5 packages

Involved Source Files

	   d➜ dcensus.go
		Package dcensus provides functionality for debug instrumentation.

	      debug.go
Package-Level Type Names (total 4, in which 2 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Router (struct)
		Router is an http multiplexer that instruments per-handler debugging
		information and census instrumentation.

		Fields (total 3, in which 1 are exported)
			Handler http.Handler
			/* 2 unexporteds ... *//* 2 unexporteds: */
			mux *http.ServeMux
			tagger RouteTagger
		Methods (total 3, all are exported)
			(*T) Handle(route string, handler http.Handler)
				Handle registers handler with the given route. It has the same routing
				semantics as http.ServeMux.

			(*T) HandleFunc(route string, handler http.HandlerFunc)
				HandleFunc is a wrapper around Handle for http.HandlerFuncs.

			( T) ServeHTTP(http.ResponseWriter, *http.Request)
		Implements (at least one exported)
			 T : net/http.Handler
		As Outputs Of (at least one exported)
			func NewRouter(tagger RouteTagger) *Router

	 type RouteTagger (func)
		RouteTagger is a func that can be used to derive a dynamic route tag for an
		incoming request.

		As Inputs Of (at least one exported)
			func NewRouter(tagger RouteTagger) *Router

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 type debugTraceExporter (struct)

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			err error
			exp trace.Exporter
			mu sync.Mutex
		Methods (total 2, in which 1 are exported)
			(*T) ExportSpan(s *trace.SpanData)
				ExportSpan implements the trace.Exporter interface.

			/* one unexported ... *//* one unexported: */
			(*T) onError(err error)
		Implements (at least one exported)
			*T : go.opencensus.io/trace.Exporter

	 type monitoredResource mrpb.MonitoredResource (struct)
		monitoredResource wraps a *mrpb.MonitoredResource to implement the
		monitoredresource.MonitoredResource interface.

		Fields (total 5, in which 2 are exported)
			Labels map[string]string
				Required. Values for all of the labels listed in the associated monitored
				resource descriptor. For example, Compute Engine VM instances use the
				labels `"project_id"`, `"instance_id"`, and `"zone"`.

			Type string
				Required. The monitored resource type. This field must match
				the `type` field of a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object. For
				example, the type of a Compute Engine VM instance is `gce_instance`.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			sizeCache protoimpl.SizeCache
			state protoimpl.MessageState
			unknownFields protoimpl.UnknownFields
		Methods (only one, which is exported)
			(*T) MonitoredResource() (resType string, labels map[string]string)
		Implements (at least 3, all are exported)
			*T : contrib.go.opencensus.io/exporter/stackdriver/monitoredresource.Interface
			*T : contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/aws.Interface
			*T : contrib.go.opencensus.io/exporter/stackdriver/monitoredresource/gcp.Interface


Package-Level Functions (total 9, in which 5 are exported)

	 func Init(cfg *config.Config, views ...*view.View) error
		Init configures tracing and aggregation according to the given Views. If
		running on GCP, Init also configures exporting to StackDriver.

	 func NewRouter(tagger RouteTagger) *Router
		NewRouter creates a new Router, using tagger to tag incoming requests in
		monitoring. If tagger is nil, a default route tagger is used.

	 func NewServer() (http.Handler, error)
		NewServer creates a new http.Handler for serving debug information.

	 func NewViewExporter(cfg *config.Config) (_ *stackdriver.Exporter, err error)
		NewViewExporter creates a StackDriver exporter for stats.

	 func RecordWithTag(ctx context.Context, key tag.Key, val string, m stats.Measurement)
		RecordWithTag is a convenience function for recording a single measurement with a single tag.

	/* 4 unexporteds ... *//* 4 unexporteds: */
	 func dumpAttributes(w io.Writer, m map[string]interface{})
	 func dumpSpanData(s *trace.SpanData) string
	 func exportToStackdriver(ctx context.Context, cfg *config.Config)
		ExportToStackdriver checks to see if the process is running in a GCP
		environment, and if so configures exporting to stackdriver.

	 func stackdriverLabels(cfg *config.Config) *stackdriver.Labels
Package-Level Variables (total 6, all are exported)

	  var KeyStatus tag.Key
		KeyStatus is a tag key named "status".

	  var ServerLatency *view.View
		Customizations of ochttp views. Views are updated as follows:
		 + ClientHost and ServerRoute are added to resp. client and server metrics.
		   Since these are bounded cardinality in our metrics, they are useful to
		   add additional context.
		 + Method tags are removed. We don't have any routes that accept more than
		   one HTTP method.

	  var ServerRequestCount *view.View
		Customizations of ochttp views. Views are updated as follows:
		 + ClientHost and ServerRoute are added to resp. client and server metrics.
		   Since these are bounded cardinality in our metrics, they are useful to
		   add additional context.
		 + Method tags are removed. We don't have any routes that accept more than
		   one HTTP method.

	  var ServerResponseBytes *view.View
		Customizations of ochttp views. Views are updated as follows:
		 + ClientHost and ServerRoute are added to resp. client and server metrics.
		   Since these are bounded cardinality in our metrics, they are useful to
		   add additional context.
		 + Method tags are removed. We don't have any routes that accept more than
		   one HTTP method.

	  var ServerResponseCount *view.View
		Customizations of ochttp views. Views are updated as follows:
		 + ClientHost and ServerRoute are added to resp. client and server metrics.
		   Since these are bounded cardinality in our metrics, they are useful to
		   add additional context.
		 + Method tags are removed. We don't have any routes that accept more than
		   one HTTP method.

	  var ServerViews []*view.View
		Customizations of ochttp views. Views are updated as follows:
		 + ClientHost and ServerRoute are added to resp. client and server metrics.
		   Since these are bounded cardinality in our metrics, they are useful to
		   add additional context.
		 + Method tags are removed. We don't have any routes that accept more than
		   one HTTP method.


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

	/* one unexported ... *//* one unexported: */
	const debugPage = "\n\n
/tracez - trace spans
\n
<...

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.