package zpages

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

Dependency Relation
	imports 19 packages, and imported by one package

Involved Source Files

	      rpcz.go
	      templates.go
	      tracez.go
	   d➜ zpages.go
		Package zpages implements a collection of HTML pages that display RPC stats
		and trace data, and also functions to write that same data in plain text to
		an io.Writer.

		Users can also embed the HTML for stats and traces in custom status pages.

		zpages are currrently work-in-process and cannot display minutely and
		hourly stats correctly.

		Performance

		Installing the zpages has a performance overhead because additional traces
		and stats will be collected in-process. In most cases, we expect this
		overhead will not be significant but it depends on many factors, including
		how many spans your process creates and how richly annotated they are.
Code Examples

	
		package main
		
		import (
			"go.opencensus.io/zpages"
			"log"
			"net/http"
		)
		
		func main() {
			// Both /debug/tracez and /debug/rpcz will be served on the default mux.
			zpages.Handle(nil, "/debug")
			log.Fatal(http.ListenAndServe("127.0.0.1:9999", nil))
		}


Package-Level Type Names (total 11, none are exported)

	/* sort exporteds by: alphabet | popularity */
	/* 11 unexporteds ... *//* 11 unexporteds: */
	 type events ([]T)

		Methods (total 3, all are exported)
			( T) Len() int
			( T) Less(i, j int) bool
			( T) Swap(i, j int)
		Implements (at least 2, in which 1 are exported)
			 T : sort.Interface
			/* at least one unexported ... *//* at least one unexported: */
			 T : github.com/aws/aws-sdk-go/aws/corehandlers.lener

	 type headerData (struct)
		headerData contains data for the header template.

		Fields (only one, which is exported)
			Title string

	 type methodKey (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			method string
			received bool

	 type snapExporter (struct)

		Methods (only one, which is exported)
			( T) ExportView(vd *view.Data)
		Implements (at least one exported)
			 T : go.opencensus.io/stats/view.Exporter

	 type statGroup (struct)
		statGroup aggregates snapshots for a directional category

		Fields (total 2, both are exported)
			Direction string
			Snapshots []*statSnapshot
		Methods (total 3, all are exported)
			(*T) Len() int
			(*T) Less(i, j int) bool
			(*T) Swap(i, j int)
		Implements (at least 2, in which 1 are exported)
			*T : sort.Interface
			/* at least one unexported ... *//* at least one unexported: */
			*T : github.com/aws/aws-sdk-go/aws/corehandlers.lener

	 type statSnapshot (struct)
		statSnapshot holds the data items that are presented in a single row of RPC
		stat information.

		Fields (total 20, all are exported)
			AvgLatencyHour time.Duration
			AvgLatencyMinute time.Duration
			AvgLatencyTotal time.Duration
			CountHour uint64
			CountMinute uint64
			CountTotal uint64
			ErrorsHour uint64
			ErrorsMinute uint64
			ErrorsTotal uint64
			InputRateHour float64
			InputRateMinute float64
			InputRateTotal float64
			Method string
				TODO: compute hour/minute values from cumulative

			OutputRateHour float64
			OutputRateMinute float64
			OutputRateTotal float64
			RPCRateHour float64
			RPCRateMinute float64
			RPCRateTotal float64
			Received bool

	 type statsPage (struct)
		statsPage aggregates stats on the page for 'sent' and 'received' categories

		Fields (only one, which is exported)
			StatGroups []*statGroup
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func getStatsPage() *statsPage

	 type summaryPageData (struct)

		Fields (total 5, all are exported)
			Header []string
			LatencyBucketNames []string
			Links bool
			Rows []summaryPageRow
			TracesEndpoint string
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func getSummaryPageData() summaryPageData

	 type summaryPageRow (struct)

		Fields (total 4, all are exported)
			Active int
			Errors int
			Latency []int
			Name string

	 type traceData (struct)
		traceData contains data for the trace data template.

		Fields (total 3, all are exported)
			Name string
			Num int
			Rows []traceRow
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func traceDataFromSpans(name string, spans []*trace.SpanData) traceData
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func writeTextTraces(w io.Writer, data traceData)

	 type traceRow (struct)

		Fields (total 7, all are exported)
			Fields [3]string
			ParentSpanID trace.SpanID
			SpanContext trace.SpanContext
			SpanContext.SpanID trace.SpanID
			SpanContext.TraceID trace.TraceID
			SpanContext.TraceOptions trace.TraceOptions
			SpanContext.Tracestate *tracestate.Tracestate
		Methods (total 2, in which 1 are exported)
			( T) IsSampled() bool
				IsSampled returns true if the span will be exported.

			/* one unexported ... *//* one unexported: */
			(*T) setIsSampled(sampled bool)
				setIsSampled sets the TraceOptions bit that determines whether the span will be exported.

		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func traceRows(s *trace.SpanData) []traceRow
		As Inputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func traceIDFormatter(r traceRow) template.HTML


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

	 func Handle(mux *http.ServeMux, pathPrefix string)
		Handle adds the z-pages to the given ServeMux rooted at pathPrefix.

	 func WriteHTMLRpczPage(w io.Writer)
		WriteHTMLRpczPage writes an HTML document to w containing per-method RPC stats.

	 func WriteHTMLRpczSummary(w io.Writer)
		WriteHTMLRpczSummary writes HTML to w containing per-method RPC stats.

		It includes neither a header nor footer, so you can embed this data in other pages.

	 func WriteHTMLTracezPage(w io.Writer, spanName string, spanType, spanSubtype int)
		WriteHTMLTracezPage writes an HTML document to w containing locally-sampled trace spans.

	 func WriteHTMLTracezSpans(w io.Writer, spanName string, spanType, spanSubtype int)
		WriteHTMLTracezSpans writes HTML to w containing locally-sampled trace spans.

		It includes neither a header nor footer, so you can embed this data in other pages.

	 func WriteHTMLTracezSummary(w io.Writer)
		WriteHTMLTracezSummary writes HTML to w containing a summary of locally-sampled trace spans.

		It includes neither a header nor footer, so you can embed this data in other pages.

	 func WriteTextRpczPage(w io.Writer)
		WriteTextRpczPage writes formatted text to w containing per-method RPC stats.

	 func WriteTextTracezSpans(w io.Writer, spanName string, spanType, spanSubtype int)
		WriteTextTracezSpans writes formatted text to w containing locally-sampled trace spans.

	 func WriteTextTracezSummary(w io.Writer)
		WriteTextTracezSummary writes formatted text to w containing a summary of locally-sampled trace spans.

	/* 19 unexporteds ... *//* 19 unexporteds: */
	 func canonicalCodeString(code int32) string
	 func countFormatter(num uint64) string
	 func dataRateFormatter(b float64) string
	 func enable()
	 func even(x int) bool
	 func getStatsPage() *statsPage
	 func getSummaryPageData() summaryPageData
	 func init()
	 func msFormatter(d time.Duration) string
	 func parseTemplate(name string) *template.Template
	 func rateFormatter(r float64) string
	 func registerRPCViews()
	 func rpczHandler(w http.ResponseWriter, r *http.Request)
	 func traceDataFromSpans(name string, spans []*trace.SpanData) traceData
	 func traceIDFormatter(r traceRow) template.HTML
	 func traceRows(s *trace.SpanData) []traceRow
	 func traceSpans(spanName string, spanType, spanSubtype int) []*trace.SpanData
	 func tracezHandler(w http.ResponseWriter, r *http.Request)
	 func writeTextTraces(w io.Writer, data traceData)
Package-Level Variables (total 15, in which 1 are exported)

	  var Handler http.Handler
		Handler is deprecated: Use Handle.

	/* 14 unexporteds ... *//* 14 unexporteds: */
	  var canonicalCodes [17]string
	  var defaultLatencies [8]time.Duration
	  var enableOnce sync.Once
	  var footerTemplate *template.Template
	  var fs http.FileSystem
	  var headerTemplate *template.Template
	  var mu sync.Mutex // protects snaps
	  var programStartTime time.Time
	  var snaps map[methodKey]*statSnapshot
	  var statsTemplate *template.Template
	  var summaryTableTemplate *template.Template
	  var templateFunctions template.FuncMap
	  var tracesTableTemplate *template.Template
	  var viewType map[*view.View]bool
		viewType lists the views we are interested in for RPC stats.
		A view's map value indicates whether that view contains data for received
		RPCs.


Package-Level Constants (total 5, none are exported)

	/* 5 unexporteds ... *//* 5 unexporteds: */
	const bytesPerKb = 1024
	const maxTraceMessageLength = 1024
		maxTraceMessageLength is the maximum length of a message in tracez output.

	const spanNameQueryField = "zspanname"
		spanNameQueryField is the header for span name.

	const spanSubtypeQueryField = "zsubtype"
		spanSubtypeQueryField is the header for sub-type:
		* for latency based samples [0, 8] representing the latency buckets, where 0 is the first one;
		* for error based samples, 0 means all, otherwise the error code;

	const spanTypeQueryField = "ztype"
		spanTypeQueryField is the header for type (running = 0, latency = 1, error = 2) to display.

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.