# Functions

GetClusterMetadata returns the cluster metadata.
GetClusterName returns the upstream cluster name.
GetDownstreamConnectionID returns the connection ID of the downstream connection.
GetDownstreamDnsSanLocalCertificate returns The first DNS entry in the SAN field of the local certificate in the downstream TLS connection.
GetDownstreamDnsSanPeerCertificate returns The first DNS entry in the SAN field of the peer certificate in the downstream TLS connection.
GetDownstreamLocalAddress returns the local address of the downstream connection.
GetDownstreamLocalPort returns the local port of the downstream connection.
GetDownstreamRemoteAddress returns the remote address of the downstream connection.
GetDownstreamRemotePort returns the remote port of the downstream connection.
GetDownstreamRequestedServerName returns the requested server name of the downstream connection.
GetDownstreamSha256PeerCertificateDigest returns the SHA256 digest of a peer certificate digest of the downstream connection.
GetDownstreamSubjectLocalCertificate returns the subject field of the local certificate in the downstream TLS connection.
GetDownstreamSubjectPeerCertificate returns the subject field of the peer certificate in the downstream TLS connection.
GetDownstreamTerminationDetails returns the internal termination details of the connection (subject to change).
GetDownstreamTlsVersion returns the TLS version of the downstream connection.
GetDownstreamUriSanLocalCertificate returns the first URI entry in the SAN field of the local certificate in the downstream TLS connection.
GetDownstreamUriSanPeerCertificate returns The first URI entry in the SAN field of the peer certificate in the downstream TLS connection.
GetListenerDirection returns the listener direction.
GetListenerMetadata returns the listener metadata.
GetNodeClientFeatures returns the node client features.
GetNodeCluster returns the node cluster, which defines the local service cluster name where envoy is running.
GetNodeDynamicParams returns the node dynamic parameters.
GetNodeExtensions returns the node extensions.
GetNodeId returns the node id, an opaque node identifier for the Envoy node.
GetNodeListeningAddresses returns the node listening addresses.
GetNodeLocality returns the node locality.
GetNodeMetaAnnotations returns the node annotations.
GetNodeMetaAppContainers returns the app containers of the node.
GetNodeMetaClusterId returns the cluster ID of the node, which defines the cluster the node belongs to.
GetNodeMetaEnvoyPrometheusPort returns the Envoy Prometheus port of the node.
GetNodeMetaEnvoyStatusPort returns the Envoy status port of the node.
GetNodeMetaInstanceIps returns the instance IPs of the node.
GetNodeMetaInterceptionMode returns the interception mode of the node Possible values: REDIRECT : REDIRECT mode uses iptables REDIRECT to NAT and redirect to Envoy.
GetNodeMetaIstioProxySha returns the Istio proxy SHA of the node.
GetNodeMetaIstioVersion returns the Istio version of the node.
GetNodeMetaLabels returns the labels of the node.
GetNodeMetaMeshId returns the mesh ID of the node.
GetNodeMetaName returns the name of the node.
GetNodeMetaNamespace returns the namespace of the node.
GetNodeMetaNodeName returns the node name of the node.
GetNodeMetaOwner returns the owner of the node (opaque string).
GetNodeMetaPilotSan returns the pilot SAN (subject alternate names) of the node's xDS server.
GetNodeMetaPodPorts returns the pod ports of the node.
GetNodeMetaProxyConfigBinaryPath returns the path to the proxy binary.
GetNodeMetaProxyConfigConcurrency returns the concurrency configuration of the proxy which is the number of worker threads to run.
GetNodeMetaProxyConfigConfigPath returns the path to the proxy configuration, Proxy agent generates the actual configuration and stores it in this directory.
GetNodeMetaServiceAccount returns the service account of the node.
GetNodeMetaWorkloadName returns the workload name of the node.
GetNodeProxyConfigControlPlaneAuthPolicy returns the control plane authentication policy of the proxy.
GetNodeProxyConfigDiscoveryAddress returns the discovery address of the proxy.
GetNodeProxyConfigDrainDuration returns the drain duration of the proxy, the time in seconds that Envoy will drain connections during a hot restart.
GetNodeProxyConfigExtraStatTags returns the extra stat tags of the proxy to extract from the in-proxy Istio telemetry.
GetNodeProxyConfigHoldApplicationUntilProxyStarts returns whether to hold the application until the proxy starts.
GetNodeProxyConfigProxyAdminPort returns the admin port of the proxy for administrative commands.
GetNodeProxyConfigProxyStatsMatcher returns the proxy stats matcher, which defines configuration for reporting custom Envoy stats.
GetNodeProxyConfigServiceCluster returns the name of the service cluster of the proxy that is shared by all Envoy instances.
GetNodeProxyConfigStatNameLength returns the stat name length of the proxy, The length of the name field is determined by the length of a name field in a service and the set of labels that comprise a particular version of the service.
GetNodeProxyConfigStatusPort returns the port on which the agent should listen for administrative commands such as readiness probe.
GetNodeProxyConfigTerminationDrainDuration returns the stat name length of the proxy, the amount of time allowed for connections to complete on proxy shutdown.
GetNodeProxyConfigTracingDatadogAddress returns the address of the Datadog service (e.g.
GetNodeProxyConfigTracingOpenCensusAgentAddress returns the gRPC address for the OpenCensus agent (e.g.
GetNodeProxyConfigTracingZipkinAddress returns address of the Zipkin service (e.g.
GetNodeUserAgentBuildVersion returns the node user agent build version.
GetNodeUserAgentName returns the node user agent name.
GetNodeUserAgentVersion returns the node user agent version.
GetPluginName returns the plugin name.
GetPluginRootId returns the plugin root id.
GetPluginVmId returns the plugin vm id.
GetRequestDuration returns the total duration of the request, approximated to nano-seconds.
GetRequestHeaders returns all request headers indexed by the lower-cased header name.
GetRequestHost returns the host portion of the URL.
GetRequestId returns the request ID corresponding to x-request-id header value.
GetRequestMethod returns the request method e.g.
GetRequestPath return the path portion of the URL.
GetRequestProtocol returns the request protocol (“HTTP/1.0”, “HTTP/1.1”, “HTTP/2”, or “HTTP/3”).
GetRequestQuery returns the query portion of the URL in the format of “name1=value1&name2=value2”.
GetRequestReferer returns the referer request header.
GetRequestScheme returns the scheme portion of the URL e.g.
GetRequestSize returns the size of the request body.
GetRequestTime returns the UTC time of the first byte received, approximated to nano-seconds.
GetRequestTotalSize returns the total size of the request including the approximate uncompressed size of the headers.
GetRequestUrlPath returns the path portion of the URL without the query string.
GetRequestUserAgent returns the user agent request header.
GetResponseCode returns the response HTTP status code.
GetResponseCodeDetails returns the internal response code details (subject to change).
GetResponseFlags returns additional details about the response beyond the standard response code encoded as a bit-vector.
GetResponseGrpcStatusCode returns the response gRPC status code.
GetResponseHeaders returns all response headers indexed by the lower-cased header name.
GetResponseSize returns the size of the response body.
GetResponseTotalSize returns the total size of the response including the approximate uncompressed size of the headers and the trailers.
GetResponseTrailers returns all response trailers indexed by the lower-cased trailer name.
GetRouteMetadata returns the route metadata.
GetRouteName returns the route name, only available in the response path (cfr getXdsRouteName()).
GetUpstreamAddress returns the upstream connection remote address.
GetUpstreamDnsSanLocalCertificate returns the first DNS entry in the SAN field of the local certificate in the upstream TLS connection.
GetUpstreamDnsSanPeerCertificate returns the first DNS entry in the SAN field of the peer certificate in the upstream TLS connection.
GetUpstreamHostMetadata returns the upstream host metadata.
GetUpstreamLocalAddress returns the local address of the upstream connection.
GetUpstreamPort returns the upstream connection remote port.
GetUpstreamSha256PeerCertificateDigest returns the SHA256 digest of the peer certificate in the upstream TLS connection if present.
GetUpstreamSubjectLocalCertificate returns the subject field of the local certificate in the upstream TLS connection.
GetUpstreamSubjectPeerCertificate returns the subject field of the peer certificate in the upstream TLS connection.
GetUpstreamTlsVersion returns the TLS version of the upstream TLS connection.
GetUpstreamTransportFailureReason returns the upstream transport failure reason e.g.
GetUpstreamUriSanLocalCertificate returns the first URI entry in the SAN field of the local certificate in the upstream TLS connection.
GetUpstreamUriSanPeerCertificate returns the first URI entry in the SAN field of the peer certificate in the upstream TLS connection.
GetXdsClusterMetadata returns the upstream cluster metadata.
GetXdsClusterName returns the upstream cluster name.
GetXdsListenerFilterChainName returns the listener filter chain name.
GetXdsRouteMetadata returns the upstream route metadata.
GetXdsRouteName returns the upstream route name (available in both the request response path, cfr getRouteName()).
GetXdsUpstreamHostMetadata returns the upstream host metadata.
IsDownstreamConnectionTls returns true if the downstream connection is TLS.
ParseIstioTrafficInterceptionMode converts a string representation of IstioTrafficInterceptionMode to its corresponding enum value.

# Constants

EnvoyTrafficDirectionInbound means that the transport is used for incoming traffic.
EnvoyTrafficDirectionOutbound means that the transport is used for outgoing traffic.
EnvoyTrafficDirectionUnspecified means that the direction is not specified.
IstioTrafficInterceptionModeNone indicates that the workload is not using IPtables for traffic interception.
IstioTrafficInterceptionModeRedirect implies traffic intercepted by IPtables with REDIRECT mode.
IstioTrafficInterceptionModeTproxy implies traffic intercepted by IPtables with TPROXY mode.

# Structs

EnvoyExtension holds version and identification for an Envoy extension.
EnvoyLocality identifies location of where either Envoy runs or where upstream hosts run.
IstioFilterMetadata provides additional inputs to filters based on matched listeners, filter chains, routes and endpoints.
IstioProxyStatsMatcher holds proxy stats name matches for stats creation.
IstioService holds information of the host, name and namespace of an Istio Service.

# Type aliases

EnvoyTrafficDirection identifies the direction of the traffic relative to the local Envoy.
IstioTrafficInterceptionMode indicates how traffic to/from the workload is captured and sent to Envoy.