Top Banner
Proprietary and Confidential Information of F5 Networks F5 Signaling Delivery Controller Transaction Data Records Software Version: 4.0.5 Publication Date: April 2014 Catalog Number: FD-014-405-19 Ver. 3
12

F5 Signaling Delivery Controller Transaction Data Records · F5 Signaling Delivery Controller Transaction Data ... F5 Signaling Delivery Controller Transaction Data Records ... Origin_Host_Answer

Jun 30, 2018

Download

Documents

duonghanh
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: F5 Signaling Delivery Controller Transaction Data Records · F5 Signaling Delivery Controller Transaction Data ... F5 Signaling Delivery Controller Transaction Data Records ... Origin_Host_Answer

Proprietary and Confidential Information of F5 Networks

F5 Signaling Delivery Controller

Transaction Data Records

Software Version: 4.0.5

Publication Date: April 2014

Catalog Number: FD-014-405-19 Ver. 3

Page 2: F5 Signaling Delivery Controller Transaction Data Records · F5 Signaling Delivery Controller Transaction Data ... F5 Signaling Delivery Controller Transaction Data Records ... Origin_Host_Answer

Proprietary and Confidential Information of F5 Networks

2

LEGAL INFO .............................................................................................................................. 3

Copyright .......................................................................................................................................................... 3

Trademarks ...................................................................................................................................................... 3

1 ABOUT THIS DOCUMENT .......................................................................................................................... 4

DOCUMENT OBJECTIVES ................................................................................................ 4

CONVENTIONS ............................................................................................................. 4

1.1 GLOSSARY OF TERMS AND ABBREVIATIONS ....................................................................... 5

DOCUMENT VERSION HISTORY ....................................................................................... 5

2 ABOUT TRANSACTION DATA RECORDS ..................................................................................................... 6

INTRODUCTION ............................................................................................................ 6

WORKING WITH TDRS USING THE EMS WEB UI ............................................................... 6

2.2.1 TDR Dashboard .................................................................................................................................. 7

2.2.2 Transaction Data Reports .................................................................................................................. 8

PERIODIC TDR REPORT EXPORT ...................................................................................... 9

2.3.1 Returned Result_Code field values .................................................................................................. 10

ENABLING AND CONFIGURING TDRS .............................................................................. 11

ABOUT F5 NETWORKS...................................................................................................................................... 12

Page 3: F5 Signaling Delivery Controller Transaction Data Records · F5 Signaling Delivery Controller Transaction Data ... F5 Signaling Delivery Controller Transaction Data Records ... Origin_Host_Answer

Proprietary and Confidential Information of F5 Networks

3

Legal Info

Document Name: F5 Signaling Delivery Controller 4.0.5 Transaction Data Records

Catalog Number: FD-014-405-19 Ver.2

Publication Date: April 2014

Copyright

© 2005-2014 F5 Networks, Inc. All rights reserved.

F5 Networks, Inc. (F5) believes the information it furnishes to be accurate and reliable.

However, F5 assumes no responsibility for the use of this information, nor any infringement of

patents or other rights of third parties which may result from its use. No license is granted by

implication or otherwise under any patent, copyright, or other intellectual property right of F5

except as specifically described by applicable user licenses. F5 reserves the right to change

specifications at any time without notice.

Trademarks

F5 Networks, F5, F5 (design), OpenBloX, OpenBloX (design), Rosetta Diameter Gateway,

Diameter Load Balancer, Signaling Delivery Controller and SDC, are trademarks or service

marks of F5 Networks, Inc., in the U.S. and other countries, and may not be used without F5’s

express written consent.

All other product and company names herein may be trademarks of their respective owners.

Confidential and Proprietary

The information contained in this document is confidential and proprietary to F5 Networks. The

information in this document may be changed at any time without notice.

Page 4: F5 Signaling Delivery Controller Transaction Data Records · F5 Signaling Delivery Controller Transaction Data ... F5 Signaling Delivery Controller Transaction Data Records ... Origin_Host_Answer

F5 Signaling Delivery Controller

Transaction Data Records

Proprietary and Confidential Information of F5 Networks

4

1 About this Document

Document Objectives

This document provides an overview of the Transaction Data Records produced by the F5

Signaling Deliver Controller (SDC).

Conventions

The style conventions used in this document are detailed in Table 1.

Table 1: Conventions

Convention Use

Times New Roman Regular text

Times New Roman

Bold

Names of menus, commands, buttons, and other elements of the

user interface

Times New Roman

Italic

Links to figures, tables, and sections in the document, as well as

references to other documents

Courier New Language scripts

Calibri File names

Note: Notes which offer an additional explanation or a hint on how to

overcome a common problem

Warnings which indicate potentially damaging user operations and

explain how to avoid them

An example

For simplicity, throughout this document, the Signaling Delivery Controller will be referred to

as the SDC.

