Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

usage

package

Go to main page

Versions in this module

v1

v1.22.0-beta9

Jun 25, 2026

v1.22.0-beta8

Jun 15, 2026

v1.22.0-beta7

Jun 4, 2026

v1.22.0-beta6

May 29, 2026

v1.22.0-beta5

May 19, 2026

v1.22.0-beta4

May 6, 2026

v1.22.0-beta3

Apr 29, 2026

v1.22.0-beta2

Apr 17, 2026

v1.22.0-beta10

Jun 26, 2026

v1.22.0-beta1

Apr 2, 2026

v1.21.11

Jun 26, 2026

v1.21.10

Jun 25, 2026

v1.21.9

Jun 12, 2026

v1.21.8

Jun 5, 2026

v1.21.7

Jun 5, 2026

v1.21.6

May 22, 2026

v1.21.5

May 18, 2026

v1.21.4

Apr 28, 2026

v1.21.3

Apr 16, 2026

v1.21.2

Mar 31, 2026

v1.21.1

Mar 25, 2026

v1.21.0

Mar 24, 2026

v1.21.0-beta9

Dec 18, 2025

v1.21.0-beta8

Dec 18, 2025

v1.21.0-beta7

Dec 17, 2025

v1.21.0-beta6

Dec 5, 2025

v1.21.0-beta5

Oct 23, 2025

v1.21.0-beta4

Sep 25, 2025

v1.21.0-beta3

Sep 18, 2025

v1.21.0-beta2

Sep 17, 2025

v1.21.0-beta18

Mar 18, 2026

v1.21.0-beta17

Mar 11, 2026

v1.21.0-beta16

Mar 3, 2026

v1.21.0-beta15

Feb 27, 2026

v1.21.0-beta14

Feb 26, 2026

v1.21.0-beta13

Jan 15, 2026

v1.21.0-beta12

Jan 13, 2026

v1.21.0-beta11

Jan 5, 2026

v1.21.0-beta10

Jan 2, 2026

v1.21.0-beta1

Sep 5, 2025

v1.21.0-beta0

Aug 22, 2025

v1.21.0-alpha1

Aug 22, 2025

v1.20.21

Jun 26, 2026

v1.20.20

Jun 25, 2026

v1.20.19

Jun 12, 2026

v1.20.18

Jun 5, 2026

v1.20.17

May 22, 2026

v1.20.16

May 22, 2026

v1.20.15

May 18, 2026

v1.20.14

Apr 28, 2026

v1.20.13

Apr 16, 2026

v1.20.12

Mar 11, 2026

v1.20.11

Mar 4, 2026

v1.20.10

Feb 26, 2026

v1.20.9

Jan 13, 2026

v1.20.8

Jan 9, 2026

v1.20.7

Dec 29, 2025

v1.20.6

Dec 22, 2025

v1.20.5

Dec 5, 2025

v1.20.4

Dec 5, 2025

v1.20.3

Oct 22, 2025

v1.20.2

Oct 16, 2025

v1.20.1

Sep 25, 2025

v1.20.0

Sep 23, 2025

Changes in this version

+ const ACCESS_LOGGING

+ const AI_PROMPT_ENRICHMENT

+ const AI_PROMPT_GUARD

+ const AI_RAG

+ const AI_SEMANTIC_CACHE

+ const ANTHROPIC_AI_BACKEND

+ const API_KEY_AUTH

+ const APPEND_XFF_HEADER

+ const AUTO_HOST_REWRITE

+ const AWS_EC2_BACKEND

+ const AWS_LAMBDA_BACKEND

+ const AWS_OPTIONS

+ const AZURE_FUNCTION_BACKEND

+ const AZURE_OPENAI_AI_BACKEND

+ const BASIC_AUTH

+ const BUFFER_LIMIT

+ const BUFFER_PER_ROUTE

+ const CIRCUIT_BREAKERS

+ const CLUSTER_HEADER

+ const COMPRESSED_PROXY_SPEC

+ const CONNECTION_BALANCING

+ const CONNECTION_LIMIT

