func NewOpenTelemetryInstrumentation(providertrace.TracerProvider, captureSearchBodybool)elastictransport.Instrumentation

type BaseClient struct {Transportelastictransport.Interface// contains filtered or unexported fields}

funcNewBaseClient¶added inv8.18.0

func NewBaseClient(cfgConfig) (*BaseClient,error)

NewBaseClient creates a new client free of any API.

func (*BaseClient)Close¶added inv8.19.1

func (c *BaseClient) Close(ctxcontext.Context)error

Close closes the client. If the underlying Transport is elastictransport.Closeable, it is closed as well.Close should only be called once. Later calls to Close will return ErrAlreadyClosed.Once closed, future calls to the client will return ErrClosed.Existing requests may continue to run but may return:

• elastictransport.ErrClosed
• errors.New("connection pool is closed")

func (*BaseClient)DiscoverNodes¶added inv8.4.0

func (c *BaseClient) DiscoverNodes()error

DiscoverNodes reloads the client connections by fetching information from the cluster.

func (*BaseClient)InstrumentationEnabled¶added inv8.12.0

func (c *BaseClient) InstrumentationEnabled()elastictransport.Instrumentation

InstrumentationEnabled propagates back to the client the Instrumentation provided by the transport.

func (*BaseClient)Metrics¶added inv8.4.0

func (c *BaseClient) Metrics() (elastictransport.Metrics,error)

Metrics returns the client metrics.

func (*BaseClient)Perform¶added inv8.4.0

func (c *BaseClient) Perform(req *http.Request) (*http.Response,error)

Perform delegates to Transport to execute a request and return a response.

type Client struct {BaseClient*esapi.API}

funcNewClient¶

func NewClient(cfgConfig) (*Client,error)

NewClient creates a new client with configuration from cfg.

It will usehttp://localhost:9200 as the default address.

It will use the ELASTICSEARCH_URL environment variable, if set,to configure the addresses; use a comma to separate multiple URLs.

If either cfg.Addresses or cfg.CloudID is set, the ELASTICSEARCH_URLenvironment variable is ignored.

It's an error to set both cfg.Addresses and cfg.CloudID.

cfg := elasticsearch.Config{Addresses: []string{"http://localhost:9200",},Username: "foo",Password: "bar",Transport: &http.Transport{MaxIdleConnsPerHost:   10,ResponseHeaderTimeout: time.Second,DialContext:           (&net.Dialer{Timeout: time.Second}).DialContext,TLSClientConfig: &tls.Config{MinVersion: tls.VersionTLS12,},},}es, _ := elasticsearch.NewClient(cfg)log.Print(es.Transport.(*elastictransport.Client).URLs())

// import "github.com/elastic/go-elasticsearch/v8/elastictransport"// Use one of the bundled loggers://// * elastictransport.TextLogger// * elastictransport.ColorLogger// * elastictransport.CurlLogger// * elastictransport.JSONLoggercfg := elasticsearch.Config{Logger: &elastictransport.ColorLogger{Output: os.Stdout},}elasticsearch.NewClient(cfg)

funcNewDefaultClient¶

func NewDefaultClient() (*Client,error)

NewDefaultClient creates a new client with default options.

It will usehttp://localhost:9200 as the default address.

It will use the ELASTICSEARCH_URL environment variable, if set,to configure the addresses; use a comma to separate multiple URLs.

es, err := elasticsearch.NewDefaultClient()if err != nil {log.Fatalf("Error creating the client: %s\n", err)}res, err := es.Info()if err != nil {log.Fatalf("Error getting the response: %s\n", err)}defer res.Body.Close()log.Print(es.Transport.(*elastictransport.Client).URLs())

type Config struct {Addresses []string// A list of Elasticsearch nodes to use.Usernamestring// Username for HTTP Basic Authentication.Passwordstring// Password for HTTP Basic Authentication.CloudIDstring// Endpoint for the Elastic Service (https://elastic.co/cloud).APIKeystring// Base64-encoded token for authorization; if set, overrides username/password and service token.ServiceTokenstring// Service token for authorization; if set, overrides username/password.CertificateFingerprintstring// SHA256 hex fingerprint given by Elasticsearch on first launch.Headerhttp.Header// Global HTTP request header.// PEM-encoded certificate authorities.// When set, an empty certificate pool will be created, and the certificates will be appended to it.// The option is only valid when the transport is not specified, or when it's http.Transport.CACert []byteRetryOnStatus []int// List of status codes for retry. Default: 502, 503, 504.DisableRetrybool// Default: false.MaxRetriesint// Default: 3.RetryOnError  func(*http.Request,error)bool// Optional function allowing to indicate which error should be retried. Default: nil.CompressRequestBodybool// Default: false.CompressRequestBodyLevelint// Default: gzip.DefaultCompression.PoolCompressorbool// If true, a sync.Pool based gzip writer is used. Default: false.DiscoverNodesOnStartbool// Discover nodes when initializing the client. Default: false.DiscoverNodesIntervaltime.Duration// Discover nodes periodically. Default: disabled.EnableMetricsbool// Enable the metrics collection.EnableDebugLoggerbool// Enable the debug logging.EnableCompatibilityModebool// Enable sends compatibility headerDisableMetaHeaderbool// Disable the additional "X-Elastic-Client-Meta" HTTP header.RetryBackoff func(attemptint)time.Duration// Optional backoff duration. Default: nil.Transporthttp.RoundTripper// The HTTP transport object.Loggerelastictransport.Logger// The logger object.Selectorelastictransport.Selector// The selector object.// Optional constructor function for a custom ConnectionPool. Default: nil.ConnectionPoolFunc func([]*elastictransport.Connection,elastictransport.Selector)elastictransport.ConnectionPoolInstrumentationelastictransport.Instrumentation// Enable instrumentation throughout the client.// Interceptors is an array of functions that can mutate the *http.Request / *http.Response on each call to the http.RoundTripper.// These interceptors are applied left to right, meaning the leftmost interceptor will modify the *http.Request first in the chain// and the *http.Response last.// This array is used on instantiation of the transport only and cannot be mutated after transport creation.Interceptors []elastictransport.InterceptorFunc}

type TypedClient struct {BaseClient*typedapi.API}

funcNewTypedClient¶added inv8.4.0

func NewTypedClient(cfgConfig) (*TypedClient,error)

NewTypedClient create a new client with the configuration from cfg.

This version uses the same configuration as NewClient.

It will return the client with the TypedAPI.