Copyright © Cloud Software Group, Inc. All Rights Reserved

Central Logger Database

The Central Logger stores the transactions and transaction details in the database tables.

Database Tables

The database schema includes the following tables:

•	ASG_TRANSACTIONS

•	ASG_TRANSACTION_DETAILS

•	ASG_TRANSACTION_MESSAGES

•	ASG_TRANSACTION_KEYS

•	ASG_THROTTLE_MESSAGES

•	ASG_THROTTLE_USAGE

•

ASG_KPI

•	ASG_LOG_MESSAGES

Schema Details

The following figure shows the schema details for the Central Logger database.

Figure 32 Central Logger Database Schema

 

ASG_TRANSACTIONS Table

The ASG_TRANSACTIONS table contains the basic statistics such as facade operation name, target operation name, routing key, the name of the Core Engine for each request. The Central Logger inserts one transaction record for each request in this table.

Table 143 Columns Of ASG_TRANSACTIONS Table

Field Name	Description
TRN_GUID	• The primary key as an unique reference for the transaction. • GUID is generated automatically by the Central Logger component.
TRN_TIMESTAMP	The time of the request.
TRN_SITE	• The site name which accepts the request. You can use different gateway sites or environments for TIBCO API Exchange Gateway product. • The value for the TRN_SITE field is populated from the Common/Deployments/SiteNumber global variable defined in the ASG_CONFIG_HOME/asg_cl.properties file. The default value of Common/Deployments/SiteNumber is 1.
TRN_ENGINE	The name of the engine which processes the transaction request. You can assign different engine names when starting the Gateway core engine. The engine name can be specified using -n parameter to asg-engine command on the command line.
TRN_SOURCE	The partner name, such as anon, who is the requestor of the operation.
TRN_TARGET	The value returned from the OpCo field of the parsing step of the request processing.
TRN_FACADE_OPERATION	The facade operation name.
TRN_FACADE_SERVICE	The facade service name. Not currently used, may be used in future.
TRN_ROUTING_KEY	The evaluated routing key used to determine the target operation.
TRN_TARGET_OPERATION	The target operation name or the target operation group.
TRN_TARGET_SERVICE	The target service name. Not currently used, may be used in future.
TRN_TRANSACTION_ID	The transaction id passed with the request.
TRN_FACADE_I_TIME	The ingress (reception) time (in milliseconds) for the facade operation message.
TRN_ROUTER_I_TIME	The egress (emission) time (in milliseconds) for the first target operation message.
TRN_FACADE_E_TIME	The egress (emission) time (in milliseconds) for the northbound message.
TRN_ROUTER_E_TIME	The (reception) time (in milliseconds) for the last target operation message.
TRN_FACADE_DURATION	The total time (in milliseconds) spent in the gateway.
TRN_ROUTER_DURATION	The total time (in milliseconds) waiting for the response from the back-end service (target operation).
TRN_STATUS	The completion status of the transaction.
TRN_ERROR_CODE	The error code for the transaction, if the transaction finished with error.
TRN_ERROR_MESSAGE	The error message for the transaction, if the transaction finished with error.
TRN_APP_ID	The application ID.
TRN_APP_NAME	The name of the application.
TRN_PRODUCT_ID	The product ID.
TRN_PRODUCT_NAME	The name of the product.
TRN_PARTNER_ID	The ID of the partner.

 

ASG_TRANSACTION_DETAILS Table

The ASG_TRANSACTION_DETAILS table contains the transaction details of the request and response messages exchanged between the facade operation and target operation of the back-end service. The Central Logger inserts six detail rows for each transaction request.

The ASG_TRANSACTION_DETAILS table is populated only when you enable the detail logging. The detail level logging is set in the ASG_CONFIG_HOME/asg.properties file, using the following property: tibco.clientVar.ASG/Logging/clLogLevel

Table 144 Columns of ASG_TRANSACTION_DETAILS Table

Field Name	Description
DET_TRN_GUID	The reference to the transaction in the ASG_TRANSACTIONS table.
DET_SEQ	The sequence order number of the transaction.
DET_TYPE	The type of the message. The possible values are: • nb.request • cn.request • sb.request • sb.response • cn.response • nb.response
DET_BODY	The body of the request or response payload.

ASG_TRANSACTION_MESSAGES Table

The ASG_TRANSACTION_MESSAGES table contains the record of log messages reported during the message processing.

Table 145 Columns of ASG_TRANSACTION_MESSAGES Table

Field Name	Description
MSG_TRN_GUID	The reference to the transaction in the ASG_TRANSACTIONS table.
MSG_SEQ	The sequence number of the transaction log message.
MSG_TIMESTAMP	The time of the transaction log message.
MSG_LEVEL	The severity of the transaction log message.
MSG_TEXT	The text of the transaction log messages related to stages in the lifecycle.

ASG_TRANSACTION_KEYS Table

The ASG_TRANSACTION_KEYS table stores the reference data passed in the body of request message. An example is the customer reference data sent in the request message.

Table 146 Columns of ASG_TRANSACTION_KEYS Table

Field Name	Description
KEY_TRN_GUID	The foreign key reference to the transaction in the ASG_TRANSACTIONS table.
KEY_VALUE	The transaction key name such as tel:4366412345678.
KEY_TYPE	The key type of the transaction message. The type of the transaction message is populated from the address element in the transformation xslt file specified for the parse output document.

