On-premises macOS

This section describes the steps to set up the Oracle Management Agent and deploy the JMS plug-ins on macOS host using the installation script.

Prerequisites:

Run the installation script with sudo or administrative access and grant Full Disk Access permission.

Note

By default, the installation script will:

Generate usage tracker with additional functionality to collect the user.name property for better identification of applications running on Application Servers like WebLogic and Tomcat. If you do not want to enable this feature, update the parameter --enable-user-name=false in the installation script. You can modify the Java Usage Tracker properties file in the future to add or remove user.name from the additionalProperties section.
Disable Federal Information Processing Standards (FIPS) mode for plug-ins. To enable FIPS mode in USGov relams, update the parameter --enable-fips-mode=true in the installation script.
Install the agent with JMS lower telemetry frequency.

Run the --help command to view the description of options such as enabling or disabling user name, proxy settings, FIPS, and so on.

The following are the optional parameters along with the description:


-u, --uninstall             Uninstall plug-ins, delete configuration files or restore originals from backups and exit.
-r, --reinstall             Uninstall plug-ins, delete configuration files or restore originals from backups and continue installation.
-h, --help                  Print usage message end exit.
--diagnostic                Determine if prerequisite conditions are met on the host machine to allow successful 
                            agent installation and plug-in deployment.
--enable-user-name          Generate usage tracker with additional functionality to collect the user.name property for better
                            identification of applications running in Application Servers like Weblogic and Tomcat servers.
                            If you want to disable this feature, update the parameter --enable-user-name=false in the installation script.
                            Alternatively, modify /Library/Application Support/Oracle/Java/usagetracker.properties and add or remove 'user.name' in 				    'additionalProperties'.
                            Default value is true.
--enable-fips-mode          Enable FIPS mode for plugins in USGov realms.
                            Format is --enable-fips-mode=true|false (for example, --enable-fips-mode=false).
                            Modify /etc/bashrc and create a line with ENV_AGENT_PLUGIN_FIPS_APPROVED=true or false.
                            Without this parameter script won't change anything in /etc/bashrc file.
--proxy-host                Add proxy host to curl commands, add or replace line 'ProxyHost = VALUE' in install key before Management Agent setup.
                            Format is --proxy-host="VALUE" (for example, --proxy-host="100.0.0.10").
                            Default is no proxy. All proxy parameters are optional.
--proxy-port                Add proxy port to curl commands, add or replace line 'ProxyPort = VALUE' in install key before Management Agent setup.
                            Format is --proxy-port="VALUE" (for example, --proxy-port="8050").
--proxy-password            Add proxy password to curl commands, add or replace line 'ProxyPassword = VALUE' in install key before Management Agent 				    setup.
                            Format is --proxy-password="VALUE" (for example, --proxy-password="example").
--proxy-realm               Add or replace line 'ProxyRealm = VALUE' in install key before Management  Agent setup.
                            Format is --proxy-realm="VALUE" (for example, --proxy-realm="OC1").
--proxy-user                Add proxy user to curl commands, add or replace line 'ProxyUser = VALUE' in install key before Management Agent setup.
                            Format is --proxy-user="VALUE" (for example, --proxy-user="opc").
--use-agent-installer-path  Use this file to setup Management Agent. Optional parameter.
                            If exists, script won't try to find installation files in current folder.
--use-java-path             Use the Java Installation on this path to set up Management Agent. Optional parameter
                            Format is --use-java-path="JAVA_PATH" 
                           (for example, --use-java-path=/Library/Java/JavaVirtualMachines/jdk1.8.0361.jdk/Contents/Home).

Steps

(Optional diagnostic check) Navigate to the folder where you saved the installation script and management agent software. Run the script using the following command:

$ sudo bash ./JMS_YourFleetName_macos.sh --diagnostic

Depending on the operating system and agent type, the results will be similar to:

Diagnostic failed:

======================================================================================================
Diagnostic Summary
======================================================================================================
User has sudo/root privileges? : Yes
Certified OS? : Yes
Meets minimum disk requirements? : Yes
Meets minimum memory requirements? : Yes
Able to reach OCI endpoint? : Yes
Certificate verification has been passed? : Yes
Is clock sync with OCI platform? : Yes
Available Java for agent installation ? : Yes
Management Agent installer available? : No
	Script JMS_YourFleetName_macos.sh can't find the Management Agent installer /kkk.
	Check if the path /kkk exists and check the '--use-agent-installer-path' parameter.
Existing Management Agent has been detected? : No
================================================================================
Diagnostics have failed. Please resolve all issues and run script JMS_YourFleetName_macos.sh again.
Please refer troubleshooting guide https://docs.oracle.com/en-us/iaas/jms/doc/troubleshooting.html for more details.

A copy of this installation log can be found at /Library/Oracle/JMSInstallScript/JMSInstallScriptLogs-<date>.log

Diagnostic completed successfully:

======================================================================================================
Diagnostic Summary
======================================================================================================
User has sudo/root privileges? : Yes
Meets minimum disk requirements? : Yes
Meets minimum memory requirements? : Yes
Able to reach OCI endpoint? : Yes
Certificate verification has been passed? : Yes
Is clock sync with OCI platform? : Yes
Existing Management Agent has been detected? : No
Available Java for agent installation ? : Yes
Management Agent installer available? : Yes
======================================================================================================
Diagnostics have finished running and no error occurred.

See Running Agent Installation Diagnostics for the complete list of criteria checked during diagnostics, along with solutions or recommendations.

Navigate to the folder where you saved the installation script and management agent software. Run the script using the following command:
```
$ sudo bash ./JMS_YourFleetName_macos.sh
```
- If installation is successful, you'll see a message similar to the following:
```
...
Management Agent installation has been completed with 'Java Usage Tracking service plugin (Service.plugin.jms)'
JMS basic features will be enabled on this instance.
Management Agent installation has been completed with 'Java Management service plugin (Service.plugin.jm)'
JMS advanced features can be enabled on this instance.
Management Agent was successfully registered using key YourFleetName (ocid1.managementagentinstallkey.oc1.iad.<ocid hash>).Assigned JMS Fleet is YourFleetName (ocid1.jmsfleet.oc1.iad.<ocid hash>).
```
- In case the agent is already installed, the script will update the agent software to the latest version, if applicable. If JMS plug-ins are not deployed yet, deploy Java Usage Tracking and Java Management Service plug-ins manually as described in the Deploy a Service Plug-in Using the Agents Page. Or, you can reinstall the agent along with JMS plug-in deployment; run the script with the --force parameter.
(Optional) To verify if the management agent is running, type:
```
$ sudo launchctl print system/com.oracle.macs.agent.mgmt_agent | grep state
```
The results will show:
```
state = running
```
You can also view the console to verify if the management agent is running. See Management Agents Console Overview for more information.

The log files are located in the /Library/Oracle/mgmt_agent/plugins/jm/stateDir/log directory.

Oracle Cloud Infrastructure Documentation