package otlpconfig

Import Path
	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc/internal/otlpconfig (on go.dev)

Dependency Relation
	imports 19 packages, and imported by one package

Involved Source Files

	    envconfig.go
	  d options.go
		Package otlpconfig provides configuration for the otlptrace exporters.

	    optiontypes.go
	    tls.go
Package-Level Type Names (total 8)

	/* sort by: alphabet | popularity */
	 type Compression int (basic type)
		Compression describes the compression used for payloads sent to the
		collector.

		As Inputs Of (at least one exported)
			func WithCompression(compression Compression) GenericOption
		As Types Of (total 2)
			const GzipCompression
			const NoCompression

	 type Config (struct)

		Fields (total 6)
			DialOptions []grpc.DialOption
			GRPCConn *grpc.ClientConn
			ReconnectionPeriod time.Duration
				gRPC configurations

			RetryConfig retry.Config
			ServiceConfig string
			Traces SignalConfig
				Signal specific configurations

		As Outputs Of (at least 8)
			func ApplyGRPCEnvConfigs(cfg Config) Config
			func ApplyHTTPEnvConfigs(cfg Config) Config
			func NewGRPCConfig(opts ...GRPCOption) Config
			func NewHTTPConfig(opts ...HTTPOption) Config
			func GenericOption.ApplyGRPCOption(Config) Config
			func GenericOption.ApplyHTTPOption(Config) Config
			func GRPCOption.ApplyGRPCOption(Config) Config
			func HTTPOption.ApplyHTTPOption(Config) Config
		As Inputs Of (at least 6)
			func ApplyGRPCEnvConfigs(cfg Config) Config
			func ApplyHTTPEnvConfigs(cfg Config) Config
			func GenericOption.ApplyGRPCOption(Config) Config
			func GenericOption.ApplyHTTPOption(Config) Config
			func GRPCOption.ApplyGRPCOption(Config) Config
			func HTTPOption.ApplyHTTPOption(Config) Config

	 type GenericOption (interface)
		GenericOption applies an option to the HTTP or gRPC driver.

		Methods (total 2)
			( GenericOption) ApplyGRPCOption(Config) Config
			( GenericOption) ApplyHTTPOption(Config) Config
		Implements (at least 2)
			 GenericOption : GRPCOption
			 GenericOption : HTTPOption
		As Outputs Of (at least 12)
			func WithCompression(compression Compression) GenericOption
			func WithEndpoint(endpoint string) GenericOption
			func WithEndpointURL(v string) GenericOption
			func WithHeaders(headers map[string]string) GenericOption
			func WithHTTPClient(c *http.Client) GenericOption
			func WithInsecure() GenericOption
			func WithProxy(pf HTTPTransportProxyFunc) GenericOption
			func WithRetry(rc retry.Config) GenericOption
			func WithSecure() GenericOption
			func WithTimeout(duration time.Duration) GenericOption
			func WithTLSClientConfig(tlsCfg *tls.Config) GenericOption
			func WithURLPath(urlPath string) GenericOption

	 type GRPCOption (interface)
		GRPCOption applies an option to the gRPC driver.

		Methods (only one)
			( GRPCOption) ApplyGRPCOption(Config) Config
		Implemented By (at least one exported)
			 GenericOption (interface)
		As Outputs Of (at least one exported)
			func NewGRPCOption(fn func(cfg Config) Config) GRPCOption
		As Inputs Of (at least one exported)
			func NewGRPCConfig(opts ...GRPCOption) Config

	 type HTTPOption (interface)
		HTTPOption applies an option to the HTTP driver.

		Methods (only one)
			( HTTPOption) ApplyHTTPOption(Config) Config
		Implemented By (at least one exported)
			 GenericOption (interface)
		As Outputs Of (at least one exported)
			func NewHTTPOption(fn func(cfg Config) Config) HTTPOption
		As Inputs Of (at least one exported)
			func NewHTTPConfig(opts ...HTTPOption) Config

	 type HTTPTransportProxyFunc (func)
		HTTPTransportProxyFunc is a function that resolves which URL to use as proxy for a given request.
		This type is compatible with `http.Transport.Proxy` and can be used to set a custom proxy function to the OTLP HTTP client.

		As Inputs Of (at least one exported)
			func WithProxy(pf HTTPTransportProxyFunc) GenericOption

	 type Marshaler int (basic type)
		Marshaler describes the kind of message format sent to the collector.

		As Types Of (total 2)
			const MarshalJSON
			const MarshalProto

	 type SignalConfig (struct)

		Fields (total 10)
			Compression Compression
			Endpoint string
			GRPCCredentials credentials.TransportCredentials
				gRPC configurations

			HTTPClient *http.Client
			Headers map[string]string
			Insecure bool
			Proxy HTTPTransportProxyFunc
				HTTP configurations

			TLSCfg *tls.Config
			Timeout time.Duration
			URLPath string