Page 5: F5 Signaling Delivery Controller Transaction Data Records · F5 Signaling Delivery Controller Transaction Data ... F5 Signaling Delivery Controller Transaction Data Records ... Origin_Host_Answer

F5 Signaling Delivery Controller

Transaction Data Records

Proprietary and Confidential Information of F5 Networks

5

1.1 Glossary of Terms and Abbreviations

Table 2: Glossary of Terms and Abbreviations

Term Definition

EMS Element Management System

SDC Signaling Delivery Controller

TDR Transaction Data Record

Document Version History

Date – Version Change Reference

April 2014 – 2 _time data field was

changed to htime

See Transaction Data Reports

August 2014 – 3 TDR field descriptions

updated.

See Table 3: Collected TDR fields

Page 6: F5 Signaling Delivery Controller Transaction Data Records · F5 Signaling Delivery Controller Transaction Data ... F5 Signaling Delivery Controller Transaction Data Records ... Origin_Host_Answer

F5 Signaling Delivery Controller

Transaction Data Records

Proprietary and Confidential Information of F5 Networks

6

2 About Transaction Data Records

Introduction

The SDC collects the accounting data and stores it in a specific Transaction Data Record

(TDR) format. The TDR can then be used for reporting and billing purposes. A TDR is created

for each Origin-Destination Relation (between transaction originator and destination) that the

message travels through. Each TDR represents four messages: the SDC incoming request, the

SDC outgoing request, the SDC incoming answer, and the SDC outbound answer. Using the

TDR, you can uncover the source and the destination of the transaction, the subscriber

identifier, and additional predefined and custom data.

The generation of TDRs– and the custom fields– is configured and enabled per routing rule.

The generated TDRs can then be viewed in the Reports tab of the EMS WebUI. In addition,

the EMS creates a periodic TDR report every 30 minutes.

For more information about configuring the TDRs, see Enabling and Configuring TDRs.

For more information about viewing the generated TDRs, see Working with TDRs using the

EMS WEB UI.

For more information about periodically generated TDRs, see Periodic TDR Report Export.

Working with TDRs using the EMS WEB UI

The generated TDRs can be viewed in two different screens in the Reports tab.

TDR Dashboards – this screen displays dashboards of the Top 10 Origin-

Destination channels for different categories in the selected time frame.

Transaction Data Record– this screen displays all the TDRs in the selected time

frame.

Page 7: F5 Signaling Delivery Controller Transaction Data Records · F5 Signaling Delivery Controller Transaction Data ... F5 Signaling Delivery Controller Transaction Data Records ... Origin_Host_Answer

F5 Signaling Delivery Controller

Transaction Data Records

Proprietary and Confidential Information of F5 Networks

7

2.2.1 TDR Dashboard

The TDR Dashboard displays a graph of the Top 10 Origin-Destination channels per category

in the selected time frame. The information displayed in the TDR Dashboard can reflect one of

the following five categories:

Number of Messages

Round Trip Time

OK Responses

Timeouts

Other Errors

Once a category is selected, the TDR Dashboard will display the Top 10 Origin-Destination

channels for the selected category in the selected time frame. Figure 1 is an example of the

TDR Dashboard that displays the top Origin-Destination channels generating the highest

number of transactions.

Figure 1: Reports>TDR Dashboard – Number of Messages view

Page 8: F5 Signaling Delivery Controller Transaction Data Records · F5 Signaling Delivery Controller Transaction Data ... F5 Signaling Delivery Controller Transaction Data Records ... Origin_Host_Answer

F5 Signaling Delivery Controller

Transaction Data Records

Proprietary and Confidential Information of F5 Networks

8

2.2.2 Transaction Data Reports

The Transaction Data Reports screen displays all the system TDRs. TDRs can be filtered by

one or more of four predefined common TDR fields (Origin Realm; Origin Host; Destination

Realm; and Destination Host.), or by a user-defined filter. Figure 2 is an example of the

Transaction Data Reports screen with no filters applied to the displayed data.

Figure 2: Reports>Transaction Data Records

Table 3 details the collected data in each generated TDR.

Data Field Data Type Description

htime Timestamp The timestamp of the transaction.

Origin_Realm String Realm from where the transaction

originated.

Origin_Host String The peer name from which the transaction

was received.

Destination_Realm

String

Destination realm of the transaction, taken

from the incoming request.

Destination_Host String The peer name the transaction is sent to.

CMD_Code String Command code of every interface. For

example ULR, CCR…

Result_Code String The result code of the transaction.

For more information about the returned

result_code, see Returned Result_Code

field values.

Origin_Host_Request String The Origin Host extracted from the

incoming request’s AVP.

Page 9: F5 Signaling Delivery Controller Transaction Data Records · F5 Signaling Delivery Controller Transaction Data ... F5 Signaling Delivery Controller Transaction Data Records ... Origin_Host_Answer

