Monitoring Agent for Sterling Connect Direct metrics

The metrics for Monitoring Agent for Sterling Connect Direct resource types collect data for monitoring with IBM Cloud Pak for Multicloud Management. Every Monitoring Agent for Sterling Connect Direct resource type defines a set of dimensions and metrics. The descriptions provide such information as data type, dimension key, and metric unit.

Resource Sterling Connect Direct Node

Sterling Connect Direct Node, which is peer node (PNODE or SNODE). The following section lists the metrics, dimensions and components of Resource Sterling Connect Direct Node.

Metrics

The following metrics are available for the resource.

CDNode

• The alias name which is used to identify Connect Direct server.
• The type is string.
• The unit is name.

Port

• The port number which is used to connect to the Connect Direct server.
• The type is int.
• The unit is number.

Server IP

• IP of the connect Direct Server.
• The type is string.
• The unit is name.

Server Name

• The HostName of the Connect Direct server.
• The type is string.
• The unit is name.

Dimensions

The following dimensions are available for the resource.

CD User

• The user name used to connect to the Connect Direct Server.
• The type is string.

CD Version

• Version of the Connect Direct Server.
• The type is string.

Exception Message

• The reason for the inactive state of the server.
• The type is string.

Node

• Originnode.
• The type is string.

OSType

• The name of the operating system on which Connect Direct server is installed.
• The type is string.

Protocol

• The name of Network Protocol used to connect to the server.
• The type is string.

Status

• The current status of the Connect Direct Server.
• The type is string.

Timestamp

• This is the local time when the data was collected. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is timestamp.

Component: Connect Direct Hold Queue Process

This is the sub-resource for Connect Direct Hold Queue Process. The following section lists the metrics and dimensions of Component Connect Direct Hold Queue Process.

Metrics

The following metrics are available for the component.

CDHoldQueueProcess Number of Minutes in Hold Queue

• The number of minutes this process is in Hold queue.
• The type is int.
• The unit is minutes.

CDHoldQueueProcess Process Id

• The ID of Connect Direct file transfer process which is in Hold queue.
• The type is int.
• The unit is number.

Dimensions

The following dimensions are available for the component.

CDHoldQueueProcess Destination Node

• The name of the Connect Direct destination node on which file will be copied.
• The type is string.

CDHoldQueueProcess Message Id

• The status ID of the Hold queue process.
• The type is string.

CDHoldQueueProcess Message Text

• The message of process execution status.
• The type is string.

CDHoldQueueProcess node

• CDHoldQueueProcess node.
• The type is string.

CDHoldQueueProcess Process Name

• The name of Connect Direct file transfer process which is in Hold queue.
• The type is string.

CDHoldQueueProcess Process Status

• The status of the process which is in hold queue.
• The type is string.

CDHoldQueueProcess Retain Status

• The retain status of the process. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is string.

CDHoldQueueProcess Source Node

• The name of the Connect Direct source node from where file will be copied. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is string.

CDHoldQueueProcess Submit Time

• The time at which process is submitted. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is string.

CDHoldQueueProcess Submitter

• The user name who initiated the scheduled task. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is string.

CDHoldQueueProcess Submitter Node

• The name of the machine from where Submitter initiated the process. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is string.

Component: Connect Direct Process

This is the sub-resource for Connect Direct Process. The following section lists the metrics and dimensions of Component Connect Direct Process.

Metrics

The following metrics are available for the component.

CDProcess Bytes Lost

• The number of bytes that have been lost during file transfer process. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is int.
• The unit is bytes.

CDProcess Bytes Read

• The number of bytes that have been read during file transfer process.
• The type is int.
• The unit is bytes.

CDProcess Bytes Received

• The number of bytes that have been received during file transfer process.
• The type is int.
• The unit is bytes.

CDProcess Bytes Sent

• The number of bytes that have been sent during file transfer process.
• The type is int.
• The unit is bytes.