+ const CONNECT_MATCHING

+ const CONSUL_BACKEND

+ const CONSUL_CONFIGURATION

+ const CONSUL_DISCOVERY

+ const CONSUL_KV_ARTIFACT_SOURCE

+ const CONSUL_KV_SOURCE

+ const CORS

+ const CSRF

+ const DATA_LOSS_PREVENTION

+ const DELEGATION

+ const DEV_MODE

+ const DIRECTORY_ARTIFACT_SOURCE

+ const DIRECTORY_CONFIG_SOURCE

+ const DIRECTORY_SECRET_SOURCE

+ const DIRECTORY_SECRET_SOURCE_OPTIONS

+ const DIRECT_RESPONSE

+ const DISABLE_GATEWAY_CONTROLLER

+ const DISABLE_GRPC_WEB

+ const DISABLE_KUBERNETES_DESTINATIONS

+ const DISABLE_PROXY_GARBAGE_COLLECTION

+ const DISCOVERY_NAMESPACE

+ const DYNAMIC_FORWAD_PROXY

+ const EARLY_ACCESS_LOGGING

+ const ENDPOINTS_WARMING_TIMEOUT

+ const EXACT_PATH_MATCHING

+ const EXTERNAL_PROCESSING

+ const FAILOVER

+ const FAIL_OVER_UPSTREAM_DNS_POLLING_INTERVAL

+ const FAULT_INJECTION

+ const FDS_DISABLED

+ const FDS_WHITELIST

+ const GCP_BACKEND

+ const GEMENI_AI_BACKEND

+ const GLOBAL_CACHING_SERVER_SETTINGS

+ const GLOBAL_CIRCUIT_BREAKER

+ const GLOBAL_EXTAUTH_SETTINGS

+ const GLOBAL_EXTENSIONS

+ const GLOBAL_EXTPROC_SETTINGS

+ const GLOBAL_GRAPHQL_SETTINGS

+ const GLOBAL_METADATA_SETTINGS

+ const GLOBAL_NAMED_EXTAUTH_SETTINGS

+ const GLOBAL_OBSERVABILITY_SETTINGS

+ const GLOBAL_ONE_WAY_TLS

+ const GLOBAL_RBAC

+ const GLOBAL_UPSTREAM_SETTINGS

+ const GLOBAL_WATCH_NAMESPACE_SELECTORS

+ const GRAPHQL

+ const GRAPHQL_FDS

+ const GRPC_JSON_TRANSCODING

+ const GZIP_COMPRESSION

+ const GatewayAPI

+ const GlooEdgeAPI

+ const HASH_LOAD_BALANCING

+ const HEADER_MANIPULATION

+ const HEADER_MATCHING

+ const HEADER_VALIDATION

+ const HMAC_AUTH

+ const HOST_REWRITE

+ const HTTPS

+ const HTTP_CONNECTION_MANAGEMENT

+ const HYBRID_GATEWAY

+ const IDLE_TIMEOUT

+ const INBOUND_HEALTH_CHECK

+ const INVALID_CONFIG_POLICY

+ const ISOLATE_VIRTUAL_HOSTS_BY_SSL_CONFIG

+ const ISTIO_OPTIONS

+ const JWT

+ const KGatewayAPI

+ const KNATIVE

+ const KUBERNETES_API_RATE_LIMITS

+ const KUBERNETES_ARTIFACT_SOURCE

+ const KUBERNETES_CONFIG_SOURCE

+ const KUBERNETES_SECRET_SOURCE

+ const KUBERNETES_SECRET_SOURCE_OPTIONS

+ const KUBE_BACKEND

+ const LDAP_AUTH

+ const LEAST_REQUEST_LOAD_BALANCING

+ const LINKERD

+ const LLM_AI_BACKEND

+ const LOCALITY_LOAD_BALANCING

+ const LOCAL_RATE_LIMITING

+ const LOG_TRANSFORMATION_REQUEST_RESPONSE_INFO

+ const MAGLEV_LOAD_BALANCING

+ const MAX_DIRECT_RESPONSE_BODY_SIZE

