/ 
OpenSearch-Client-3.007009
/ OpenSearch::Client::Core::3_0::Direct::Observability

NAME

OpenSearch::Client::Core::3_0::Direct::Observability

VERSION

version 3.007009

SYNOPSIS

use OpenSearch::Client;

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

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

DESCRIPTION

Observability

OpenSearch provides observability capabilities for monitoring applications, infrastructure, and AI agents.

See OpenSearch documentation for observability.

METHODS

create_object

Creates a new observability object.

Paths served by this method:

POST /_plugins/_observability/object

Method added in OpenSearch version 1.1

$resp = $client->observability->create_object(
    
    'body'         =>  $body,      # optional
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval1,     # boolean
    'filter_path'  =>  $qval2,     # list
    'human'        =>  $qval3,     # boolean
    'pretty'       =>  $qval4,     # boolean
    'source'       =>  $qval5,     # string
);

OpenSearch documentation for observability->create_object

delete_object

Deletes specific observability object specified by ID.

Paths served by this method:

DELETE /_plugins/_observability/object/{object_id}

Method added in OpenSearch version 1.1

$resp = $client->observability->delete_object(
    
     # path parameters
    
    'object_id'    =>  $object_id,  # required
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval1,     # boolean
    'filter_path'  =>  $qval2,     # list
    'human'        =>  $qval3,     # boolean
    'pretty'       =>  $qval4,     # boolean
    'source'       =>  $qval5,     # string
);

OpenSearch documentation for observability->delete_object

delete_objects

Deletes specific observability objects specified by ID or a list of IDs.

Paths served by this method:

DELETE /_plugins/_observability/object

Method added in OpenSearch version 1.1

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

OpenSearch documentation for observability->delete_objects

get_localstats

Retrieves local stats of all observability objects.

Paths served by this method:

GET /_plugins/_observability/_local/stats

Method added in OpenSearch version 2.5

$resp = $client->observability->get_localstats(
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval1,     # boolean
    'filter_path'  =>  $qval2,     # list
    'human'        =>  $qval3,     # boolean
    'pretty'       =>  $qval4,     # boolean
    'source'       =>  $qval5,     # string
);

OpenSearch documentation for observability->get_localstats

get_object

Retrieves specific observability object specified by ID.

Paths served by this method:

GET /_plugins/_observability/object/{object_id}

Method added in OpenSearch version 1.1

$resp = $client->observability->get_object(
    
     # path parameters
    
    'object_id'    =>  $object_id,  # required
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval1,     # boolean
    'filter_path'  =>  $qval2,     # list
    'human'        =>  $qval3,     # boolean
    'pretty'       =>  $qval4,     # boolean
    'source'       =>  $qval5,     # string
);

OpenSearch documentation for observability->get_object

list_objects

Retrieves list of all observability objects.

Paths served by this method:

GET /_plugins/_observability/object

Method added in OpenSearch version 1.1

$resp = $client->observability->list_objects(
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval1,     # boolean
    'filter_path'  =>  $qval2,     # list
    'human'        =>  $qval3,     # boolean
    'pretty'       =>  $qval4,     # boolean
    'source'       =>  $qval5,     # string
);

OpenSearch documentation for observability->list_objects

update_object

Updates an existing observability object.

Paths served by this method:

PUT /_plugins/_observability/object/{object_id}

Method added in OpenSearch version 1.1

$resp = $client->observability->update_object(
    
    'body'         =>  $body,      # optional
    
     # path parameters
    
    'object_id'    =>  $object_id,  # required
    
     # Common API query string parameters
    
    'error_trace'  =>  $qval1,     # boolean
    'filter_path'  =>  $qval2,     # list
    'human'        =>  $qval3,     # boolean
    'pretty'       =>  $qval4,     # boolean
    'source'       =>  $qval5,     # string
);

OpenSearch documentation for observability->update_object

method_supported_in_version

Return whether a method in this module namespace is supported for an OpenSearch server version

my $boolean = $os->observability->method_supported_in_version(
    method  => 'create_object',
    version => '2.4.0'
);

Both method and version are required.

See also global_method_supported_in_version

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