ARMAGENT= System Option

Specifies another vendor's ARM agent, which is an executable module or keyword (such as, LOG4SAS), that contains a specific implementation of the ARM API.

Valid in: configuration file, SAS invocation, OPTIONS statement, SAS System Options window
Category: System Administration: Performance
PROC OPTIONS GROUP= PERFORMANCE
Restrictions: After you initialize the ARM subsystem, you cannot specify a different ARM agent using ARMAGENT=.
If ARMAGENT=LOG4SAS, ARMLOC= is ignored.
Note: In SAS 9.4, if you have an ARM appender that is defined in the XML configuration file, you no longer need to set the ARMAGENT=LOG4SAS system option. ARM sets ARMAGENT to LOG4SAS internally.
See: ARMAGENT= System Option under z/OS in the documentation for your operating environment.
Syntax
Syntax Description
Details
See Also

Syntax

ARMAGENT=module

Syntax Description

module

is the name of the executable module that contains an ARM agent, which is a program that contains a vendor's implementation of the ARM API.

Operating Environment Information: The maximum length for the module name is specific to your operating environment. For many operating environments, the maximum length is 32 characters. For the z/OS operating environment, see SAS Companion for z/OS.
Default for SAS 9.4 ARM interface: SAS

Details

An ARM agent is an executable module that contains an implementation of the ARM API. The ARM agent contains executable routines that are called from an application. The ARM agent and SAS run concurrently. SAS passes transaction information to the ARM agent, which collects, manages, and writes the ARM records to the ARM log or the SAS logging facility. SAS and other vendors provide an ARM agent.
By default, SAS uses ARMAGENT=SAS. Use ARMAGENT= to specify another executable module or keyword to monitor the internal SAS processing transactions (using ARMSUBSYS=) and user-defined transactions using ARM macros. If you specify ARMAGENT=LOG4SAS, the output is sent to the SAS logging facility, which enables you to have several logs.
When you start a Base SAS session, the following message might be displayed in the Base SAS Log window:
ERROR: Invalid ARM Agent name.
This error message is displayed in the following situations:
  • An invalid ARMAGENT value is specified. To correct this, use a valid value for ARMAGENT, such as:
    • LOG4SAS
    • SAS
    • the name of an external ARM agent
  • The LOGCONFIGLOC system option is not specified on the command line or in the configuration file. When the LOG4SAS agent is used, the LOGCONFIGLOC system option must specify a valid log appender definition XML file. For more information, see LOCCONFIGLOC= system option.
  • There is an error in the specification of the ARM appender. An ARM logger is called an appender. An ARM logger is defined in an XML file with other appenders for other purposes. Errors in the syntax of the ARM appender are not individually identified. For more information, see ARM Logger Overview.
  • The external ARM agent is not installed correctly.

See Also

System Options
ARMLOC= System Option
ARMSUBSYS= System Option
Copyright © SAS Institute Inc. All rights reserved.