CDProcess Bytes Written

• The number of bytes that have been written during file transfer process.
• The type is int.
• The unit is bytes.

CDProcess Time Elapsed

• The number of minutes that have been elapsed till now after execution of the process step. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is int.
• The unit is minutes.

Dimensions

The following dimensions are available for the component.

CDProcess Completion Code

• The completion code of the file copy activity.
• The type is string.

CDProcess Destination File

• The full path of the file on the destination connect Direct node where file is copied.
• The type is string.

CDProcess Destination Node

• The name of the destination Connect Direct Node(SNode) on which file is copied.
• The type is string.

CDProcess Direction

• The direction of file, that is, either the file is copied from monitored server(Outbound) or file is copied to monitored server(Inbound).
• The type is string.

CDProcess End Time

• The time at which execution of the process is completed.
• The type is timestamp.

CDProcess Message ID

• The copy status message ID.
• The type is string.

CDProcess Message Text

• The message of process execution status.
• The type is string.

CDProcess Node

• Origin Node.
• The type is string.

CDProcess Process ID

• The ID of Connect Direct file transfer process that user has submitted.
• The type is int.

CDProcess Process ID Step Name

• The combination of process ID and step name to identify the file copy uniquely.
• The type is string.

CDProcess Process Initiator

• The name of the user who initiated the process execution.
• The type is string.

CDProcess Process Name

• The name of Connect Direct file transfer process that user has submitted.
• The type is string.

CDProcess Process Return Code

• The completion code of Connect Direct process execution.
• The type is string.

CDProcess Record ID

• The record ID of copy step.
• The type is string.

CDProcess Source File

• The full file path of the source file from source Connect Direct node which is elected for file transfer.
• The type is string.

CDProcess Source Node

• The name of the source Connect Direct Node(PNode) from where file is copied.
• The type is string.

CDProcess Start Time

• The time at which execution of the process has started.
• The type is timestamp.

CDProcess Step Name

• The name of Connect Direct process step.
• The type is string.

Component: Connect Direct Process Statistics

This is the sub-resource for Connect Direct Process Statistics. The following section lists the metrics and dimensions of Component Connect Direct Process Statistics .

Metrics

The following metrics are available for the component.

CDProcessStat Failed File Transfer

• The count of failed file transfers from Connect Direct server in user specified time period (default 24 hours).
• The type is int.
• The unit is fileTransfers.

CDProcessStat Failed File Transfer Percent

• The percentage of failed file transfers from Connect Direct server in user specified time period (default 24 hours).
• The type is double.
• The unit is percent.

CDProcessStat Failed Process Percent

• The percentage of processes that have been failed during execution on Connect Direct server in user specified time period (default 24 hours).
• The type is double.
• The unit is percent.

CDProcessStat Successful File Transfer

• The count of files that are successfully transferred from Connect Direct server in user specified time period (default 24 hours).
• The type is int.
• The unit is files.

CDProcessStat Successful File Transfer Percent

• The percentage of successful file transfers from Connect Direct server in user specified time period (default 24 hours).
• The type is double.
• The unit is percent.

CDProcessStat Successful Process Percent

• The percentage of processes that have been successfully executed in Connect Direct server in user specified time period (default 24 hours). This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is double.
• The unit is percent.

CDProcessStat Total Failed Process

• The count of processes that have been failed during execution on Connect Direct server in user specified time period (default 24 hours).
• The type is int.
• The unit is processes.

CDProcessStat Total File Transfer

• The count of files that are attempted to transfer from Connect Direct server in user specified time period (default 24 hours).
• The type is int.
• The unit is files.

CDProcessStat Total Processes

• The count of processes that have been executed in Connect Direct server in user specified time period (default 24 hours).
• The type is int.
• The unit is processes.

CDProcessStat Total Success

• The count of processes that have been successfully executed in Connect Direct server in user specified time period (default 24 hours).
• The type is int.
• The unit is processes.

Dimensions

