Skip to main content

Partha Host Agent Configuration

The Partha Host Agent is to be installed on each host that requires to be monitored. The Partha Agent will communicate with the Shyama Central Server and the assigned Madhava server.

Partha agent reads its configuration from a JSON file or as environment variables. Environment variables will take precedence over the config file in case of a conflict.

A sample Partha JSON config file is given below.

The list of Config options include :

Cluster Name​

Each Monitored host is assumed to be part of a Cluster. This field indicates the Cluster name this host is part of. Cluster names are symbolic and are used internally by Madhava servers to detect Service Dependencies.

It is recommended to club related hosts with the same Cluster Name for better querying. For example, specifying Cluster Name as prod1_useast1a to club all prod hosts in US East 1a zone.

The JSON field name is cluster_name and corresponding environment variable is CFG_CLUSTER_NAME.

This field is mandatory and max cluster name length is 64 bytes.

Shyama Hosts​

This config param indicates the list of hostnames of the Shyama instances. The format of this param is a JSON array of one or more Shyama hostnames or IP addresses.

This param is to be used along with Shyama Ports to indicate the Shyama servers.

If multiple Shyama instances are running due to High Availability, the number of elements in the JSON array will be more than 1. Under such cases, the Partha agent will try connecting to only the Active Shyama instance (Other instances being the Passive instances).

The JSON field name is shyama_hosts and corresponding environment variable is CFG_SHYAMA_HOSTS.

This field is mandatory.

The Hostnames or IP Addresses mentioned in this option must be same as the Shyama Server Service Hostname.

Example usages :

[ "shyamahost1.local" ] : Here a single instance of Shyama is specified.

[ "shyama1.local", "192.168.0.2" ] : Here 2 instances of Shyama are running in Active Passive mode.

Shyama Ports​

This config param indicates the list of TCP ports of the Shyama instances. The format of this param is a JSON array of one or more Shyama TCP ports.

This param is to be used along with Shyama Hosts to indicate the Shyama servers. The number of elements in this JSON array must match the number of elements specified in Shyama Hosts.

The JSON field name is shyama_ports and corresponding environment variable is CFG_SHYAMA_PORTS.

This field is mandatory.

The TCP Ports mentioned in this option must be same as the Shyama Server Service Port.

Example usages :

[ 10037 ] : Here a single instance of Shyama is specified.

[ 10037, 10037 ] : Here 2 instances of Shyama are running in Active Passive mode.

Is Kubernetes?​

This boolean field indicates whether the Host to be monitored is part of a Kubernetes Cluster. This field is used to extract the Kubernetes Pod Name tags for the Host Processes.

For Helm Chart installs, this parameter is set to true by default. For other install options, the default is false

The JSON field name is is_kubernetes and corresponding environment variable is CFG_IS_KUBERNETES.

This field is optional and can contain values of either true or false.

Service Response Sampling Percent​

The Partha Agent will collect Queries/sec (QPS) and Response Time (Latency) for each TCP Listener (Service).

This field indicates what percent of the Queries should be checked for calculating the statistics.

The default value is 100 (100% or No sampling). Specifying a value of 0 will disable all Service QPS and Response statistics.

The JSON field name is response_sampling_percent and corresponding environment variable is CFG_RESPONSE_SAMPLING_PERCENT.

This field is optional and can contain integer values from 0 to 100.

Cloud Operator Type​

This field indicates the Cloud Operator this Host is running on. This is needed to get the Network Region and Zone which will be used by the Shyama server to allocate a Network Adjacent Madhava server for this host. Also, the Host Instance ID will also be obtained for a supported Cloud Type.

Currently supported Clouds for metadata are : aws, gcp and azure.

For other Cloud Operators or in case of own data centers, this field should nt be specified. In such cases, users can explicitly specify the Network Region and Zone in the fields mentioned below Region Name and Zone Name so that the Shyama server will assign a nearby Madhava server.

The JSON field is cloud_type and environment variable is CFG_CLOUD_TYPE.

This field is optional.

Network Region Name​

This field must be used only if the preceding Cloud Operator type is empty. This field indicates the Network Region Name this host is operating under.

In case both the Cloud Type and this config field are specified, this field will take precedence over the Cloud Metadata.

The JSON field is region_name and environment variable is CFG_REGION_NAME.

This field is optional.

Network Zone Name​

This field must be used only if the preceding Cloud Operator type is empty. This field indicates the Network Zone Name this host is operating under.

In case both the Cloud Type and this config field are specified, this field will take precedence over the Cloud Metadata.

The JSON field is zone_name and environment variable is CFG_ZONE_NAME.

This field is optional.

Enable Task Delays​

Newer Kernels (v5.14+) have Process (task) Delays disabled by default. Gyeeta uses Task Delays to detect process contention.

This field indicates whether to enable Task Delays. Valid values for this field are 0, 1 and 2.

The default value is 1 (Enable Task Delays for newer processes). Specifying a value of 2 will auto enable Process Delays after next Kernel Boot.

Enabling Task Delays causes a minimal performance hit and so it is recommended to set this to 2 which will enable Process delays for all processes. Setting it to 1 will only enable Process Delays for Processes started thereafter. Specifying it as 0 will result in no changes to the host OS.

The JSON field name is enable_task_delays and corresponding environment variable is CFG_ENABLE_TASK_DELAYS.

This field is optional and can contain integer values 0, 1 or 2.

Sample JSON Config file​

A sample Partha JSON config file is provided below :


    {
        "cluster_name"              :   "cluster1",
        "cloud_type"                :   "aws",

        "shyama_hosts"              :   [ "shyama1.local" ],
        "shyama_ports"              :   [ 10037 ],

        "response_sampling_percent" :   100,
        "enable_task_delays"        :   2,
        "is_kubernetes"             :   true
    }

The above sample config specifies the Cluster Name as cluster1 and Cloud Operator as aws. Also, only 1 Shyama server is installed and is located at shyama1.local:10037.