Observability metrics in Jitterbit private agents

Overview

You can monitor the performance and behavior of private agents using Jitterbit's native observability, as well as through supported third-party observability platforms such as Datadog and Elasticsearch.

Prerequisites

• For native observability, your agents must be version 11.43 or higher.

• For third-party observability, your agents must be version 11.37 or higher.

Native observability

To configure and enable native observability for a private agent, follow these steps:

1. Log into the private agent host.

2. Check the current version of the private agent:

   WindowsLinux

   Run this command in a console or PowerShell:

   cd 'C:\Program Files\Jitterbit Agent\AgentSupportTools'
   .\run.bat about
   

   Important

   If the version is lower than 11.43, you must completely uninstall the agent, then install version 11.43 or higher.

   Run this command in a terminal:

   jitterbit version
   

   Important

   If the version is lower than 11.43, you can do either of the following:

   • Configure the private agent again (run the jitterbit-config command).

   • Completely uninstall the agent, then install version 11.43 or higher.

3. Edit the JITTERBIT_HOME/jitterbit.conf file, then follow these steps:

   1. In the [AgentMetrics] section, set the following parameters to true, as shown in the following example:

      jitterbit.conf [AgentMetrics] section

      [AgentMetrics]
      Enabled=true
      JitterbitMetricsServiceEnabled=true
      UserIntentFileWatcherEnabled=true
      OperationStatusLogToFileEnabled=true
      OperationStatusLogToFileAsyncEnabled=true
      AgentEnvSyncProgressToFileEnabled=true
      

   2. In the [AgentCapability] section, set the following parameters to true, as shown in the following example:

      jitterbit.conf [AgentCapability] section

      [AgentCapability]
      ApacheThreadCapabilityDebugOutput=true
      ApacheThreadCapabilityEnabled=true
      CapabilityDebugOutput=true
      CpuUsageCapabilityDebugOutput=true
      CpuUsageCapabilityEnabled=true
      EnhancedCapabilityMetricsEnabled=true
      EnhancedCapabilityMetricsJMXEnabled=true
      EnhancedCapabilityMetricsSubmissionEnabled=true
      MemoryUsageCapabilityDebugOutput=true
      MemoryUsageCapabilityEnabled=true
      

4. Restart the private agent:

   • Docker or Linux agents: Run jitterbit restart in a terminal.
   • Windows agents: Stop then start the agent.

5. Open the Management Console > Agents page, then select the Metrics tab.

6. (Optional) Check the metrics.log and metrics_service.log log files to see the status of the agent metrics service.

Third-party observability

You must install and configure your chosen observability platform on every private agent host you want to monitor. When configured, your agents' metrics can be viewed using the Jitterbit-provided pre-built dashboard, or your own custom dashboard. To configure and enable third-party private agent observability, follow the instructions linked below for your chosen observability platform:

• Datadog

• Elasticsearch/Kibana