+ const MAX_STREAM_DURATION

+ const METHOD_MATCHING

+ const MISTRAL_AI_BACKEND

+ const MOST_SPECIAL_HEADER_MUTATIONS_WINS

+ const MTLS

+ const MULTI_UPSTREAM_ROUTE

+ const OAUTH2_AUTH

+ const OPA_AUTH

+ const OPENAI_AI_BACKEND

+ const OUTLIER_DETECTION

+ const PASSTHROUGH_AUTH

+ const PERSIST_PROXY_SPEC

+ const PIPE_BACKEND

+ const PLUGIN_AUTH

+ const PORTAL_AUTH

+ const PREFIX_PATH_MATCHING

+ const PREFIX_REWRITE

+ const PROXY_DEBUG_BIND_ADDR

+ const PROXY_PROTOCOL

+ const QUERY_PARAMETER_MATCHING

+ const RANDOM_LOAD_BALANCING

+ const RATE_LIMITING

+ const RBAC

+ const READ_GATEWAYS_FROM_ALL_NAMESPACES

+ const REDIRECT

+ const REFRESH_RATE

+ const REGEX_MAX_PROGRAM_SIZE

+ const REGEX_PATH_MATCHING

+ const REGEX_REWRITE

+ const REMOVE_UNUSED_FILTERS

+ const REQUEST_SHADOWING

+ const RESPONSE_CACHING

+ const REST_XDS_BIND_ADDR

+ const RETRIES

+ const RING_HASH_LOAD_BALANCING

+ const ROUND_ROBIN_LOAD_BALANCING

+ const ROUTE_STATS

+ const ROUTE_TABLE_WEIGHTS

+ const ROUTE_TRACING

+ const SOCKET_OPTIONS

+ const STATEFUL_SESSION

+ const STATIC_BACKEND

+ const TAP_FILTER

+ const TCP_ROUTING

+ const TLS_ROUTING

+ const TRANSFORMATIONS

+ const TRANSFORMATION_ESCAPE_CHARACTERS

+ const TRANSLATE_EMPTY_GATEWAYS

+ const UDS_DISCOVERY

+ const UPSTREAM_GROUP_CONFIG_SOURCE

+ const UPSTREAM_GROUP_ROUTE

+ const UPSTREAM_HEALTH_CHECKS

+ const UPSTREAM_HTTP2

+ const UPSTREAM_HTTP_PROXY

+ const UPSTREAM_MTLS

+ const UPSTREAM_TIMEOUT

+ const UPSTREAM_TLS

+ const VALIDATION_BIND_ADDR

+ const VALIDATION_OPTIONS

+ const VAULT_SECRET_SOURCE

+ const VAULT_SECRET_SOURCE_OPTIONS

+ const VERTEXAI_AI_BACKEND

+ const WASM

+ const WATCH_NAMESPACES

+ const WEB_APPLICATION_FIREWALL

+ const XDS_BIND_ADDR

+ func LoadSnapshotFromGloo(opts *Options, tempDir string) (string, error)

+ func NewPortForwardedClient(ctx context.Context, kubectlCli *kubectl.Cli, podSelector, namespace string, ...) (*admincli.Client, func(), error)

+ func RootCmd(op *options.Options) *cobra.Command

+ type API string

+ func (a API) MarshalYAML() (interface{}, error)

+ type Address struct

+ Pipe struct{ ... }

+ SocketAddress SocketAddress

+ type Category string

+ type CircuitBreakers struct

+ Thresholds []Threshold

+ type ClusterStatus struct

+ AddedViaAPI bool

+ CircuitBreakers CircuitBreakers

+ EdsServiceName string

+ HostStatuses []HostStatus

+ Name string

+ ObservabilityName string

+ type Clusters struct

+ ClusterStatuses []ClusterStatus

+ type EndpointStat struct

+ Name string

+ Type string

+ Value string

+ type EnvoyMetrics struct

+ AverageResponsesPerSecond float64

+ Total2xxResponses int64

+ Total3xxResponses int64

