Starting the Monitoring Agent

Setting up the monitoring agent involves creating a keystore file, setting probe's arguments, setting probes, etc.

Before you begin:

On Linux, you must log in as root. On Windows, you must belong to the Administrators group or have the privileges assigned to the Administrators group. Otherwise, you will not be able to start the Monitoring Agent.

The username and password used to create the keystore file must be licensed to use the server. No specific roles or access are required for this username and password. A keystore file can be created on a different machine than the target production machine to further secure the username and password. After a keystore file is created, there is no way to access the username and password used to create it.

See Also
About Setting Up the Monitoring Agent
Monitoring the 3DEXPERIENCE Platform using the Monitoring Agent
Maintaining and Monitoring Clients
  1. Start the Monitoring Agent if installed as a service.

    To start and stop Monitoring Agent service on Windows, start and stop the 3DEXPERIENCE R2019x 3DMonitoringAgent service.

    To start and stop Monitoring Agent service on Linux:

    • Service start command: service 3DMonitoringAgent_R2019x start
    • Service stop command: service 3DMonitoringAgent_R2019x stop

    Here are the Monitoring Agent executable file locations on each operating system.

    For the Monitoring Agent And Probes:

    • Windows: <MonitoringAgentAndProbesInstallPath>\win_b64\code\command\StartMonitoringAgentSvc.bat
    • Linux: <MonitoringAgentAndProbesInstallPath>/linux_a64/code/command/StartMonitoringAgentSvc.sh

    For 3DEXPERIENCE platform services:

    • Windows: <3DEXPERIENCEserviceInstallPath>\win_b64\code\command\StartMonitoringAgentSvc.bat
    • Linux: <3DEXPERIENCEserviceInstallPath>/linux_a64/code/command/StartMonitoringAgentSvc.sh

  2. Generate the keystore.

    Run the following command from the command line, to create the keystore file at the location you selected during the Monitoring Agent installation installed as a service:

    • Windows: StartMonitoringAgentSvc.bat -setkey SERVICE [LOGIN] [PASSWORD]
    • Linux: StartMonitoringAgentSvc.sh -setkey SERVICE [LOGIN] [PASSWORD]

    where SERVICE is the service URL, for example the 3DPassport service URL.

    Enter the full keystore file path when the Monitoring Agent is not installed as a service, or when running the Monitoring Agent from the3DEXPERIENCE platform services install path:

    • Windows: startMonitoringAgentSvc.bat [-keystore PATH] -setkey SERVICE [LOGIN] [PASSWORD]
    • Linux: startMonitoringAgentSvc.sh [-keystore PATH] -setkey SERVICE [LOGIN] [PASSWORD]

    where:

    • PATH is the file path including the filename of the keystore file.

      Windows default path:

      %APPDATA%\DassaultSystemes\MonitoringAgent\conf\MonitoringAgent.ks

      Linux default path:

      /var/DassaultSystemes/MonitoringAgent/conf/MonitoringAgent.ks

    • SERVICE is the service URL, for example the 3DPassport service URL.

    While creating a keystore file, do not provide the username and password in the same create keystore command. Enter the username and password when prompted to enter them in a more secure way using standard Windows or Linux login procedures.

    You need to create a keystore file only if the agent is monitoring a component that requires authentication. For example, the 3DPassport service requires authentication.

  3. Set the probes' arguments.

    Run the following command from the command line to set probes' arguments:

    • Windows: StartMonitoringAgentSvc.bat -setVar VAR_NAME VAR_VALUE [-cfg PATH]
    • Linux: StartMonitoringAgentSvc.sh -setVar VAR_NAME VAR_VALUE [-cfg PATH]

  4. Remove the probes' arguments.

    Run the following command from the command line to remove the probes' arguments.

    • Windows: StartMonitoringAgentSvc.bat -rmVar VAR_NAME [-cfg PATH]
    • Linux: StartMonitoringAgentSvc.sh -rmVar VAR_NAME [-cfg PATH]

  5. Set up the probes.

    Run the following command from the command line to set up a probe:

    • Windows: StartMonitoringAgentSvc.bat -setProbe PROBE_NAME PROBE_SUBJECT [-cfg PATH]
    • Linux: StartMonitoringAgentSvc.sh -setProbe PROBE_NAME PROBE_SUBJECT [-cfg PATH]

    with:

    [<parameter_name>=<value>]*
[condition:<expr>]
[period:<period value>]
[active:[true|false]]

    where:

    • PROBE_NAME is the name of the probe
    • PROBE_SUBJECT is the name of the probe's subject.
    • <parameter_name> is the name of one of the probe's parameters; it must be followed by an equal sign and the value <value> that will be assigned to this parameter.
    • <value> is a string which may contain one or more references to variables, using the {VAR_NAME} syntax, where VAR_NAME is set by the -setVar command
    • <expr> is conditional expression; currently only os=<value> and VMHaMode=<value> conditions are available.
    • <period value> is the period at which the monitoring agent calls the probe; it must have the following form:
      • <duration>s for a period expressed in seconds
      • <duration>m for a period expressed in minutes
      • <duration>h for a period expressed in hours

      where <duration> is a positive integer value.

  6. Remove a probe.

    Run the following command from the command line to remove a probe:

    • Windows: StartMonitoringAgentSvc.bat -rmProbe PROBE_NAME PROBE_SUBJECT [-cfg PATH]
    • Linux: StartMonitoringAgentSvc.sh -rmProbe PROBE_NAME PROBE_SUBJECT [-cfg PATH]