16.20 - Usage Examples - Teradata Ecosystem Manager

Teradata® Ecosystem Manager API Reference

prodname
Teradata Ecosystem Manager
vrm_release
16.20
created_date
December 2020
category
Programming Reference
featnum
B035-3204-107K

Example: XML Structure

The following example includes all three metrics. Each metric is optional and can be specified independently. Each metric node (<metric>…</metric>) should have exactly two child arg nodes (<arg>…</arg>).

<metricCollector monitorClass=”com.teradata.tmsm.da.monitor.sigar.TDProcMonitor” interval=”300” name=”TDProcMon”>
    <metric resourceType=PING[sampleProcessExe] displayName=”sampleExe”>
        <arg>fullpathtoprocexec</arg>
        <arg>/opt/sampleProcExeDir/sampleProcessExe</arg>
    </metric>
    <metric resourceType=CPU USG[ProcETLExe] displayName=”ProcETL”>
        <arg>fullpathtoprocexec</arg>
        <arg>/opt/sampleProcExeDir/sampleProcessExe</arg>
    </metric>
    <metric resourceType=MEM_USG[sh] displayName=”ProcMoveScript”>
        <arg>commandlinearg</arg>
        <arg>/opt/ProcMoveDir/procMove.sh  db1 tbl1 db2 tbl2 5000 move.log.</arg>
    </metric>
    <metric resourceType=PING[java] displayName=”ProcMoveApp”>
        <arg>javafullclassname</arg>
        <arg>com.cmpName.moveClient.Mover.</arg>
    </metric>
<reporter class="com.teradata.tmsm.da.monitor.reporter.TMSMPublisher"/>
</metricCollector>

Example: XML Structure on Windows

In this example, sampleProcess.exe is a service. You can obtain the full path from the Services dialog box by clicking on the properties for the service. Similarly, C:\Program Files\appDir\client\app\services\sampler\conf\wrapper.conf is a command line argument for service C:\Program Files\appDir\client\app\services\sampler.exe, which can be seen in the Services dialog box by clicking the service property.

On the Windows platform, multiple command line arguments must be separated by the tilde character (~).
<metricCollector monitorClass="com.teradata.tmsm.da.monitor.sigar.TDProcMonitor" interval="300" name="TDProcMon">
    <metric resourceType=PING[sampleProcess.exe] displayName=”fullPathExe”>
	<arg>fullpathtoprocexec</arg>
	<arg>c:\Program Files\appDirectory\client\app\services\sampleProcess.exe</arg>
    </metric>
<metric resourceType=MEM_USG[sampler] displayName=”commandExe”>
	<arg>commandlinearg</arg>
	<arg>c:\Program Files\appDir\client\app\services\sampler\conf\wrapper.conf</arg>
    </metric>

<reporter class="com.teradata.tmsm.da.monitor.reporter.TMSMPublisher"/>
</metricCollector>