Table of Contents

Search

  1. Preface
  2. Introduction to Data Engineering Administration
  3. Authentication
  4. Running Mappings on a Cluster with Kerberos Authentication
  5. Authorization
  6. Cluster Configuration
  7. Cloud Provisioning Configuration
  8. Data Integration Service Processing
  9. Appendix A: Connections Reference
  10. Appendix B: Monitoring REST API

Data Engineering Administrator Guide

Data Engineering Administrator Guide

MappingAdvancedStats

MappingAdvancedStats

With the MappingAdvancedStats REST API, you can view mapping summary and detailed statistics, such as the job throughput for mappings that run in the native or Hadoop environment.

GET Request

To request information from the MappingAdvancedStats, use the following URL:
<RESTOperationsHubService_Host>:<RESTOperationsHubService_Port>/RestOperationsHub/services/v1/MappingService/MappingAdvancedStats('jobId')
The following table describes the attributes in the MappingAdvancedStats Get URL:
Field
Type
Description
userName
String
Required. User name to connect to the domain.
You can pass the input value as a header.
encryptedpassword
String
Required. Password for the user. Encrypt the password with the pmpasswd command line program.
You can pass the input value as a header.
securityDomain
String
Optional. The security domain to which the domain user belongs.
You can pass the input value as a header.
Default is Native.
jobId
String
Required. The argument of the entity that contains the ID for the mappings.
You can pass the property as part of the URL.

Get Response

Return information for the MappingAdvancedStats for the specified Job ID.
The following table describes the MappingAdvancedStats attributes present in the body of the response for native or Hadoop environment:
Field
Type
Description
jobId
String
The argument of the entity that contains the ID for the mapping.
mappingStat
n/a
Container for mapping run information, such as mapping name, start time, and end time.
status
String
State of the job run.
mappingName
String
Name of the mapping.
applicationName
String
Name of the application.
serviceName
String
Name of the service.
logFileName
String
Location of the log file.
startTime
Integer
Start time of the job.
endTime
Integer
End time of the job.
executorType
String
Type of the run-time environment where you run the mapping.
executingNode
String
The Data Integration Service node where the job ran.
userName
String
User who started the job.
securityDomain
String
The security domain to which the domain user belongs.
detailedStats
n/a
Container for detailed mapping statistics.
memoryData
String
Metrics for memory.
createdTime
Integer
Time taken to created the job.
cpuData
Integer
Data for CPU.
sourceTargetStats
n/a
Container for source and target statistics.
instanceName
String
Object name for source or target.
isSource
Integer
For the source, specify isSource as true. For the target, specify isSource as false.
bytes
Integer
Average number of bytes read per second for source or target.
rows
Integer
Number of rows read for source or target.
lastPurgeTime
Integer
Last time of the purge task.
summaryStats
n/a
Container for the summary statistics.
processStatSummary
n/a
Container for the CPU and memory usage.
avgCpuUsage
Integer
Average CPU usage.
avgMemUsage
Integer
Average memory usage.
sourceTxStats
n/a
Container for the source statistics.
groupStats
n/a
Container for processed and throughput statistics.
ProcessedBytes
Integer
Bytes processed for source or target.
ProcessedRows
Integer
Rows processed for source or target.
bytesThrougput
Integer
Throughput in bytes for source or target.
rowsThroughput
Integer
Throughput of rows for source or target.
sourceThroughput
Integer
Mean rate at which messages are ingested to source.
targetThroughput
Integer
Mean rate at which messages are written to target.
errorRows
Integer
Error in rows for source or target.
errorBytes
Integer
Error in bytes for source or target.
groupName
String
Name of the group for source or target.
firstRowTime
Integer
Time taken for the first row for source or target.
targetTxStats
n/a
Container for target statistics.

0 COMMENTS

We’d like to hear from you!