NAME

Search::Elasticsearch::Cxn::Mojo - An async Cxn implementation which uses Mojo::UserAgent

VERSION

version 8.12

DESCRIPTION

Provides an async HTTP Cxn class based on Mojo::UserAgent. The Mojo backend is fast, uses pure Perl, support proxies and https and provides persistent connections.

This class does Search::Elasticsearch::Role::Cxn, whose documentation provides more information, Search::Elasticsearch::Role::Async::Cxn, and Search::Elasticsearch::Role::Is_Async.

CONFIGURATION

connect_timeout

Unlike most HTTP backends, Mojo::UserAgent accepts a separate connect_timeout parameter, which defaults to 2 seconds but can be reduced in an environment with low network latency.

Inherited configuration

From Search::Elasticsearch::Role::Cxn

• node

• max_content_length

• deflate

• deflate

• request_timeout

• ping_timeout

• dead_timeout

• max_dead_timeout

• sniff_request_timeout

• sniff_timeout

• handle_args

• handle_args

SSL/TLS

Search::Elasticsearch::Cxn::Mojo does no validation of the remote host by default.

This behaviour can be changed by passing the ssl_options parameter with the ca, cert, and key options. For instance, to check that the remote host has a trusted certificate, and to avoid man-in-the-middle attacks, you could do the following:

            

              
              
use Search::Elasticsearch::Async;
my $es = Search::Elasticsearch::Async->new(
    cxn   => 'Mojo',
    nodes => [
        "https://node1.mydomain.com:9200",
        "https://node2.mydomain.com:9200",
    ],
    ssl_options => {
        ca  => '/path/to/cacert.pem'
    }
);
            
          

If the remote server cannot be verified, an Search::Elasticsearch::Error will be thrown.

If you want your client to present its own certificate to the remote server, then use:

            

              
              
use Search::Elasticsearch::Async;
my $es = Search::Elasticsearch::Async->new(
    cxn   => 'Mojo',
    nodes => [
        "https://node1.mydomain.com:9200",
        "https://node2.mydomain.com:9200",
    ],
    ssl_options => {
        ca   => '/path/to/cacert.pem'
        cert => '/path/to/client.pem',
        key  => '/path/to/client.pem'
    }
);
            
          

METHODS

perform_request()

            

              
              
$self->perform_request({
    # required
    method      => 'GET|HEAD|POST|PUT|DELETE',
    path        => '/path/of/request',
    qs          => \%query_string_params,
    # optional
    data        => $body_as_string,
    mime_type   => 'application/json',
    timeout     => $timeout
})
->then(sub { my ($status,body) = @_; ...})
            
          

Sends the request to the associated Elasticsearch node and returns a $status code and the decoded response $body, or throws an error if the request failed.

Inherited methods

From Search::Elasticsearch::Role::Cxn

• scheme()

• is_https()

• userinfo()

• default_headers()

• max_content_length()

• build_uri()

• host()

• port()

• uri()

• is_dead()

• is_live()

• next_ping()

• ping_failures()

• mark_dead()

• mark_live()

• force_ping()

• pings_ok()

• sniff()

• process_response()

From Search::Elasticsearch::Role::Async::Cxn

• pings_ok()

• sniff()

SEE ALSO

• Search::Elasticsearch::Role::Cxn::AEHTTP

AUTHOR

Enrico Zimuel <enrico.zimuel@elastic.co>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2024 by Elasticsearch BV.

This is free software, licensed under:

            

              
              
The Apache License, Version 2.0, January 2004
            
          

cpanm Search::Elasticsearch::Async

perl -MCPAN -e shell
install Search::Elasticsearch::Async