Oracle Cloud Infrastructure Documentation

Configure Agent Settings

Use this action button to modify the following management agent settings for a fleet:
  • Which file system paths the fleet's management agents scan on their hosts to discover Java Runtime installations
  • How frequently the fleet's management agents report usage and Java Runtime installations to JMS Fleets

Prerequisites: You have selected a fleet from the fleet dashboard.

  1. Click Configure Agent Settings. You are prompted to modify the general settings and the file system paths that the management agents scan. Every management agent in a fleet uses these settings.
  2. Modify the General settings:
    1. Report JMS plugin metrics: Report resource utilization (CPU, memory, disk, network) metrics for the JMS plugin deployed on a Managed Instance. The data will be available in the Managed Instance details page. The default value is No.
    2. Record application invocation username: Collect the username associated with application usage in a Managed Instance. The data will be available in the Application table in the Managed Instance details page. The default value is Yes.
      Note

      If this value is set to true, when a managed instance is registered to this JMS fleet during Installing Management Agent and Deploying JMS Plug-in, the Java Management Service plug-in will generate the Java usage tracker with additional functionality on the instance. This will enable JMS to collect the <user.name> property to better identify applications running on Application Servers such as WebLogic and Tomcat. If this value is set to false, the usage tracker will have standard functionality.

    3. Java runtime usage in minutes: specify the frequency at which the management agent must report Java usage to JMS Fleets. The values must be between 5 and 90 minutes. The default value is 60 minutes.
    4. Agent polling interval: specify the frequency at which the management agent must check the work requests. For example, if the value specified is 10 minutes, the agent checks the work requests every 10 minutes and executes them. The values must be between 10 minutes and 12 hours. The default value is 10 minutes.
    5. Work request retention period: specify the time period for JMS Fleets to store the work requests. The values must be between 7 to 30 days. The default value is 2 weeks.
  3. Modify the File scanning settings:
    1. Java runtime discovery: specify frequency at which the management agents should scan their hosts for Java runtime installations. The values must be between 3 to 24 hours. The default value is 24 hours.
      To stop management agents scanning for Java runtime installations, deselect Enable Java runtime discovery.
    2. Modify the file system paths that the management agents should scan on their Linux and Windows hosts to find Java runtime installations.
      Reasons for customizing the directories include:
      • Customization: include your own Java runtime installation, such as /etc/java.
      • Performance: exclude paths to reduce the time taken by the management agent to scan, lower processor load, and reduce memory usage.
      • Privacy: exclude paths to omit corresponding directories whose contents you want to remain private.
    3. In the Exclude Path(s) section for each operating system, provide a list of file system paths to be excluded from the scan. Subdirectories are also excluded by default.
      To exclude more paths, click + another path, and then provide the details of the additional path. To remove a path, click X to its right.
    4. In the Include Path(s) section for each operating system, provide a list of file system paths to be scanned. Subdirectories are also included by default.
      The management agent includes the following paths by default:
      • Linux
        • /usr/java
        • /usr/lib/jvm
        • /usr/lib64/graalvm
        • /opt
      • Windows
        • c:\\Program Files\\Java

      To include more paths, click + another path, and then provide the details of the additional path. To remove a path, click X to its right.

      Note

      • Include or exclude paths are applicable for Java runtime installations and applications.
      • File scanning looks for Java installations in the physical directories. Java installation symlinks (symbolic or soft link) will not be detected by file scanning.
    For a description of the syntax to describe file systems paths, see Include/Exclude Path Patterns.

    The "Parent Directory is not included" warning indicates that the path you added to the list of excluded paths is one that isn't currently included. (The additional path has no effect on the selection of file system paths that the fleet's management agents scan on their hosts to discover Java Runtime installations.)

    The "Parent Directory is not included" warning can be invalid if the include and exclude paths contain overlapping wildcard patterns. (For more information on the use of wildcard patterns, see Include/Exclude Path Patterns.)

    For example, the following wildcard patterns result in an invalid warning:
    • Include Path(s):/usr/**/java
    • Exclude Path(s): /usr/**/lib32/java

    The workaround for this issue is to replace wildcard patterns with an explicit path.

  4. Click Save changes.
    Note

    Changes to the management agents' settings might take some time to be effective.