package config

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

Dependency Relation
	imports 21 packages, and imported by 12 packages

Involved Source Files

	   d➜ config.go
		Package config resolves shared configuration for Go Discovery services, and
		provides functions to access this configuration.

		The Init function should be called before using any of the configuration accessors.
Package-Level Type Names (total 3, in which 2 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Config (struct)
		Config holds shared configuration values used in instantiating our server
		components.

		Fields (total 35, all are exported)
			AuthValues []string
				AuthValues is the set of values that could be set on the AuthHeader, in
				order to bypass checks by the cache.

			DBDriver string
			DBHost string
			DBName string
			DBPassword string
			DBPort string
			DBSecondaryHost string
				// DB host to use if first one is down

			DBSecret string
			DBUser string
			DebugPort string
				Ports used for hosting. 'DebugPort' is used for serving HTTP debug pages.

			DisableErrorReporting bool
				DisableErrorReporting disables sending errors to the GCP ErrorReporting system.

			DynamicConfigLocation string
				DynamicConfigLocation is the location (either a file or gs://bucket/object) for
				dynamic configuration.

			FallbackVersionLabel string
				FallbackVersionLabel is used as the VersionLabel when not hosting on
				AppEngine.

			GoogleTagManagerID string
				GoogleTagManagerID is the ID used for GoogleTagManager. It has the
				structure GTM-XXXX.

			IndexURL string
				Discovery environment variables

			InstanceID string
				AppEngine identifiers

			LocationID string
				AppEngine identifiers

			LogLevel string
				Minimum log level below which no logs will be printed.
				Possible values are [debug, info, error, fatal].
				In case of invalid/empty value, all logs will be printed.

			MonitoredResource *mrpb.MonitoredResource
				MonitoredResource represents the resource that is running the current binary.
				It might be a Google AppEngine app or a Kubernetes pod.
				See https://cloud.google.com/monitoring/api/resources for more
				details:
				"An object representing a resource that can be used for monitoring, logging,
				billing, or other purposes. Examples include virtual machine instances,
				databases, and storage devices such as disks.""

			Port string
				Ports used for hosting. 'DebugPort' is used for serving HTTP debug pages.

			ProjectID string
				AppEngine identifiers

			ProxyURL string
				Discovery environment variables

			QueueAudience string
				QueueAudience is used to allow the Cloud Tasks queue to authorize itself
				to the worker. It should be the OAuth 2.0 client ID associated with the
				IAP that is gating access to the worker.

			QueueURL string
				QueueURL is the URL that the Cloud Tasks queue should send requests to.
				It should be used when the worker is not on AppEngine.

			Quota QuotaSettings
			RedisCacheHost string
				Configuration for redis page cache.

			RedisCachePort string
				Configuration for redis page cache.

			RedisHAHost string
				Configuration for redis autocompletion. This is different from the page
				cache instance as it has different availability requirements.

			RedisHAPort string
				Configuration for redis autocompletion. This is different from the page
				cache instance as it has different availability requirements.

			ServeStats bool
				ServeStats determines whether the server has an endpoint that serves statistics for
				benchmarking or other purposes.

			ServiceAccount string
				ServiceAccount is the email of the service account that this process
				is running as when on GCP.

			ServiceID string
				AppEngine identifiers

			UseProfiler bool
				UseProfiler specifies whether to enable Stackdriver Profiler.

			VersionID string
				AppEngine identifiers

			ZoneID string
				AppEngine identifiers

		Methods (total 12, in which 11 are exported)
			(*T) AppVersionLabel() string
				AppVersionLabel returns the version label for the current instance.  This is
				the AppVersionID available, otherwise a string constructed using the
				timestamp of process start.

			(*T) Application() string
				Application returns the name of the running application: "worker",
				"frontend", etc.

			(*T) DBConnInfo() string
				DBConnInfo returns a PostgreSQL connection string constructed from
				environment variables, using the primary database host.

			(*T) DBSecondaryConnInfo() string
				DBSecondaryConnInfo returns a PostgreSQL connection string constructed from
				environment variables, using the backup database host. It returns the
				empty string if no backup is configured.

			(*T) DebugAddr(dflt string) string
				DebugAddr returns the network address on which to serve debugging
				information.

			(*T) DeploymentEnvironment() string
				DeploymentEnvironment returns the deployment environment this process
				is in: usually one of "local", "exp", "dev", "staging" or "prod".

			(*T) Dump(w io.Writer) error
				Dump outputs the current config information to the given Writer.

			(*T) HostAddr(dflt string) string
				HostAddr returns the network on which to serve the primary HTTP service.

			(*T) OnAppEngine() bool
				OnAppEngine reports if the current process is running in an AppEngine
				environment.

			(*T) OnGCP() bool
				OnGCP reports whether the current process is running on Google Cloud
				Platform.

			(*T) OnGKE() bool
				OnGKE reports whether the current process is running on GKE.

			/* one unexported ... *//* one unexported: */
			(*T) dbConnInfo(host string) string
				dbConnInfo returns a PostgresSQL connection string for the given host.

		As Outputs Of (at least one exported)
			func Init(ctx context.Context) (_ *Config, err error)
		As Inputs Of (at least 17, in which 10 are exported)
			func golang.org/x/pkgsite/internal/dcensus.Init(cfg *Config, views ...*view.View) error
			func golang.org/x/pkgsite/internal/dcensus.NewViewExporter(cfg *Config) (_ *stackdriver.Exporter, err error)
			func golang.org/x/pkgsite/internal/log.UseStackdriver(ctx context.Context, cfg *Config, logName string) (_ *logging.Logger, err error)
			func golang.org/x/pkgsite/internal/queue.New(ctx context.Context, cfg *Config, queueName string, numWorkers int, expGetter middleware.ExperimentGetter, processFunc queue.inMemoryProcessFunc) (queue.Queue, error)
			func golang.org/x/pkgsite/internal/worker.NewServer(cfg *Config, scfg worker.ServerConfig) (_ *worker.Server, err error)
			func golang.org/x/pkgsite/cmd/internal/cmdconfig.Experimenter(ctx context.Context, cfg *Config, getter middleware.ExperimentGetter, reportingClient *errorreporting.Client) *middleware.Experimenter
			func golang.org/x/pkgsite/cmd/internal/cmdconfig.ExperimentGetter(ctx context.Context, cfg *Config) middleware.ExperimentGetter
			func golang.org/x/pkgsite/cmd/internal/cmdconfig.Logger(ctx context.Context, cfg *Config, logName string) middleware.Logger
			func golang.org/x/pkgsite/cmd/internal/cmdconfig.OpenDB(ctx context.Context, cfg *Config, bypassLicenseCheck bool) (_ *postgres.DB, err error)
			func golang.org/x/pkgsite/cmd/internal/cmdconfig.ReportingClient(ctx context.Context, cfg *Config) *errorreporting.Client
			/* 7+ unexporteds ... *//* 7+ unexporteds: */
			func processOverrides(cfg *Config, bytes []byte)
			func golang.org/x/pkgsite/internal/dcensus.exportToStackdriver(ctx context.Context, cfg *Config)
			func golang.org/x/pkgsite/internal/dcensus.stackdriverLabels(cfg *Config) *stackdriver.Labels
			func golang.org/x/pkgsite/internal/queue.newGCP(cfg *Config, client *cloudtasks.Client, queueID string) (_ *queue.GCP, err error)
			func golang.org/x/pkgsite/internal/worker.env(cfg *Config) string
			func golang.org/x/pkgsite/cmd/worker.getCacheRedis(ctx context.Context, cfg *Config) *redis.Client
			func golang.org/x/pkgsite/cmd/worker.getHARedis(ctx context.Context, cfg *Config) *redis.Client

	 type QuotaSettings (struct)
		QuotaSettings is config for internal/middleware/quota.go

		Fields (total 7, all are exported)
			AuthValues []string
				AuthValues is the set of values that could be set on the AuthHeader, in
				order to bypass checks by the quota server.

			Burst int
				// maximum requests per second, per block; the size of the token bucket

			Enable bool
			HMACKey []byte
				// key for obfuscating IPs

			MaxEntries int
				// maximum number of entries to keep track of

			QPS int
				// allowed queries per second, per IP block

			RecordOnly *bool
				Record data about blocking, but do not actually block.
				This is a *bool, so we can distinguish "not present" from "false" in an override

		As Inputs Of (at least one exported)
			func golang.org/x/pkgsite/internal/middleware.Quota(settings QuotaSettings, client *redis.Client) middleware.Middleware

	/* one unexported ... *//* one unexported: */
	 type configOverride (struct)
		configOverride holds selected config settings that can be dynamically overridden.

		Fields (total 4, all are exported)
			DBHost string
			DBName string
			DBSecondaryHost string
			Quota QuotaSettings


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

	 func GetEnv(key, fallback string) string
		GetEnv looks up the given key from the environment, returning its value if
		it exists, and otherwise returning the given fallback value.

	 func GetEnvFloat64(key string, fallback float64) float64
		GetEnvFloat64 looks up the given key from the environment and expects a
		float64, returning the float64 value if it exists, and otherwise returning
		the given fallback value.

	 func GetEnvInt(key string, fallback int) int
		GetEnvInt looks up the given key from the environment and expects an integer,
		returning the integer value if it exists, and otherwise returning the given
		fallback value.
		If the environment variable has a value but it can't be parsed as an integer,
		GetEnvInt terminates the program.

	 func Init(ctx context.Context) (_ *Config, err error)
		Init resolves all configuration values provided by the config package. It
		must be called before any configuration values are used.

	 func ValidateAppVersion(appVersion string) error
		ValidateAppVersion validates that appVersion follows the expected format
		defined by AppVersionFormat.

	/* 8 unexporteds ... *//* 8 unexporteds: */
	 func chooseOne(configVar string) string
		chooseOne selects one entry at random from a whitespace-separated
		string. It returns the empty string if there are no elements.

	 func gceMetadata(ctx context.Context, name string) (_ string, err error)
		gceMetadata reads a metadata value from GCE.
		For the possible values of name, see
		https://cloud.google.com/appengine/docs/standard/java/accessing-instance-metadata.

	 func overrideBool(name string, field **bool, val *bool)
	 func overrideInt(name string, field *int, val int)
	 func overrideString(name string, field *string, val string)
	 func parseCommaList(s string) []string
	 func processOverrides(cfg *Config, bytes []byte)
	 func readOverrideFile(ctx context.Context, bucketName, objName string) (_ []byte, err error)
Package-Level Constants (total 7, all are exported)

	const AppVersionFormat = "20060102t150405"
		AppVersionFormat is the expected format of the app version timestamp.

	const BypassCacheAuthHeader = "X-Go-Discovery-Auth-Bypass-Cache"
		BypassCacheAuthHeader is the header key used by the frontend server to
		know that a request can bypass cache.

	const BypassErrorReportingHeader = "X-Go-Discovery-Bypass-Error-Reporting"
		BypassErrorReportingHeader is the header key used by the ErrorReporting middleware
		to avoid calling the errorreporting service.

	const BypassQuotaAuthHeader = "X-Go-Discovery-Auth-Bypass-Quota"
		BypassQuotaAuthHeader is the header key used by the frontend server to know
		that a request can bypass the quota server.

	const SourceTimeout time.Duration = 60000000000
		SourceTimeout is the value of the timeout for source.Client, which is used
		to fetch source code from third party URLs.

	const StatementTimeout time.Duration = 1800000000000
		StatementTimeout is the value of the Postgres statement_timeout parameter.
		Statements that run longer than this are terminated.
		10 minutes is the App Engine standard request timeout,
		but we set this longer for the worker.

	const TaskIDChangeIntervalFrontend time.Duration = 1800000000000
		TaskIDChangeIntervalFrontend is the time period during which a given module
		version can be re-enqueued to frontend tasks.

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.