The following dimensions are available for the component.

CDProcessStat node

• CDProcessStat node.
• The type is string.

Component: Connect Direct Scheduled Processes

This is the sub-resource for Connect Direct Scheduled Processes. The following section lists the metrics and dimensions of Component Connect Direct Scheduled Processes.

Metrics

The following metrics are available for the component.

Bytes Lost

• The number of bytes that have been lost during file transfer process.
• The type is int.
• The unit is bytes.

Bytes Read

• The number of bytes have been read during file transfer process.
• The type is int.
• The unit is bytes.

Bytes Received

• The number of bytes that have been received during file transfer process.
• The type is int.
• The unit is bytes.

Bytes sent

• The number of bytes that have been sent during file transfer process.
• The type is int.
• The unit is bytes.

Bytes Sent per second

• The rate of file transfer during process execution in bytes per second.
• The type is int.
• The unit is bytes/second.

Bytes Written

• The number of bytes that have been written during file transfer process.
• The type is int.
• The unit is bytes.

CDScheduledProcess File Size

• The total size of files that are being transferred during process execution.
• The type is int.
• The unit is megabytes.

CDScheduledProcess Process Id

• The ID of Connect Direct file transfer process which is executed for the scheduled task.
• The type is int.
• The unit is number.

CDScheduledProcess Transfer Rate

• The minimum transfer rate of the multiple files that are transferred in a process.
• The type is int.
• The unit is transferRate.

Execution Time (seconds)

• The time in seconds required to complete the Connect Direct file Transfer process.
• The type is int.
• The unit is seconds.

Upcoming Time (minutes)

• The time in minutes remaining to execute the scheduled process again.
• The type is int.
• The unit is minutes.

Dimensions

The following dimensions are available for the component.

CDScheduledProcess Is Upcoming Schedule

• Specifies if the scheduled process is within the time range specified for the KFC_UPCOMING_SCHE_SPAN environment variable.
• The type is string.

CDScheduledProcess Overall Status

• The status of the executed scheduled process.
• The type is string.

CDScheduledProcess Priority

• The priority assigned to the scheduled process.
• The type is string.

CDScheduledProcess Process Status

• The status of the scheduled process. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is string.

CDScheduledProcess Scheduled DateTime

• The scheduled time of scheduled process.
• The type is string.

CDScheduledProcess Submitted DateTime

• The submitted time of scheduled process.
• The type is string.

CDScheduledProcess Submitter User Id

• The Connect Direct User ID which scheduled this scheduled process.
• The type is string.

CDScheduledProcess Target Node

• The name of the Connect Direct destination node on which file will be copied.
• The type is string.

CDScheduledProcess_node

• CDScheduledProcess_node.
• The type is string.

Copy Status

• The file copy status.
• The type is string.

Destination File

• The full file path on the destination connect Direct node where file is copied.
• The type is string.

Destination Node

• The name of the Connect Direct destination node on which file will be copied.
• The type is string.

End Time

• The time at which Process execution is completed.
• The type is timestamp.

Message ID

• The copy status message ID.
• The type is string.

Message Text

• The message of the process execution status.
• The type is string.

Overall Completion Status

• The process execution status.
• The type is string.

Process ID

• The ID of Connect Direct file transfer process which is executed for the scheduled task.
• The type is string.

Process ID Step Name

• The combination of process ID and step name to identify file copy uniquely.
• The type is string.

Schedule Frequency

• The frequency of the scheduled process in terms of daily or weekly basis.
• The type is string.

Scheduled Process ID

• The ID of Connect Direct file transfer process that user has scheduled to run on specific time.
• The type is string.

Scheduled Process Name

• The name of scheduled Connect Direct file transfer process.
• The type is string.

Scheduled Time

• The execution time of the scheduled process.
• The type is timestamp.

Source File

• The full file path of the source file from source Connect Direct node which is elected for file transfer.
• The type is string.

Source Node

