NAME

OpenSearch::Client::Core::3_0::Direct::Insights

VERSION

version 3.007004

SYNOPSIS

use OpenSearch::Client;

my $client = OpenSearch::Client->new( ... );

my $response = $client->insights-><methodname>(
  valone => $value1,
  valtwo => $value2
);

DESCRIPTION

Query insights

To monitor and analyze the search queries within your OpenSearch cluster, you can obtain query insights.

See OpenSearch documentation for insights.

METHODS

insights->top_queries

Retrieves the top queries based on the given metric type (latency, CPU, or memory).

Paths served by this method:

GET /_insights/top_queries

$resp = $client->insights->top_queries(
    
     # Endpoint specific query string parameters
    
    'type'         =>  $qval1,     # string
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval2,     # boolean
    'filter_path'  =>  $qval3,     # list
    'human'        =>  $qval4,     # boolean
    'pretty'       =>  $qval5,     # boolean
    'source'       =>  $qval6,     # string
);

OpenSearch documentation for insights.top_queries

MANUAL

Documentation index OpenSearch::Client::Manual

HISTORY

This distribution is derived from Search::Elasticsearch version 7.714. All subsequent changes are unique to this distribution.

AUTHOR

Mark Dootson <mdootson@cpan.org> ( current maintainer )

CREDITS

OpenSearch::Client is based on Search::Elasticsearch version 7.714 by Enrico Zimuel <enrico.zimuel@elastic.co>.

COPYRIGHT AND LICENSE

Copyright (C) 2026 by Mark Dootson ( this distribution )

Copyright (C) 2021 by Elasticsearch BV ( original distribution )

This is free software, licensed under:

The Apache License, Version 2.0, January 2004