package log

Import Path
	github.com/joonix/log (on go.dev)

Dependency Relation
	imports 10 packages, and imported by one package

Involved Source Files

	      formatter.go
	      stackdriver.go
Package-Level Type Names (total 4, in which 3 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Format (func)
		Format configuration of the logrus formatter output.

		As Inputs Of (at least one exported)
			func NewFormatter(opts ...Format) *Formatter

	 type Formatter (struct)
		Formatter that is called on by logrus.

		Fields (total 4, all are exported)
			DisableTimestamp bool
				DisableTimestamp allows disabling automatic timestamps in output

			PrettyPrint bool
				PrettyPrint will indent all json logs

			SeverityMap map[string]string
				SeverityMap allows for customizing the names for keys of the log level field.

			TimestampFormat func(logrus.Fields, time.Time) error
				TimestampFormat sets the format used for marshaling timestamps.

		Methods (only one, which is exported)
			(*T) Format(entry *logrus.Entry) ([]byte, error)
				Format the log entry. Implements logrus.Formatter.

		Implements (at least one exported)
			*T : github.com/sirupsen/logrus.Formatter
		As Outputs Of (at least one exported)
			func NewFormatter(opts ...Format) *Formatter
		As Inputs Of (at least 3, all are exported)
			func DisableTimestampFormat(f *Formatter) error
			func PrettyPrintFormat(f *Formatter) error
			func StackdriverFormat(f *Formatter) error

	 type HTTPRequest (struct)
		HTTPRequest contains an http.Request as well as additional
		information about the request and its response.
		https://github.com/googleapis/google-cloud-go/blob/v0.39.0/logging/logging.go#L617

		Fields (total 9, all are exported)
			CacheHit bool
				CacheHit reports whether an entity was served from cache (with or without
				validation).

			CacheValidatedWithOriginServer bool
				CacheValidatedWithOriginServer reports whether the response was
				validated with the origin server before being served from cache. This
				field is only meaningful if CacheHit is true.

			Latency time.Duration
				Latency is the request processing latency on the server, from the time the request was
				received until the response was sent.

			LocalIP string
				LocalIP is the IP address (IPv4 or IPv6) of the origin server that the request
				was sent to.

			RemoteIP string
				RemoteIP is the IP address (IPv4 or IPv6) of the client that issued the
				HTTP request. Examples: "192.168.1.1", "FE80::0202:B3FF:FE1E:8329".

			Request *http.Request
				Request is the http.Request passed to the handler.

			RequestSize int64
				RequestSize is the size of the HTTP request message in bytes, including
				the request headers and the request body.

			ResponseSize int64
				ResponseSize is the size of the HTTP response message sent back to the client, in bytes,
				including the response headers and the response body.

			Status int
				Status is the response code indicating the status of the response.
				Examples: 200, 404.

		Methods (only one, which is exported)
			( T) MarshalJSON() ([]byte, error)
		Implements (at least one exported)
			 T : encoding/json.Marshaler

	/* one unexported ... *//* one unexported: */
	 type logEntry (struct)

		Fields (total 15, all are exported)
			CacheFillBytes string
			CacheHit bool
			CacheLookup bool
			CacheValidatedWithOriginServer bool
			Latency *durpb.Duration
			Protocol string
			Referer string
			RemoteIP string
			RequestMethod string
			RequestSize string
			RequestURL string
			ResponseSize string
			ServerIP string
			Status int
			UserAgent string


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

	 func DisableTimestampFormat(f *Formatter) error
	 func NewFormatter(opts ...Format) *Formatter
		NewFormatter with optional options. Defaults to the Stackdriver option.

	 func PrettyPrintFormat(f *Formatter) error
	 func StackdriverFormat(f *Formatter) error
		StackdriverFormat maps values to be recognized by the Google Cloud Platform.
		https://cloud.google.com/logging/docs/agent/configuration#special-fields

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 func fixUTF8(s string) string
		fixUTF8 is a helper that fixes an invalid UTF-8 string by replacing
		invalid UTF-8 runes with the Unicode replacement character (U+FFFD).
		See Issue https://github.com/googleapis/google-cloud-go/issues/1383.

	 func prefixFieldClashes(data logrus.Fields, reportCaller bool)
Package-Level Variables (only one, which is exported)

	  var DefaultFormat func(f *Formatter) error
		DefaultFormat is Stackdriver.

The pages are generated with Golds v0.3.2. (GOOS=linux 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.