• The name of the Connect Direct source node from where file will be copied.
• The type is string.

Start Time

• The time at which Process execution has begun.
• The type is timestamp.

Step Name

• The name of the steps or activities which are included in Process.
• The type is string.

Submitter

• The user name who initiated the scheduled task.
• The type is string.

Submitter Node

• The name of the machine from where Submitter initiated the process.
• The type is string.

Component: Connect Direct ScheduledProcess Statistics

Stering Connect Direct ScheduledProcess Statistics. The following section lists the metrics and dimensions of Component Connect Direct ScheduledProcess Statistics.

Metrics

The following metrics are available for the component.

CDScheduledProcessStat Failed File Transfer

• The count of scheduled file transfers that are failed from Connect Direct server during their last attempt.
• The type is int.
• The unit is fileTransfers.

CDScheduledProcessStat Failed File Transfer Percent

• The percentage of scheduled file transfers that are failed from Connect Direct server during their last attempt. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is double.
• The unit is percent.

CDScheduledProcessStat Failed Process Percent

• The percentage of scheduled processes that failed to execute successfully on Connect Direct server during their last execution. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is double.
• The unit is percent.

CDScheduledProcessStat Failed Processes

• The count of scheduled processes that failed to execute successfully on Connect Direct server during their last execution.
• The type is int.
• The unit is count.

CDScheduledProcessStat Successful File Transfer

• The count of scheduled file transfers that are successful from Connect Direct server during their last attempt.
• The type is int.
• The unit is fileTransfers.

CDScheduledProcessStat Successful File Transfer Percent

• The percentage of scheduled file transfers that are successful from Connect Direct server during their last attempt. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is double.
• The unit is percent.

CDScheduledProcessStat Successful Process Percent

• The percentage of scheduled processes that have been successfully executed on Connect Direct server during their last execution. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is double.
• The unit is percent.

CDScheduledProcessStat Successful Processes

• The count of scheduled processes that are executed successfully on Connect Direct server during their last execution.
• The type is int.
• The unit is processes.

CDScheduledProcessStat Total File Transfer

• The count of files that are scheduled to transfer from Connect Direct server. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is int.
• The unit is files.

CDScheduledProcessStat Total Processes

• The count of processes that are scheduled on Connect Direct server.
• The type is int.
• The unit is processes.

Dimensions

The following dimensions are available for the component.

CDProcessStat Node

• CDScheduledProcessStat Node.
• The type is string.

Component: Connect Direct Select Statistics

This is subresource for Connect Direct Select Statistics for connect direct processes. The following section lists the metrics and dimensions of Component Connect Direct Select Statistics .

Metrics

The following metrics are available for the component.

Dimensions

The following dimensions are available for the component.

CDSelectStatistics Completion Code

• The execution status returned by process in terms of return code.
• The type is string.

CDSelectStatistics Message Id

• The unique Message ID assigned to each step involved in process execution.
• The type is string.

CDSelectStatistics Message Text

• The execution status of each record of the process.
• The type is string.

CDSelectStatistics node

• CDSelectStatistics_node.
• The type is string.

CDSelectStatistics Process Id

• The ID of Connect Direct file transfer process that user has submitted and currently in wait queue.
• The type is string.

CDSelectStatistics Rec Id Detail

• The details of execution status of each record of the process.
• The type is string.

CDSelectStatistics Record Id

• The predefined ID assigned to each step involved in process execution.
• The type is string.

Component: Connect Direct Wait Queue Processes

This is sub-resource of Connect Direct Wait Queue Processes. The following section lists the metrics and dimensions of Component Connect Direct Wait Queue Processes.

Metrics

The following metrics are available for the component.

Dimensions

The following dimensions are available for the component.

CDWaitQueueProcess Destination Node

• The name of the Connect Direct destination node on which file will be copied.
• The type is string.

CDWaitQueueProcess Message Id

• The status ID of the Wait queue process. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is string.