ASG_THROTTLE_USAGE Table

The ASG_THROTTLE_USAGE table stores the usage information related to throttles and subscriptions.

Table 147 Columns of ASG_THROTTLE_USAGE Table

Field Name	Description
THU_GUID	An unique id of the throttle.
THU_TIMESTAMP	The timestamp of the throttle record entry.
THU_SITE	• The site name which accepts the request. You can use different gateway sites or environments for TIBCO API Exchange Gateway product. • The value for the THU_SITE field is populated from the Common/Deployments/SiteNumber global variable defined in the ASG_CONFIG_HOME/asg_cl.properties file. The default value of Common/Deployments/SiteNumber is 1.
THU_ENGINE	The name of the Core Engine which sends the throttle information. You can assign different engine names when starting the Core Engine. The engine name can be specified using -n parameter to asg-engine command on the command line.
THU_THROTTLE	The name given to the throttle for identification.
THU_MAX	The maximum threshold count of the throttle.
THU_CUR	The current usage count of the throttle.
THU_PCT	The current percentage usage of the throttle.

ASG_THROTTLE_MESSAGES Table

The ASG_THROTTLE_MESSAGES table stores the messages related to throttles.

Table 148 Columns of ASG_THROTTLE_MESSAGES Table

Field Name	Description
THM_GUID	An unique id of the throttle.
THM_TIMESTAMP	The timestamp of the throttle record entry.
THM_SITE	• The site name which accepts the request. You can use different gateway sites or environments for TIBCO API Exchange Gateway product. • The value for the THM_SITE field is populated from the Common/Deployments/SiteNumber global variable defined in the ASG_CONFIG_HOME/asg_cl.properties file. The default value of Common/Deployments/SiteNumber is 1.
THM_ENGINE	The name of the Core Engine which sends the throttle information. You can assign different engine names when starting the Core Engine in any of the following ways: • Use the "-n" parameter to asg-engine command on the command line. • Change the name of the PU in the ASG_HOME/bin/asg_core.cdd file.
THM_MESSAGE	The text of the message related to the throttle. The message can be one of the following types: • INFO • ERROR • DEBUG • WARN
THM_LEVEL	The severity of the message related to the throttle. The severity of the message is populated based on the log level set in the ASG_CONFIG_HOME/asg.properties file using the following global variable: • tibco.clientVar.ASG/Logging/ThrottleMessageLogLevel The default value is 0.

ASG_KPI Table

The ASG_KPI table stores information regarding the key performance indicators (KPI ) of the transactions stored in the ASG_TRANSACTIONS table to support visualizations. The central logger flushes the records in regular time frames as per the KPI configuration. You should use the ASG_TRANSACTIONS table for historical data analysis.

Table 149 Columns of ASG_KPI Table

Field Name	Description
KPI_TIMESTAMP	The timestamp.
KPI_SUCCESS_CNT	The count of successful transactions with status = OK.
KPI_FAILURE_CNT	The count of failed transactions with status = INVALID/FAIL.
KPI_TIMEOUT_CNT	The count of the timed out transactions.
KPI_ERROR_CNT	The count of the transactions with error as response.
KPI_TOTAL_CNT	The total number of transactions in a chosen period.
KPI_AVG_LATENCY	The average time spent in the gateway, which measures the gateway overhead. The average KPI latency time for a transaction is calculated from the ASG_TRANSACTIONS table as below: (Façade E Time – Façade Ingress Time – Router Egress Time – Router Ingress Time)
KPI_AVG_DURATION	The average time between request and response message. The average KPI duration for a transaction is calculated from the ASG_TRANSACTIONS table as below: (Façade Egress Time – Façade Ingress Time)
KPI_TYPE	The KPI dimension. The possible values are: • Engine • Operation • Partner • Service
KPI_ENTITY	Unique value for the KPI dimension.
KPI_FREQUENCY	The name of aggregation group such as kpi1m , kpi5m, kpi1h.

ASG_LOG_MESSAGES Table

The ASG_LOG_MESSAGES table contains the log messages generated by the gateway core engine. When the detail level logging is enabled for the central logger, the ASG_LOG_MESSAGES table is populated.

Table 150 Columns of ASG_LOG_MESSAGES Table

Field Name	Description
LOG_GUID	The unique ID of the message.
LOG_TIMESTAMP	The timestamp of the message.
LOG_SITE	• The site name which processes the request. You can use different gateway sites or environments for TIBCO API Exchange Gateway product. • The value for the TRN_SITE field is populated from the Common/Deployments/SiteNumber global variable defined in the ASG_CONFIG_HOME/asg_cl.properties file. The default value of Common/Deployments/SiteNumber is 1.
LOG_ENGINE	The name of the Core Engine which generates the message. You can assign different engine names when starting the Core Engine. The engine name can be specified using -n parameter to asg-engine command on the command line.
LOG_MESSAGE	The text of the transaction log message.
LOG_LEVEL	The severity of the log message. The severity of the message is mentioned by the level of logging set in ASG_CONFIG_HOME/asg.properties file. The possible values for the level of logging are 0,1,2,3,4.

Copyright © Cloud Software Group, Inc. All Rights Reserved