
#                                      Copyright 2024 WebPros International, LLC
#                                                           All rights reserved.
# copyright@cpanel.net                                         http://cpanel.net
# This code is subject to the cPanel license. Unauthorized copying is prohibited.

package Whostmgr::360Monitoring::Agent::Plugins::Elasticsearch;

use cPstrict;
use Moo;
use Whostmgr::360Monitoring::Moo;
use Whostmgr::360Monitoring::Types qw(WPUrl);
use Types::Common::String          qw(NonEmptyStr);

extends 'Whostmgr::360Monitoring::Agent::Plugins';

with 'Whostmgr::360Monitoring::Agent::Plugins::Roles::Unsupported';

conf_has 'status_page_url' => (
    isa      => WPUrl,
    required => 1
);

1;

__END__

=head1 NAME

Whostmgr::360Monitoring::Agent::Plugins::Elasticsearch - A class for the Elasticsearch plugin

=head1 DESCRIPTION

A child class of L<Whostmgr::360Monitoring::Agent::Plugins>. More information can be found at L<Agent360 Plugin Documentation|https://docs.360monitoring.com/docs/elasticsearch-plugin>. The upstream implementation can be found at the L<Agent360 Repository on Github|https://github.com/plesk/agent360/tree/master/agent360/plugins/elasticsearch.py>.

Usage for plugin configuration changes can be found in the L<Agent|Whostmgr::360Monitoring::Agent> class.

Usage for configuration options can be found in the L<Agent elasticsearch-plugin documentation|https://docs.360monitoring.com/docs/elasticsearch-plugin/#configure-the-plugin>.

=head1 ROLES

=over 15

=item L<Serializable|Whostmgr::360Monitoring::Agent::Plugins::Roles::Serializable>

=item L<Runnable|Whostmgr::360Monitoring::Agent::Plugins::Roles::Runnable>

=item L<Enableable|Whostmgr::360Monitoring::Agent::Plugins::Roles::Enableable>

=item L<Unsupported|Whostmgr::360Monitoring::Agent::Plugins::Roles::Unsupported>


=back

=head1 ATTRIBUTES

=over 15

=item status_page_url

An attribute representing status_page_url as defined in the GitHub repo linked in the SEE ALSO. Sourced from INI. Serializes to INI.


=back

=head1 SEE ALSO

=over 8

=item L<Implementation of Plugin on Github|https://github.com/plesk/agent360/tree/master/agent360/plugins/elasticsearch.py>

=item L<Documentation on Agent360|https://docs.360monitoring.com/docs/elasticsearch-plugin>

=back