+ Total4xxResponses int64

+ Total5xxResponses int64

+ UptimeSeconds int64

+ type FeatureCalculator struct

+ Configs *snapshot.Instance

+ Features map[API][]*UsageStat

+ func (f *FeatureCalculator) AddUsageStat(stat *UsageStat)

+ func (f *FeatureCalculator) ProcessHTTPListenerOptions(options *gloov1.HttpListenerOptions, parentName string, parentKind string, ...)

+ type FeatureType string

+ func (f FeatureType) MarshalYAML() (interface{}, error)

+ type GlooFeatureUsage struct

+ APICounts map[string]int

+ FeatureCountPerProxy map[string]*ProxyFeatureCountCategory

+ type GlooProxyStats struct

+ GlooProxyMetrics *EnvoyMetrics

+ GlooProxyStats []*UpstreamStat

+ type HealthStatus struct

+ EdsHealthStatus string

+ type HostStatus struct

+ Address Address

+ HealthStatus HealthStatus

+ Hostname string

+ Locality Locality

+ Stats []EndpointStat

+ Weight int

+ type Inputs struct

+ GlooEdgeConfigs *snapshot.Instance

+ K8sClusterInfo *K8sClusterInfo

+ ProxyStats map[string]*ProxyInfo

+ type K8sClusterInfo struct

+ Nodes []corev1.Node

+ Pods []corev1.Pod

+ Services []corev1.Service

+ type KubernetesStats struct

+ NodeResources *NodeResources

+ Pods int

+ Services int

+ type Label string

+ type Locality struct

+ Region string

+ SubZone string

+ Zone string

+ type NodeResources struct

+ Nodes int

+ TotalCPUCores int64

+ TotalMemoryGb int64

+ type Options struct

+ ControlPlaneName string

+ ControlPlaneNamespace string

+ GlooSnapshotFile string

+ IncludeEndpointStats bool

+ OutputFormat string

+ ProxyNamespaces []string

+ ScanProxies []string

+ type ProxyData struct

+ EnvoyMetrics *EnvoyMetrics

+ Name string

+ Namespace string

+ type ProxyFeatureCount struct

+ FeatureCount map[FeatureType]int

+ type ProxyFeatureCountCategory struct

+ Categories map[Category]ProxyFeatureCount

+ type ProxyInfo struct

+ Clusters *Clusters

+ Stats *Stats

+ type SocketAddress struct

+ Address string

+ PortValue int

+ type Stat struct

+ Name string

+ Value interface{}

+ type Stats struct

+ Stats []Stat

+ type Threshold struct

+ MaxConnections int

+ MaxPendingRequests int

+ MaxRequests int

+ MaxRetries int

+ Priority string

+ type UpstreamStat struct

+ CxActive int

+ CxConnectFail int

+ IPAddress string

+ Port int

+ Region string

+ RqError int

+ RqSuccess int

+ SubZone string

+ Upstream string

+ Zone string

+ type UsageMetadata struct

+ API API

+ Category Category

+ Kind string

+ Name string

+ Namespace string

+ ParentName string

+ ParentNamespace string

+ ProxyNames []string

+ type UsageStat struct

+ Metadata UsageMetadata

+ Type FeatureType

+ type UsageStats struct

+ GlooFeatureUsage map[API]*GlooFeatureUsage

+ GlooProxyStats map[string]*GlooProxyStats

+ KubernetesStats *KubernetesStats

+ func (u *UsageStats) Print(format string) error

v1.20.0-rc4

Sep 19, 2025

v1.20.0-rc3

Sep 17, 2025

v1.20.0-rc2

Sep 6, 2025

v1.20.0-rc1

Aug 22, 2025

v1.20.0-beta9

Jul 29, 2025

v1.20.0-beta8

Jul 10, 2025

v1.20.0-beta7

Jun 23, 2025

v1.20.0-beta6

Jun 17, 2025

v1.20.0-beta12

Aug 20, 2025

v1.20.0-beta11

Aug 12, 2025

v1.20.0-beta10

Aug 1, 2025