F5 Signaling Delivery Controller

Transaction Data Records

Proprietary and Confidential Information of F5 Networks

9

Origin_Host_Answer String The Origin Host extracted from the

incoming answer’s AVP.

Diameter_Result_Code String The result code that is sent to the

transaction originator.

IMSI String The subscriber identifier.

Roundtrip_Time Milliseconds The time in milliseconds from when the

request was sent to the transaction

destination peer until a response was

received.

Source_Application_Id String Application ID from the original incoming

request.

Destination_Application_Id String Application ID from the outgoing request.

Destination_Command_Code String Command code of the transaction, taken

from the outgoing request.

Flow_Total_Time Milliseconds The milliseconds that passed once the

request was received by the SDC and a

response was sent back to the originator.

Original_Request_Length String The length of the original request message.

Sending_Request_Length String The length of the outgoing request

message.

Original_Response_Length String The length of the original response

message.

Answer_To_Client_Length String The length of the outgoing response

message.

Original_Result_Code Numeric String The result code from the incoming

response.

AVP_1 User-defined An additional AVP to be defined by the

user.

AVP_2 User-defined An additional AVP to be defined by the

user.

AVP_3 User-defined An additional AVP to be defined by the

user.

AVP_4 User-defined An additional AVP to be defined by the

user.

AVP_5 User-defined An additional AVP to be defined by the

user. Table 3: Collected TDR fields

Periodic TDR Report Export

Every 30 minutes an offline TDR report is generated by the EMS. This report contains TDRs

generated by all managed SDC sites. Each TDR report contains the TDRs collected during the

Page 10: F5 Signaling Delivery Controller Transaction Data Records · F5 Signaling Delivery Controller Transaction Data ... F5 Signaling Delivery Controller Transaction Data Records ... Origin_Host_Answer

F5 Signaling Delivery Controller

Transaction Data Records

Proprietary and Confidential Information of F5 Networks

10

previous 30 minute period. The amount of the exported TDR reports kept by the system is

configurable and depends on the available disk space. The naming of the exported TDR reports

is in the following format: tdr_export_06_27_2013:14:00:06.csv.gz. The TDRs are stored in

compressed files, to save disk space. Figure 3 shows an example of the automatically

generated TDR report (in CSV format). The offline reports can be pulled by northbound

system using secured SCP. The TDR history is also kept by the internal DB for a configurable

number of days.

Figure 3: Example of an exported TDR report

2.3.1 Returned Result_Code field values

The TDR Result_Code field can include one of the following values:

Returned Value Description

OK The answer is sent to the client.

CANNOT_ROUTE SDC is unable to handle the request. The Handle Server Error script is

invoked.

REDIRECT A new pool must be set. The request will be resent to the new pool according

to its policy.

REQUEST_REJECTED The request is rejected by the server. The request will NOT be resent

according to the routing resend parameter. The Handle Server Error script is

invoked.

TOO_BUSY A server error. The request will be resent according to the routing resend

parameters.

Page 11: F5 Signaling Delivery Controller Transaction Data Records · F5 Signaling Delivery Controller Transaction Data ... F5 Signaling Delivery Controller Transaction Data Records ... Origin_Host_Answer

F5 Signaling Delivery Controller

Transaction Data Records

Proprietary and Confidential Information of F5 Networks

11

Returned Value Description

TIMEOUT Indicated that no answer was received from the server in the specified time

frame. The request will be resent according to the routing resend parameters.

CHANNEL_DISCONNECTED Indicates that the server did not respond.

DNS_PREPARING_POOL Indicates a DNS preparing failure

APPLICATION_ERROR Indicates an application error.

Enabling and Configuring TDRs

Each TDR is generated with the predefined fields (as described in Table 3). In addition to this

predefined set, the user can add up to five fields. The additional 5 fields will appear at the end

of the TDR report with predefined names (AVP_1 to AVP_5). The additional custom fields are

defined per routing rule.

Note: Any of the optional user-defined fields that the user has not used will appear as

separated empty fields in the TDR report.

Figure 4: Routing > TDR Configuration

Page 12: F5 Signaling Delivery Controller Transaction Data Records · F5 Signaling Delivery Controller Transaction Data ... F5 Signaling Delivery Controller Transaction Data Records ... Origin_Host_Answer

F5 Signaling Delivery Controller

Transaction Data Records

Proprietary and Confidential Information of F5 Networks

12

About F5 Networks F5 Networks (NASDAQ: FFIV) makes the connected world run better. F5 helps organizations

meet the demands and embrace the opportunities that come with the relentless growth of voice,

data, and video traffic, mobile workers, and applications—in the data center, the network, and

the cloud. The world’s largest businesses, service providers, government entities, and

consumer brands rely on F5’s intelligent services framework to deliver and protect their

applications and services while ensuring people stay connected. For more information, visit

www.F5.com, or contact us at [email protected].