CDWaitQueueProcess node

• CDWaitQueueProcess node.
• The type is string.

CDWaitQueueProcess Priority

• The priority assigned to the process.
• The type is string.

CDWaitQueueProcess Process Id

• The ID of Connect Direct file transfer process that user has submitted and currently in wait queue.
• The type is string.

CDWaitQueueProcess Process Name

• The name of Connect Direct file transfer process that user has submitted and currently in wait queue.
• The type is string.

CDWaitQueueProcess Process Status

• The current status of the process.
• The type is string.

CDWaitQueueProcess Scheduled DateTime

• The scheduled execution time of the process. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is string.

CDWaitQueueProcess Source Node

• The name of the Connect Direct source node from where file will be copied. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is string.

CDWaitQueueProcess Submitter UserId

• The Connect Direct User ID which executed this process. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is string.

Component: File Transfer Statistics

This is sub-resource for File Transfer Statistics. The following section lists the metrics and dimensions of Component File Transfer Statistics .

Metrics

The following metrics are available for the component.

Attempted Files Transfered

• The count of files that are attempted to be transferred from Connect Direct server during current day. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is int.
• The unit is files.

Failed File Transfered Percent

• The percentage of failed file transfers from Connect Direct server during current day. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is double.
• The unit is percent.

Failed File Transfers

• The count of failed file transfers from Connect Direct server during current day. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is int.
• The unit is count.

Successful File Transfered

• The count of files that are successfully transferred from Connect Direct server during current day. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is int.
• The unit is files.

Successful File Transfered Percent

• The percentage of successful file transfers from Connect Direct server during current day. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is double.
• The unit is percent.

Dimensions

The following dimensions are available for the component.

FileTransferStat node

• FileTransferStat node. This is not available in the UI by default. It can be made available through dynamic configuration.
• The type is string.

Component: Inbound Outbound File Transfer

This is the sub-resource for Inbound Outbound File Transfer. The following section lists the metrics and dimensions of Component Inbound Outbound File Transfer.

Metrics

The following metrics are available for the component.

InOutBoundTransfer Inbound Data Transfers

• The size in megabytes of data received during user specified time period (default 24 hours).
• The type is int.
• The unit is megabytes.

InOutBoundTransfer Inbound File Transfers

• The count of files received during user specified time period (default 24 hours).
• The type is int.
• The unit is files.

InOutBoundTransfer Outbound Data Transfers

• The size in megabytes of data transferred during user specified time period (default 24 hours).
• The type is int.
• The unit is megabytes.

InOutBoundTransfer Outbound File Transfers

• The count of files transferred during user specified time period (default 24 hours).
• The type is int.
• The unit is files.

Dimensions

The following dimensions are available for the component.

InOutBoundTransfer node

• InOutBoundTransfer_node.
• The type is string.

Component: Inbound Outbound File Transfer Statistics

This is the sub-resource of Inbound Outbound File Transfer statistics. The following section lists the metrics and dimensions of Component Inbound Outbound File Transfer Statistics .

Metrics

The following metrics are available for the component.

InOutFileTransfer Failed File Transfers

• The count of failed file transfers during user specified time period (default 24 hours) in inbound and outbound direction.
• The type is int.
• The unit is transfers.

InOutFileTransfer Successful File Transfers

• The count of successful file transfers during user specified time period (default 24 hours) in inbound and outbound direction.
• The type is int.
• The unit is transfers.

InOutFileTransfer Total Files

• The count of files transferred or received during user specified time period (default 24 hours).
• The type is int.
• The unit is files.

InOutFileTransfer Total Megabytes

• The size of data in megabytes that is transferred or received during user specified time period (default 24 hours).
• The type is double.
• The unit is megabytes.

Dimensions

The following dimensions are available for the component.

InOutFileTransfer node

• InOutFileTransfer node.
• The type is string.

InOutFileTransfer Type

• The type of file transfer statistics.
• The type is string.