Package-Level Functions (total 20)

	 func ApplyGRPCEnvConfigs(cfg Config) Config
		ApplyGRPCEnvConfigs applies the env configurations for gRPC.

	 func ApplyHTTPEnvConfigs(cfg Config) Config
		ApplyHTTPEnvConfigs applies the env configurations for HTTP.

	 func CreateTLSConfig(certBytes []byte) (*tls.Config, error)
		CreateTLSConfig creates a tls.Config from a raw certificate bytes
		to verify a server certificate.

	 func NewGRPCConfig(opts ...GRPCOption) Config
		NewGRPCConfig returns a new Config with all settings applied from opts and
		any unset setting using the default gRPC config values.

	 func NewGRPCOption(fn func(cfg Config) Config) GRPCOption
	 func NewHTTPConfig(opts ...HTTPOption) Config
		NewHTTPConfig returns a new Config with all settings applied from opts and
		any unset setting using the default HTTP config values.

	 func NewHTTPOption(fn func(cfg Config) Config) HTTPOption
	 func WithCompression(compression Compression) GenericOption
	 func WithEndpoint(endpoint string) GenericOption
		WithEndpoint configures the trace host and port only; endpoint should
		resemble "example.com" or "localhost:4317". To configure the scheme and path,
		use WithEndpointURL.

	 func WithEndpointURL(v string) GenericOption
		WithEndpointURL configures the trace scheme, host, port, and path; the
		provided value should resemble "https://example.com:4318/v1/traces".

	 func WithEnvCompression(n string, fn func(Compression)) func(e *envconfig.EnvOptionsReader)
		WithEnvCompression retrieves the specified config and passes it to ConfigFn as a Compression.

	 func WithHeaders(headers map[string]string) GenericOption
	 func WithHTTPClient(c *http.Client) GenericOption
	 func WithInsecure() GenericOption
	 func WithProxy(pf HTTPTransportProxyFunc) GenericOption
	 func WithRetry(rc retry.Config) GenericOption
	 func WithSecure() GenericOption
	 func WithTimeout(duration time.Duration) GenericOption
	 func WithTLSClientConfig(tlsCfg *tls.Config) GenericOption
	 func WithURLPath(urlPath string) GenericOption
Package-Level Variables (only one)

	  var DefaultEnvOptionsReader envconfig.EnvOptionsReader
		DefaultEnvOptionsReader is the default environments reader.


Package-Level Constants (total 9)

	const DefaultCollectorGRPCPort uint16 = 4317
		DefaultCollectorGRPCPort is the default gRPC port of the collector.

	const DefaultCollectorHost string = "localhost"
		DefaultCollectorHost is the host address the Exporter will attempt
		connect to if no collector address is provided.

	const DefaultCollectorHTTPPort uint16 = 4318
		DefaultCollectorHTTPPort is the default HTTP port of the collector.

	const DefaultTimeout time.Duration = 10000000000
		DefaultTimeout is a default max waiting time for the backend to process
		each span batch.

	const DefaultTracesPath string = "/v1/traces"
		DefaultTracesPath is a default URL path for endpoint that
		receives spans.

	const GzipCompression Compression = 1
		GzipCompression tells the driver to send payloads after
		compressing them with gzip.

	const MarshalJSON Marshaler = 1
		MarshalJSON tells the driver to send using json format.

	const MarshalProto Marshaler = 0
		MarshalProto tells the driver to send using the protobuf binary format.

	const NoCompression Compression = 0
		NoCompression tells the driver to send payloads without
		compression.

The pages are generated with Golds v0.8.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 @zigo_101 (reachable from the left QR code) to get the latest news of Golds.