UM Routing Guide=en
UM_Routing_Guide%3Den
User Manual:
Open the PDF directly: View PDF 
.
Page Count: 144
| Download | |
| Open PDF In Browser | View PDF |
Ultra Messaging (Version 6.11.1) Dynamic Routing Guide Copyright (C) 2004-2018, Informatica Corporation. All Rights Reserved. Contents 1 1.1 2 Introduction 5 DRO Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DRO Architecture 5 7 2.1 UM Router Portals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 2.2 Topic Resolution Domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 2.3 Proxy Sources and Proxy Receivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 2.4 Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 3 3.1 UM Router Concepts 11 Basic UM Router Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 3.1.1 Interest and Use Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 3.1.2 UM Router Keepalive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 3.1.3 Final Advertisements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 3.1.4 More About Proxy Sources and Receivers . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 3.2 Multi-Hop Forwarding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 3.3 Routing Wildcard Receivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 3.4 Forwarding Costs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 3.5 UM Router Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 3.6 Routing Topologies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 3.6.1 Direct Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 3.6.2 Single Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 3.6.3 Parallel Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 3.6.4 Loops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 3.6.5 Loop and Spur . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 3.6.6 Loop with Centralized TRD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 3.6.7 with centralized TRD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 3.6.8 Star with Centralized UM Router . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 3.6.9 Mesh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 3.6.10 Palm Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 3.6.11 Dumbbell . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Unsupported Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 3.7 4 3.8 4 CONTENTS UM Feature Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UM Router Implementation 23 25 4.1 UM Router Configuration Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 4.2 Creating Applications for UM Router Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 4.2.1 Naming and Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 4.2.2 Portal Costs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 4.2.3 Access Control Lists (ACL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 4.2.4 Timers and Intervals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 4.2.5 Multicast Immediate Messaging Considerations . . . . . . . . . . . . . . . . . . . . . . . . 29 4.2.6 Persistence Over the UM Router . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 4.2.7 Late Join and Off-Transport Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 4.2.8 Topic Resolution Reliability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 4.2.9 BOS and EOS Behavior Over the UM Router . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Topology Configuration Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 4.3.1 Direct Link Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 4.3.2 Peer Link Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 4.3.3 Transit TRD Link Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 4.3.4 Parallel Links Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 4.3.5 Loop and Spur Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 4.3.6 Star Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 4.3.7 Mesh Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 4.3 4.4 4.5 5 Using UM Configuration Files with the UM Router . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 4.4.1 Setting Individual Endpoint Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 4.4.2 UM Router and UM XML Configuration Use Cases . . . . . . . . . . . . . . . . . . . . . . . 49 4.4.3 Sample Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 4.4.4 XML UM Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 4.4.5 XML UM Router Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Running the UM Router Daemon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 4.5.1 52 tnwgd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . XML Configuration Reference 53 5.1 File Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 5.2 Elements Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 5.2.1. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 5.2.2 5.2.56. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 5.2.3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 5.2.4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 5.2.5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 5.2.6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 5.2.7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 CONTENTS 5 5.2.8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 5.2.9 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 5.2.10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 5.2.11 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 5.2.12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 5.2.13 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 5.2.14 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 5.2.15 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 5.2.16 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 5.2.17 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 5.2.18 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 5.2.19 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 5.2.20 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 5.2.21 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 5.2.22 Then assign configuration templates to those contexts in the UM XML configuration file.. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 5.2.23 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 5.2.24 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 5.2.25 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 5.2.26 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 5.2.27 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 5.2.28 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 5.2.29 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 5.2.30 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 5.2.31 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 5.2.32 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 5.2.33 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 5.2.34 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 5.2.35 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 5.2.36 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 5.2.37 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 5.2.38 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 5.2.39 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 5.2.40 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 5.2.41 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 5.2.42 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 5.2.43 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 5.2.44 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 5.2.45 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 5.2.46 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 5.2.47 82 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 CONTENTS 5.2.48 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 5.2.49 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 5.2.50 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 5.2.51 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 5.2.52 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 5.2.53 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 5.2.54 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 5.2.55 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 5.2.56 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 5.2.57 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 5.2.58 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 5.2.59 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 5.2.60 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 5.2.61 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 5.2.62 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 5.2.63 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 5.2.64 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 5.2.65 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 5.2.66 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 5.2.67 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 5.2.68 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 5.2.69 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 5.2.70 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 5.2.71 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 5.2.73 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 5.2.74 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 5.2.75 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 5.2.76 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 5.2.72 5.2.77 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 5.2.78 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 5.2.79 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 5.2.80 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 5.2.81 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 5.2.82 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 5.2.83 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 5.2.84 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 5.2.85 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 5.3 Deprecated Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 5.3.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 CONTENTS 7 5.3.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 5.3.3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 5.3.4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 5.3.5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 5.3.6 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 5.3.7 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 5.3.8 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 5.3.9 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 5.3.10 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 5.3.11 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 5.3.12 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 5.4 6 6.1 UM Router Configuration DTD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 UM Router Daemon Statistics 119 UM Router Daemon Statistics Structures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 6.1.1 UM Router Daemon Statistics Byte Swapping . . . . . . . . . . . . . . . . . . . . . . . . . 119 6.1.2 UM Router Daemon Statistics String Buffers . . . . . . . . . . . . . . . . . . . . . . . . . . 120 6.2 UM Router Daemon Statistics Configuration 6.3 UM Router Daemon Statistics Requests 7 7.1 7.2 7.3 UM Router Monitoring . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 123 Router Web Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 7.1.1 Main Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 7.1.2 Endpoint Portal Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 7.1.3 Peer Portal Page 7.1.4 Topology Info Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 7.1.5 Path Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 UM Router Log Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 7.2.1 UM Router Rolling Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 7.2.2 Important UM Router Log Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 UM Router Transport Stats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 8 UM Router Glossary 137 9 Comparison to Pre-6.0 UM Gateway 139 9.1 Added Features and Differences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 Chapter 1 Introduction This document explains design concepts and product implementation for the Ultra Messaging Dynamic Routing Option (DRO). Attention See the Documentation Introduction for important information on copyright, patents, information resources (including Knowledge Base, and How To articles), Marketplace, Support, and other information about Informatica and its products. The Ultra Messaging Dynamic Routing Option (DRO) consists of a daemon called the "UM Router" (or just the DRO) that bridges disjoint Topic Resolution Domains (TRDs) by effectively forwarding control and user traffic between them. Thus, the UM Router facilitates WAN routing where multicast routing capability is absent, possibly due to technical obstacles or enterprise policies. The UM Router transfers multicast and/or unicast topic resolution information, thus ensuring that receivers in disjoint topic resolution domains from the source can receive the topic messages to which they subscribe. 1.1 DRO Features The UM Router includes the following features: • Full bidirectional forwarding • Multi-hop forwarding • Mesh, loop, or alternate path UM Router configurations • Automatic rerouting around faults • Support for wildcard receivers • Support of Request/Response messages • Traffic filtering on multiple criteria • UM Router resilience • UMP persistence support • UM transport monitoring statistics • Web Monitoring 10 Introduction • MIM and UIM forwarding The following features are not fully supported in this release of the UM Router: • Queuing, both ULB and Brokered (including brokered JMS) • Multitransport Threads (MTT) If you desire any of these features or any configuration or topology not presented in this document, please contact Informatica Ultra Messaging Support for possible alternatives. Note The UM Router is not directly supported on the OpenVMS® platform. UM applications running on the Open←VMS® platform, however, can use a UM Router running on a different platform, such as Microsoft Windows or Linux. Chapter 2 DRO Architecture 2.1 UM Router Portals The UM Router uses interfaces, called portals, through which to pass data. A UM Router consists of two or more bidirectional portals that may be one of two types: • An endpoint portal, which communicates directly to a UM topic resolution domain (TRD; see Topic Resolution Domains). • A peer portal, which communicates via TCP with another peer portal (of another UM Router), allowing tunneling between UM Routers. Two peer portals connected to each other are referred to as companion peers, and utilize TCP connections for all data and control traffic (UDP is not supported for this). Compression and encryption can be applied to peer links. The figure below shows a simple UM Router use case, where two UM Routers bridge an ISP to connect two TRDs. You configure portals in the UM Router's XML configuration file, specifying the portal's name, cost, UM Configuration, Access Control Lists and other attributes. See XML Configuration Reference. 12 DRO Architecture 2.2 Topic Resolution Domains Since topic resolution uses UDP, sources and receivers must have UDP connectivity to each other. When they do, we consider them to be in the same topic resolution domain (TRD). More specifically, UM contexts must satisfy the following two requirements to belong to the same topic resolution domain. • The contexts must use the same topic resolution UM configuration (i.e., resolver_∗ options are the same). • Contexts can communicate using the protocols required for both message transport and topic resolution traffic. For example, two contexts on separate machines in the same LAN are not in the same topic resolution domain if they use different resolver addresses. See Multicast Resolver Network Options. A topic resolution domain can span a WAN if the UM contexts on each side of a firewall use the same UM configuration and the firewall allows UDP traffic (multicast or unicast) to pass. Each endpoint portal must identify its associated topic resolution domain with a domain-id the UM Router's XML configuration file, as in the example below. All portals in the same TRD must have the same domain-id, and different TRDs networked together via UM Routers must have domain-ids unique to each other. 2.3 Proxy Sources and Proxy Receivers To resolve a topic across a UM Router (described in Basic UM Router Operation), the UM Router creates, within portals, proxy sources and proxy receivers (shown in the figure below by their dashed lines). These proxies behave like their UM counterparts; they resolve topics on the TRDs like normal sources and receivers, and the UM Router internally passes data from one portal to the other. However unlike regular sources, proxy sources do not have retransmission retention buffers normally used for Late Join or OTR. 2.4 Routing 13 Portals exist while the UM Router is running, however, the UM Router creates proxy sources and receivers during topic resolution and deletes them when the topic is retired. Note The proxy sources created by the UM Router are unrelated to proxy sources created by the UMP persistent store. 2.4 Routing In multiple-UM Router environments where more than one UM Router can provide possible messaging pathways, the UM Routers are able to cooperatively determine and establish optimal routes. Also, the UM Router network is able to detect link or other UM Router outages and automatically reroute traffic as needed. See Routing Topologies for more information. 14 DRO Architecture Chapter 3 UM Router Concepts 3.1 Basic UM Router Operation The diagram below shows a UM Router bridging topic resolution domains TRD1 and TRD2, for topic AAA, in a direct link configuration. Endpoint E1 contains a proxy receiver for topic AAA and endpoint E2 has a proxy source for topic AAA. To establish topic resolution in an already-running UM Router, the following sequence typically occurs in an example like the above figure. 1. A receiver in TRD2 issues a TQR (Topic Query Record) for topic AAA. 2. Portal E2 receives the TQR and passes information about topic AAA to all other portals in the UM Router. (In this case, E1 is the only other portal.) 3. E1 immediately responds with three actions: a) create a proxy receiver for topic AAA, b) the new proxy receiver sends a TQR for AAA into TRD1, and c) E1 issues a Topic Interest message into TRD1 for the benefit of any other UM Routers that may be connected to that domain. 4. A source for topic AAA in TRD1 sees the TQR and issues a TIR (Topic Information Record). 16 UM Router Concepts 5. E2 creates proxy source AAA, which then issues a TIR to TRD2. The receiver in TRD2 joins the transport, thus completing topic resolution. 6. E1's AAA proxy receiver sees the TIR and requests that E2 (and any other interested portals in the UM Router, if there were any) create a proxy source for AAA. 3.1.1 Interest and Use Queries When a UM Router starts, its endpoint portals issue a brief series of Topic Resolution Request messages to their respective topic resolution domains. This provokes quiescent receivers (and wildcard receivers) into sending Use Query Responses, indicating interest in various topics. Each portal then records this interest. After a UM Router has been running, endpoint portals issue periodic Topic Use Queries and Pattern Use Queries (collectively referred to as simply Use Queries). Use Query Responses from UM contexts confirm that the receivers for these topics indeed still exist, thus maintaining these topics on the interest list. Autonomous TQRs also refresh interest and have the effect of suppressing the generation of Use Queries. In the case of multi-hop UM Router configurations, UM Routers cannot detect interest for remote contexts via Use Queries or TQRs. They do this instead via Interest Messages. An endpoint portal generates periodic interest messages, which are picked up by adjacent UM Routers (i.e., the next hop over), at which time interest is refreshed. 3.1 Basic UM Router Operation 17 You can adjust intervals, limits, and durations for these topic resolution and interest mechanisms via UM Router configuration options (see XML Configuration Reference). 3.1.2 UM Router Keepalive To maintain a reliable connection, peer portals exchange UM Router Keepalive signals. Keepalive intervals and connection timeouts are configurable on a per-portal basis. You can also set the UM Router to send keepalives only when traffic is idle, which is the default condition. When both traffic and keepalives go silent at a portal ingress, the portal considers the connection lost and disconnects the TCP link. After the disconnect, the portal tries to reconnect. See refeatewaykeepalive. 3.1.3 Final Advertisements UM Router proxy sources on endpoint portals, when deleted, send out a series of final advertisements. A final advertisement tells any receivers, including proxy receivers on other UM Routers, that the particular source has gone away. This triggers EOS and clean-up activities on the receiver relative to that specific source, which causes the receiver to begin querying according to its topic resolution configuration for the sustaining phase of querying. In short, final advertisements announce earlier detection of a source that has gone away, instead of transport timeout. This causes a faster transition to an alternative proxy source on a different UM Router if there is a change in the routing path. 3.1.4 More About Proxy Sources and Receivers The domain-id is used by Interest Messages and other internal and UM Router-to-UM Router traffic to ensure forwarding of all messages (payload and topic resolution) to the correct recipients. This also has the effect of not creating proxy sources/receivers where they are not needed. Thus, UM Routers create proxy sources and receivers based solely on receiver interest. 18 UM Router Concepts If more than one source sends on a given topic, the receiving portal's single proxy receiver for that topic receives all messages sent on that topic. The sending portal, however creates a proxy source for every source sending on the topic. The UM Router maintains a table of proxy sources, each keyed by an Originating Transport ID (OTID), enabling the proxy receiver to forward each message to the correct proxy source. An OTID uniquely identifies a source's transport session, and is included in topic advertisements. Note It is important to keep maximum datagram sizes exactly the same across all TRDs and transports. For example, if the TRD on one side of a UM Router uses LBT-RM message transport and the TRD on the other side uses LBT-RDMA with a larger maximum datagram size configured, fragments from domain 1 will be too large for domain 2. See configuration options: resolver_datagram_max_size (context), transport_←tcp_datagram_max_size (context), transport_lbtrm_datagram_max_size (context), transport_lbtru_←datagram_max_size (context), transport_lbtipc_datagram_max_size (context), and transport_lbtsmx←_datagram_max_size (source). 3.2 Multi-Hop Forwarding UM can resolve topics across a span of multiple UM Routers. Consider a simple example UM Router deployment, as shown in the following figure. In this diagram, UM Router A has two endpoint portals connected to topic resolution domains TRD1 and TRD2. UM Router B also has two endpoint portals, which bridge TRD2 and TRD3. Endpoint portal names reflect the topic resolution domain to which they connect. For example, UM Router A endpoint E2 interfaces TRD2. TRD1 has a source for topic AAA, and TRD3, an AAA receiver. The following sequence of events enables the forwarding of topic messages from source AAA to receiver AAA. 1. Receiver AAA queries (issues a TQR). 2. UM Router B, endpoint E3 (B-E3) receives the TQR and passes information about topic AAA to all other portals in the UM Router. In this case, B-E2 is the only other portal. 3. In response, B-E2 creates a proxy receiver for AAA and sends a Topic Interest message for AAA into TRD2. The proxy receiver also issues a TQR, which in this case is ignored. 3.3 Routing Wildcard Receivers 19 4. UM Router A, endpoint E2 (A-E2) receives this Topic Interest message and passes information about topic AAA to all other portals in the UM Router. In this case, A-E1 is the only other portal. 5. In response, A-E1 creates a proxy receiver for AAA and sends a Topic Interest message and TQR for AAA into TRD1. 6. Source AAA responds to the TQR by sending a TIR for topic AAA. In this case, the Topic Interest message is ignored. 7. The AAA proxy receiver created by A-E1 receives this TIR and requests that all UM Router A portals with an interest in topic AAA create a proxy source for AAA. 8. In response, A-E2 creates a proxy source, which sends a TIR for topic AAA via TRD2. 9. The AAA proxy receiver at B-E2 receives this TIR and requests that all UM Router B portals with an interest in topic AAA create a proxy source for AAA. 10. In response, B-E3 creates a proxy source, which sends a TIR for topic AAA via TRD3. The receiver in TRD3 joins the transport. 11. Topic AAA has now been resolved across both UM Routers, which forward all topic messages sent by source AAA to receiver AAA. 3.3 Routing Wildcard Receivers The UM Router supports topic resolution for wildcard receivers in a manner very similar to non-wildcard receivers. Wildcard receivers in a TRD issuing a WC-TQR cause corresponding proxy wildcard receivers to be created in portals, as shown in the following figure. The UM Router creates a single proxy source for pattern match. 20 3.4 UM Router Concepts Forwarding Costs Forwarding a message through a UM Router incurs a cost in terms of latency, network bandwidth, and CPU utilization on the UM Router machine (which may in turn affect the latency of other forwarded messages). Transiting multiple UM Routers adds even more cumulative latency to a message. Other UM Router-related factors such as portal buffering, network bandwidth, switches, etc., can also add latency. Factors other than latency contribute to the cost of forwarding a message. Consider a message that can be sent from one domain to its destination domain over one of two paths. A three-hop path over 1Gbps links may be faster than a single-hop path over a 100Mbps link. Further, it may be the case that the 100Mbps link is more expensive or less reliable. You assign forwarding cost values on a per-portal basis. When summed over a path, these values determine the cost of that entire path. A network of UM Routers uses forwarding cost as the criterion for determining the best path over which to resolve a topic. 3.5 UM Router Routing UM Routers have an awareness of other UM Routers in their network and how they are linked. Thus, they each maintain a topology map, which is periodically confirmed and updated. This map also includes forwarding cost information. Using this information, the UM Routers can cooperate during topic resolution to determine the best (lowest cost) path over which to resolve a topic or to route control information. They do this by totaling the costs of all portals along each candidate route, then comparing the totals. For example, the following figure shows two possible paths from TRD1 to TRD2: A-C (total route cost of 11) and B-D (total route cost of 7). In this case, the UM Routers select path B-D. If a UM Router or link along path B-D should fail, the UM Routers detect this and reroute over path A-C. Similarly, if an administrator revises cost values along path B-D to exceed a total of 12, the UM Routers reroute to A-C. If the UM Routers find more than one path with the same lowest total cost value, i.e., a "tie", they select the path based on a node-ID selection algorithm. Since administrators do not have access to node IDs, this will appear to be a pseudo-random selection. Note You cannot configure parallel paths (such as for load balancing or Hot failover), as the UM Routers always select the lowest-cost path and only the lowest-cost path for all data between two points. However, you can devise an exception to this rule by configuring the destinations to be in different TRDs. For example, you can create an HFX Receiver bridging two receivers in different TRD contexts. The UM Routers route to both TRDs, and the HFX Receiver merges to a single stream for the application. 3.6 Routing Topologies 3.6 21 Routing Topologies You can configure multiple UM Routers in a variety of topologies. Following are several examples. 3.6.1 Direct Link The Direct Link configuration uses a single UM Router to directly connect two TRDs. For a configuration example, see Direct Link Configuration. 3.6.2 Single Link A Single Link configuration connects two TRDs using a UM Router on each end of an intermediate link. The intermediate link can be a "peer" link, or a transit TRD. For configuration examples, see Peer Link Configuration and Transit TRD Link Configuration. 22 3.6.3 UM Router Concepts Parallel Links Parallel Links offer multiple complete paths between two TRDs. However, UM will not load-balance messages across both links. Rather, parallel links are used for failover purposes. You can set preference between the links by setting the primary path for the lowest cost and standby paths at higher costs. For a configuration example, see Parallel Links Configuration. 3.6.4 Loops Loops let you route packets back to the originating UM Router without reusing any paths. Also, if any peer-peer links are interrupted, the looped UM Routers are able to find an alternate route between any two TRDs. 3.6 Routing Topologies 3.6.5 23 Loop and Spur The Loop and Spur has a one or more UM Routers tangential to the loop and accessible only through a single UM Router participating in the loop. For a configuration example, see Loop and Spur Configuration. 3.6.6 Loop with Centralized TRD Adding a TRD to the center of a loop enhances its rerouting capabilities. 24 3.6.7 UM Router Concepts with centralized TRD A Star with a centralized TRD does not offer rerouting capabilities but does provide an economical way to join multiple disparate TRDs. 3.6.8 Star with Centralized UM Router The Star with a centralized UM Router is the simplest way to bridge multiple TRDs. For a configuration example, see Star Configuration. 3.6 Routing Topologies 3.6.9 25 Mesh The Mesh topology provides peer portal interconnects between many UM Routers, approaching an all-connectedto-all configuration. This provides multiple possible paths between any two TRDs in the mesh. Note that this diagram is illustrative of the ways the UM Routers may be interconnected, and not necessarily a practical or recommended application. For a configuration example, see Mesh Configuration. 3.6.10 Palm Tree The Palm Tree has a set of series-connected TRDs fanning out to a more richly meshed set of TRDs. This topology tends to pass more concentrated traffic over common links for part of its transit while supporting a loop, star, or mesh near its terminus. 26 3.6.11 UM Router Concepts Dumbbell Similar to the Palm Tree, the Dumbbell has a funneled route with a loop, star, or mesh topology on each end. 3.7 Unsupported Configurations When designing UM Router networks, do not use any of the following topology constructs. Two peer-to-peer connections between the same two UM Routers: 3.8 UM Feature Compatibility 27 Two endpoint connections from the same UM Router to the same TRD: Assigning two different Domain ID values (from different UM Routers) to the same TRD: 3.8 UM Feature Compatibility You must install the UM Dynamic Routing Option with its companion Ultra Messaging UMS, UMP, or UMQ product, and versions must match. While most UM features are compatible with the UM Router, some are not. Following is a table of features and their compatibilities with the UM Router. UM Feature UM Router Compatible? Transport Acceleration Yes Hot Failover (HF) Yes Hot Failover across contexts (HFX) Yes Late Join Message Batching Yes Yes Monitoring/Statistics Multicast (MIM) Immediate Yes Messaging Yes Multi-Transport Threads No Off-Transport Recovery (OTR) Yes Ordered Delivery Yes Pre-Defined Messaging (PDM) Yes Request/Response Yes Notes The UM Router can pass messages sent by HF publishers to HF receivers, however the UM Router itself cannot be configured to originate or terminate HF data streams. 28 UM Router Concepts UM Feature UM Router Compatible? Self-Describing Messaging (SDM) Yes Source Side Filtering Yes Transport LBT-IPC Yes Transport LBT-RDMA Yes Transport LBT-RM Yes Transport LBT-RU Yes Transport LBT-SMX Partial Transport TCP Yes Transport TCP-LB Yes JMS, via UMQ broker No UM Spectrum Yes UMP Implicit/Explicit Acknowledgements UMP Persistent Store UMP Proxy Sources Yes UMP Quorum Consensus UMP Registration ID/Session Management Yes Yes UMP Receiver-Paced Persistence (RPP) Yes UMP Store Failover UMQ Brokered Queuing Yes No UMQ Ultra Load Balancing (ULB) No Ultra Messaging Desktop Services (UMDS) Not for client connectivity to the U←MDS server Ultra Messaging Manager (UMM) Yes UM SNMP Agent No UMCache Wildcard Receivers Zero Object Delivery (ZOD) No Yes Yes Notes The UM Router supports transport source side filtering. You can activate this either at the originating TRD source, or at a downstream proxy source. The UM router does not support proxy sources sending data via L←BT-SMX. Any proxy sources configured for LBT-SMX will be converted to TCP, with a log message warning of the transport change. The UM Router does accept LBT-SMX ingress traffic to proxy receivers. The UM Router supports UM Spectrum traffic, but you cannot implement Spectrum channels in UM Router proxy sources or receivers. Yes Yes Not for UM Router management Chapter 4 UM Router Implementation 4.1 UM Router Configuration Overview When the UM Router daemon launches, it uses configuration option settings to determine its behavior and expectations. You specify option values in an XML configuration file, and reference the file from a command line argument. Typically, you have a separate XML configuration file for each UM Router, which contains structured configuration elements that describe aspects of the UM Router. Within this XML configuration file, each endpoint portal definition points to a UM configuration file, which allow the portal to properly connect to its TRD. 4.2 Creating Applications for UM Router Compatibility When developing messaging applications that use Ultra Messaging and, in particular, the UM Router, please observe the following guidelines. 4.2.1 Naming and Identification An important part to successfully implementing UM Routers is prudent and error-free naming of TRDs, UM Routers, portals, etc., as well as correct identification of IP addresses and ports. It is good practice to first design the UM Router network by defining all connections and uniquely naming all UM Routers, portals, and TRDs. This works well as a diagram similar to some examples presented in this document. Include the following names and parameters in your design diagram: • TRD names and IDs • UM Router names • Portal names • Portal costs For example, a well-prepared UM Router design could look like the following figure. 30 4.2.2 UM Router Implementation Portal Costs A network of UM Routers uses forwarding cost as the criterion for determining the best (lowest cost) path over which to resolve a topic and route data. Forwarding cost is simply the sum of all portal costs along a multi-UM Router path. Thus, total cost for the single path in the above example is 34. (Note that this is a non-real-world example, since costs are pointless without alternate routes to compare to.) You assign portal costs via the LAN100 100 lan100.cfg LAN200 200 lan200.cfg configuration option. After the UM Router network calculates its paths, if a new lower-cost source becomes available, receivers switch to that path. 4.2.3 Access Control Lists (ACL) You can apply Access Control Lists (ACL) to a UM Router's portals to filter traffic by certain topics, transports, topic patterns, multicast groups, etc. You configure ACLs in a UM Router's XML configuration file, as children of an or portal. As traffic arrives at the portal, the portal either forwards it or rejects it per ACL criteria. Inbound ACLs determine what information to forward to other portals in the UM Router, while Outbound ACLs determine (by topic) what information from other portals that this portal can send out the UM Router. Each portal (endpoint or peer) can have up to one inbound ACL and one outbound ACL. 4.2 Creating Applications for UM Router Compatibility 31 An ACL can contain one or more Access Control Entries (ACEs). ACEs are the filters that let you match (and accept or reject based on), criteria elements. For example, to accept only messages for topic ABC: Possible ACE condition elements are: • ABC ∗ • (PCRE wildcard patterns) • (Regex wildcard patterns) • ∗ • ∗ • • ∗ • ∗ • ∗ • ∗ (for LBT-IPC traffic) 32 UM Router Implementation These items apply to only inbound ACLs, and are ignored if used with an outbound ACL. The above elements are all children of the element. When an ACL has multiple ACE entries, the UM Router goes down the list until it finds a match. It then accepts (forwards) or rejects, and is done with that ACL. An implicit "reject all" is at the end of every ACL, so the UM Router rejects any topic not matched. If you place multiple conditions within an ACE, the UM Router performs an "and" operation with them. Note that the portal ignores a condition element if a) it is inbound-only and used in an outbound ACL, or b) it simply does not apply (such as a if the transport is TCP). Also note that ACLs can affect topic resolution traffic as well as user messages. They can, for example, block a topic (which prevents the creation of proxy receivers) and, thus, protect remote TRDs from unwanted queries and advertisements. This effect does not apply to wildcard receivers, however, because ACLs match only on discrete topics. Thus, while ACLs can operate on specific topic traffic derived from wildcard topic resolution, they cannot prevent pattern interest from propagating throughout the network. Consider the following example, where we configure a portal to forward on specific topics. This example also illustrates the parent/child hierarchy for ACLs, ACEs, and ACE conditions. The above example shows each topic match in a separate ACE. When topic "GHI" arrives, the portal finds a match in the third ACE and forwards the topic. (Placing all three LAN1 lan1.cfg 1 ABC DEF GHI s in a single ACE would never match anything.) Also note that "DEF" is forwarded only if it uses an LBT-RM transport. Since the behavior for multiple ACEs is "first match, then done", list ACEs in a specific-to-general order. For the example below, to forward topic "ABC123" but reject similar topics such as "ABCD123" or "ABCE123", list the ACE for "ABC123" first (as done below). If the ACE to reject "ABC.∗123" was listed first, it would also (undesirably) match and reject "ABC123". You can also filter on certain transport types to accept multicast traffic but reject tcp traffic, as shown below. 4.2 Creating Applications for UM Router Compatibility 33 LAN1 lan1.cfg 1 ABC123 ABC.*123 4.2.4 Timers and Intervals The UM Router offers a wide choice of timer and interval options to fine tune its behavior and performance. There are interactions and dependencies between some of these, and if misconfigured, they may cause race or failure conditions. This manual's description of configuration options (see XML Configuration Reference), includes identification of such relationships. Please heed them. 4.2.5 Multicast Immediate Messaging Considerations Multicast Immediate Messages (MIMs) may pass through the UM Router. You cannot filter MIMs with Access Control Lists (ACL)-MIMs are forwarded to all TRDs. Informatica does not recommend using MIM for messaging traffic across the UM Router. MIM is intended for short-lived topics and applications that cannot tolerate a delay between source creation and the sending of the first message. See also Multicast Immediate Messaging. 4.2.6 Persistence Over the UM Router The UM Router supports UMP persistence by routing all necessary control and retransmission channels along with transport and topic resolution traffic. A typical implementation places the UMP persistent store in the same TRD as its registered source, as shown in the following figure. 34 UM Router Implementation The UM Router also supports UMP implementations with the store located in a receiver's TRD, as shown in the following figure. Note: For more reliable operation when using UMP with UM Routers, Informatica recommends enabling OTR. 4.2.7 Late Join and Off-Transport Recovery The UM Router supports sources and receivers configured for Late Join and/or Off-Transport Recovery (OTR). Retransmission requests and subsequent retransmissions are conducted across the entire path through the UM Router network. A UM Router's proxy sources do not have Late-Join/OTR retention buffers and hence, are not able to provide recovered messages. 4.3 Topology Configuration Examples 4.2.8 35 Topic Resolution Reliability Topic resolution can sometimes remain in a quiescent phase due to link interruption, preventing needed resubscription topic resolution activity. Two ways you can address this are: • For isolated incidents, call lbm_context_topic_resolution_request() (see example lbmtrreq.c). This restarts the sustaining phase. • For more chronic problems, such as a UM Router link (especially an endpoint link) over a WAN of questionable reliability, consider configuring Topic resolution to stay in the sustaining phase (options resolver_←advertisement_minimum_sustain_duration (source) and resolver_query_minimum_sustain_duration (receiver)). 4.2.9 BOS and EOS Behavior Over the UM Router Through a network of UM Routers, a topic traverses a separate session for each link along its path. Thus, the UM Router reports BOS/EOSs based on the activity between the proxy source transport and its associated receiver. There is no end-to-end, application-to-application reporting of the data path state. Also, in the case of multiple topics being assigned to multiple sessions, topics may find themselves with different session mates from hop to hop. Of course, this all influences when, and for which transport session, a topic's BOSs and EOSs are issued. 4.3 Topology Configuration Examples Following are example configurations for a variety of UM Router topologies. These are the topology examples presented Routing Topologies. In a real-world situation, you would have UM Router XML configuration files with their portal interfaces referencing complete UM configuration files. However, for these examples, the referred domain configuration files are simplified to contain only information relevant to the applicable UM Router. As part of this simplification, domain configuration files show interfaces for only one or two transport types. Also, IP addresses are provided in some cases and omitted in other cases. This is because initiator peer portals need to know the IP addresses (and port numbers) of their corresponding acceptor portals to establish connections, whereas endpoint portals communicate via topic resolution and thus, do not need to know IP addresses. Note Before designing any UM Router implementations based on configurations or examples other than the types presented in this document, please contact your technical support representative. 4.3.1 Direct Link Configuration This example uses a UM Router to connect two topic resolution domain LANs. 36 UM Router Implementation TRD1 Configuration This UM configuration file, trd1.cfg, describes TRD1 and is referenced in the UM Router configuration file. ## Global Configuration Options ## context request_tcp_interface 10.29.3.0/24 context resolver_multicast_port 13965 context resolver_multicast_interface 10.29.3.0/24 context resolver_multicast_address 225.1.37.85 G1 Configuration This UM Router configuration file defines two endpoint portals. In the daemon section, we have turned on monitoring for the all endpoint portals in the UM Router. The configuration specifies that all statistics be collected every 5 seconds and uses the lbm transport module to send statistics to your monitoring application, which runs in TRD1. See also UM Concepts, Monitoring UMS. The Web Monitor has also been turned on (port 15304) to monitor the performance of the UM Router. LAN1 lan1.cfg 1 TRD2 Configuration The configuration file trd2.cfg could look something like this. # Global Configuration Options ## 4.3 Topology Configuration Examples context context context context 4.3.2 37 request_tcp_interface 10.29.3.0/24 resolver_multicast_port 13965 resolver_multicast_interface 10.29.3.0/24 resolver_multicast_address 225.2.37.85 Peer Link Configuration In cases where the UM Router connection between two TRDs must tunnel through a WAN or TCP/IP network, you can implement a UM Router at each end, as shown in the example below. TRD1 Configuration ## Global Configuration Options ## context request_tcp_interface 10.29.3.0/24 context resolver_multicast_port 13965 context resolver_multicast_interface 10.29.3.0/24 context resolver_multicast_address 225.1.37.85 G1 Configuration Following is an example of two companion peer portals (on different UM Routers) configured via UM Router XML configuration file for a single TCP setup. Note that one must be an initiator and the other, an acceptor. lic0014.txt *:15304 G1-TRD1 1 trd1.cfg G1-TRD2 2 trd2.cfg G2 Configuration G1-TRD1 1 TRD1.cfg 38 UM Router Implementation G1-G2 10.30.3.100 10.30.3.102 26123 TRD2 Configuration ## LAN2 Configuration Options ## context request_tcp_interface 10.33.3.0/24 context resolver_multicast_port 13965 4.3.3 Transit TRD Link Configuration This example, like the previous one, configures two localized UM Routers tunneling a connection between two TR←Ds, however, the UM Routers in this example are tunneling through an intermediate TRD. This has the added effect of connecting three TRDs. TRD1 Configuration ## TRD1 Configuration Options ## context request_tcp_interface 10.29.3.0/24 context resolver_multicast_port 13965 4.3 Topology Configuration Examples 39 context resolver_multicast_interface 10.29.3.0/24 context resolver_multicast_address 225.2.37.85 G1 Configuration Following is an example of two companion peer portals (on different UM Routers) configured via UM Router XML configuration file for a single TCP setup. Note that one must be an initiator and the other, an acceptor. G2-G1 10.30.3.102 26123 G2-TRD2 2 TRD2.cfg TRD2 Configuration ## TRD2 context context context context Configuration Options ## request_tcp_interface 10.29.3.0/24 resolver_multicast_port 13965 resolver_multicast_interface 10.29.3.0/24 resolver_multicast_address 225.2.37.85 G2 Configuration G1-TRD1 1 TRD1.cfg G1-TRD2 2 TRD2.cfg TRD3 Configuration ## TRD3 context context context context Configuration Options ## request_tcp_interface 10.29.3.0/24 resolver_multicast_port 13965 resolver_multicast_interface 10.29.3.0/24 resolver_multicast_address 225.3.37.85 40 4.3.4 UM Router Implementation Parallel Links Configuration This example is similar in purpose to the single link, peer-to-peer example, except that a second pair of UM Routers is added as a backup route. You can set one of these as a secondary route by assigning a higher cost to portals along the path. In this case we set G3 and G4's portal costs to 5, forcing the lower route to be selected only if the upper (G1, G2) route fails. Also note that we have configured the peer portals for the leftmost or odd-numbered UM Routers as initiators, and the rightmost or even-numbered UM Router peers as acceptors. TRD1 Configuration ## TRD1 context context context context Configuration Options ## request_tcp_interface 10.29.3.0/24 resolver_multicast_port 13965 resolver_multicast_interface 10.29.3.0/24 resolver_multicast_address 225.1.37.85 G1 Configuration G2-TRD2 2 TRD2.cfg G2-TRD3 3 TRD3.cfg 4.3 Topology Configuration Examples G2 Configuration G1-TRD1 1 2 TRD1.cfg G1-G2 2 10.30.3.101 10.30.3.102 23745 G3 Configuration G2-G1 2 10.30.3.102 23745 G2-TRD2 2 2 TRD2.cfg G4 Configuration G3-TRD1 1 5 TRD1.cfg G3-G4 5 10.30.3.103 10.30.3.104 23746 TRD2 Configuration ## TRD2 context context context context 4.3.5 Configuration Options ## request_tcp_interface 10.29.3.0/24 resolver_multicast_port 13965 resolver_multicast_interface 10.29.3.0/24 resolver_multicast_address 225.2.37.85 Loop and Spur Configuration TRD1 Configuration ## Global Configuration Options ## context request_tcp_interface 10.29.3.0/24 context resolver_multicast_port 13965 context resolver_multicast_interface 10.29.3.0/24 context resolver_multicast_address 225.1.37.85 G1 Configuration 4.3 Topology Configuration Examples G4-G3 41 42 UM Router Implementation5 10.30.3.104 23746 G4-TRD2 2 5 TRD2.cfg G2 Configuration G1_to_G3 55.55.10.27 23801 G1_to_G2 55.55.10.26 23745 G1_to_TRD1 1 TRD1.cfg 43 44 TRD2 Configuration ## Global Configuration Options ## context request_tcp_interface 10.29.3.0/24 context resolver_multicast_port 13965 context resolver_multicast_interface 10.29.3.0/24 context resolver_multicast_address 225.2.37.85 TRD3 Configuration ## Global Configuration Options ## context request_tcp_interface 10.29.3.0/24 context resolver_multicast_port 13965 context resolver_multicast_interface 10.29.3.0/24 context resolver_multicast_address 225.3.37.85 G3 Configuration G2_to_G4 55.55.10.28 23632 G2_to_G1 23745 G2_to_TRD2 2 TRD2.cfg G4 Configuration G3_to_G4 55.55.10.28 23754 G3_to_G1 23801 G3_to_TRD3 3 TRD3.cfg TRD4 Configuration ## Global Configuration Options ## context request_tcp_interface 10.29.3.0/24 context resolver_multicast_port 13965 context resolver_multicast_interface 10.29.3.0/24 context resolver_multicast_address 225.4.37.85 G5 Configuration UM Router Implementation 4.3 Topology Configuration Examples G4_to_G3 23754 G4_to_TRD4 4 TRD4.cfg G4_to_G2 23632 G4_to_G5 55.55.10.29 23739 TRD5 Configuration ## Global Configuration Options ## context request_tcp_interface 10.29.3.0/24 context resolver_multicast_port 13965 context resolver_multicast_interface 10.29.3.0/24 context resolver_multicast_address 225.5.37.85 45 46 4.3.6 UM Router Implementation Star Configuration This network consists of four TRDs. Within each TRD, full multicast connectivity exists. However, no multicast connectivity exists between the four TRDs. G1 Configuration The configuration for this UM Router also has transport statistics monitoring and the WebMonitor turned on. G5_to_TRD5 5 TRD5.cfg G5_to_G4 23739 TRD1 Configuration ## Global Configuration Options ## context request_tcp_interface 10.29.3.0/24 context resolver_multicast_port 13965 context resolver_multicast_interface 10.29.3.0/24 context resolver_multicast_address 225.1.37.85 TRD2 Configuration ## Global Configuration Options ## context request_tcp_interface 10.29.3.0/24 context resolver_multicast_port 13965 context resolver_multicast_interface 10.29.3.0/24 context resolver_multicast_address 225.2.37.85 TRD3 Configuration ## Global Configuration Options ## context request_tcp_interface 10.29.3.0/24 context resolver_multicast_port 13965 context resolver_multicast_interface 10.29.3.0/24 context resolver_multicast_address 225.3.37.85 TRD4 Configuration ## Global Configuration Options ## context request_tcp_interface 10.29.3.0/24 context resolver_multicast_port 13965 context resolver_multicast_interface 10.29.3.0/24 context resolver_multicast_address 225.4.37.85 4.3.7 Mesh Configuration The mesh topology utilizes many connections between many nodes, to provide a variety of alternate routes. However, meshes are not the best solution in many cases, as unneeded complexity can increase the chance for configuration errors or make it more difficult to trace problems. 48 TRD1 Configuration ### Global Configuration Options ## context request_tcp_interface 10.29.3.0/24 context resolver_multicast_port 13965 context resolver_multicast_interface 10.29.3.0/24 context resolver_multicast_address 225.1.37.85 G1 Configuration lic0014.txt *:15304 G1_to_TRD1 1 trd1.cfg 4.3 Topology Configuration Examples 47 G1_to_TRD2 2 trd2.cfg G1_to_TRD3 3 trd3.cfg G1_to_TRD4 4 trd4.cfg G2 Configuration G1_to_G5 55.55.10.105 23880 G1_to_G4 55.55.10.104 23801 G1_to_TRD1 1 TRD1.cfg UM Router Implementation 4.3 Topology Configuration Examples G1_to_TRD2 2 TRD2.cfg G1_to_G2 55.55.10.102 23745 G3 Configuration 49 50 G2_to_G5 55.55.10.105 23608 G2_to_G4 23831 G2_to_G1 23745 G2_to_G3 55.55.10.103 23632 G2_to_TRD2 2 TRD2.cfg TRD2 Configuration ## Global Configuration Options ## context request_tcp_interface 10.29.3.0/24 context resolver_multicast_port 13965 context resolver_multicast_interface 10.29.3.0/24 context resolver_multicast_address 225.2.37.85 TRD3 Configuration ## Global Configuration Options ## context request_tcp_interface 10.29.3.0/24 context resolver_multicast_port 13965 context resolver_multicast_interface 10.29.3.0/24 context resolver_multicast_address 225.3.37.85 G4 Configuration G3_to_G5 55.55.10.105 23739 G3_to_G4 23754 G3_to_G2 23632 G5 Configuration G4_to_G5 UM Router Implementation 4.3 Topology Configuration Examples 55.55.10.105 23580 G4_to_TRD1 1 TRD1.cfg G4_to_TRD3 3 TRD3.cfg G4_to_G1 23801 G4_to_G3 55.55.10.103 23754 G4_to_G2 55.55.10.102 23831 4.4 Using UM Configuration Files with the UM Router Within the UM Router configuration file, the endpoint portal's G5_to_G4 23580 G5_to_G1 51 52 UM Router Implementation 23880 G5_to_G3 23739 G5_to_G2 23608 element lets you import configurations from either a plain text or XML UM configuration file. However, using the XML type of UM configuration files provides the following advantages over plain text UM configuration files: • You can apply UM attributes per topic and/or per context. • You can apply attributes to all portals on a particular UM Router using a UM XML template (instead of individual portal settings). • Using UM XML templates to set options for individual portals lets the UM Router process these settings in the element instead of within each portal's configuration. 4.4.1 Setting Individual Endpoint Options When setting endpoint options, first name the context of each endpoint in the UM Router's XML configuration file. Endpoint_1 1 G1_E1 G1-TRD2 4.4 Using UM Configuration Files with the UM Router 532 G1_E2 You specify the unique options for each of this UM Router's two endpoints in the UM XML configuration section used for G1-E1-options and G1-E2-options. 4.4.2 UM Router and UM XML Configuration Use Cases One advantage of using UM XML configuration files with the UM Router is the ability to assign unique UM attributes to the topics and contexts used for the proxy sources and receivers (which plain text UM configuration files cannot do). The following example shows how to assign a different LBTRM multicast address to a source based on its topic. Create a new UM XML configuration template for the desired topic name. Then include this template in the element associated with the UM Router. It is also possible to assign UM attributes directly in the tag. For example, the following specifies that a particular topic should use an LBT-RU transport. 4.4.3 Sample Configuration The following sample configuration incorporates many of the examples mentioned above. The UM Router applies options to all UM objects created. The UM XML configuration file overwrites these options for two specific topics. The first topic, LBTRM_TOPIC, uses a different template to change its transport from TCP to LBTRM, and to set an additional property. The second topic, LBTRU_TOPIC, also changes its transport from TCP to a new value. However, its new attributes are applied directly in its associated topic tag, instead of referencing a template. In addition, this sample configuration assigns the rm-source template to all sources and receivers associated with the context endpt_1. 4.4.4 XML UM Configuration File 54 UM Router Implementation 4.4.5 XML UM Router Configuration File This UM Router uses the above XML UM configuration file, sample-config.xml, to set its UM options. It has three endpoints, one of which has the context endpt_1. 4.5 Running the UM Router Daemon 55 4.5 Running the UM Router Daemon To run the UM Router, ensure the following: • Library environment variable paths are set correctly (LD_LIBRARY_PATH) 56 UM Router Implementation • The license environment variable LBM_LICENSE_FILENAME points to a valid UM Router license file. • The configuration file is error free. Typically, you run the UM Router with one configuration file argument, for example: tnwgd gw1-config.xml The UM Router logs version information on startup. The following is an example of this information: Version 6.0 Build: Sep 26 2012, 00:31:33 (UMS 6.0 [UMP-6.0] [UMQ-6.0] [64-bit] Build: Sep 26 2012, 00:27:17 ( DEBUG license LBT-RM LBT-RU LBT-IPC LBT-RDMA ) WC[PCRE 7.4 2007-09-21, regex, appcb] HRT[gettimeofday()]) 4.5.1 tnwgd Name tnwgd - UM Router Daemon Synopsis tnwgd [-d] [--dump-dtd] [-h] [--help] [-f] [--detach] [-v] [--validate] configfile Description UM Router services are provided by tnwgd. A UM Router configuration file is required. The contents and format of the configuration file are documented separately. The DTD used to validate a configuration file is dumped to standard output with -d or --dump-dtd. After dumping the DTD, tnwgd exits instead of providing UM Router services as usual. See UM Router Configuration DTD for the DTD with comments removed. To validate the configuration file, use either the -v or --validate options. After attempting validation, tnwgd exits instead of providing UM Router services as usual. The exit status will be 0 for a configuration file successfully validated by the DTD, and non-zero otherwise. tnwgd normally remains attached to the controlling terminal and runs until interrupted. If the -f or --detach options are given, tnwgd instead forks, detaches the child from the controlling terminal, and the parent exits immediately. Command line help is available with -h or --help. Exit Status The exit status from tnwgd is 0 for success and some non-zero value for failure. Chapter 5 XML Configuration Reference For controlling/configuring each UM Router, you use a XML UM Router configuration file, which also contains references to UM configuration files to extract needed information about the TRDs interfaced by endpoint portals. This chapter includes a lookup reference for the XML UM Router configuration file's elements and DTD. An XML UM Router configuration file follows standard XML conventions. Element declarations or a pointer to a DTD file are not needed, as these are handled by the UM Router. 5.1 File Structure An XML UM Router configuration file generally comprises two primary elements: sample-config.xml Endpoint_1 1 Endpoint_2 2 Endpoint_3 3 and . Organized and contained within these are option value assignments. sub-containers let you set options global to the UM Router. sub-containers let you configure each portal in the UM Router individually. XML UM Router configuration files use the high-level structure shown in the following example. This example includes only some container elements, and only some options. 5.2 Elements Reference Following are descriptions of the XML UM Router configuration file elements. For the children listings, + designates 1 or more, designates 0 or more, and ? designates 0 or 1. You must insert children in the order presented. 5.2.1 0 0 /path/file.pid /path/file.lic *:21000 sample-config.xml Endpoint_1 1 1 endpoint2.cfg 58 XML Configuration Reference ABC123 pattern pattern ABC123 pattern pattern Peer_1 1 peer1.cfg (see above) 5.2 Elements Reference 59 The element is a required container for all options residing in the XML UM Router configuration file. This is the top-level element. • Cardinality: 1 • Parents: None. • Children: 5.2 Elements Reference 87 5.2.48?, XML Attributes: XML Attribute Description Default Value version The version of the DTD, which is currently 1.0. (This is not the product version.) none Example: 60 XML Configuration Reference 5.2.2 . . . . . . . . . . . . The element is a container for options common to the entire UM Router. • Cardinality: 0 or 1 • Parents: • Children: 5.2.46?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ? ?, ?, ? ? XML Attributes: None. Example: 5.2.3 . . . . . . . . . . . .The element lets you set a name for this UM Router (do not duplicate for any other known UM Routers), or for the name of an endpoint or peer portal. Each portal name must be unique within the UM Router. • Cardinality: 1 • Parents: , , • Children: None. XML Attributes: None. Example: 5.2 Elements Reference 5.2.4 61 UM Router1 . . . endpoint1 . . . . . .The element specifies the destination for UM Router log messages. If you set the type for file, use this element to contain the full pathname/filename. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value type file, syslog, console console size Number of millions of bytes of file size to roll log file. E.g. a value of 1 rolls after 1000000 bytes. Maximum value is 4000. Value of 0 disables rolling by file size. Only applicable for type="file". 0 frequency Frequency by which to roll log file. Choices are daily - Roll log file at midnight. hourly - Roll log file after approximately an hour, but is not exact and can drift significantly over a period of time. test - For internal Informatica testing and should not be used. disable - Do not roll log file by frequency. Only applicable for type="file" disable xml:space How whitespace is handled. default trims leading and trailing whitespace (e.g., tabs, spaces, linefeeds, etc.), and compresses multiple whitespace characters into a single space character. preserve preserves the whitespace exactly as read. default Example: 5.2.5 . . . . . . The element specifies a User ID (UID) for the daemon process (if run as root). • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: None. Example: 62 XML Configuration Reference 5.2.6 . . . . . . 5555 The element specifies a Group ID (GID) for daemon process (if run as root). • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: None. Example: 5.2.7 . . . . . . 1234 The element contains the pathname for daemon process ID (PID) file. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value xml:space How whitespace is handled. default trims leading and trailing whitespace (e.g., tabs, spaces, linefeeds, etc.), and compresses multiple whitespace characters into a single space character. preserve preserves the whitespace exactly as read. default Example: 5.2.8 . . . . . . /configs/stores/umestored1/umestored.pid . . . 5.2 Elements Reference 63The element specifies the UM license file's pathname/filename. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value xml:space How whitespace is handled. default trims leading and trailing whitespace (e.g., tabs, spaces, linefeeds, etc.), and compresses multiple whitespace characters into a single space character. preserve preserves the whitespace exactly as read. default Example: 5.2.9 . . . . . . . . .lic0014.txt . . .The element specifies characteristics of the internal topic maps. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: 64 XML Configuration Reference XML Attribute Description Default Value hash-function Topic map hash function to use. Choices are: classic - A "classic" good string hash function. Works best when topic names have a constant prefix with a changing suffix. djb2 - The Dan Bernstein algorithm from comp.lang.c. Works best when topic names have a changing prefix with a constant suffix. sdbm - sdbm database library (used in Berkeley DB). A useful alternative to djb2. murmur2 - Good all-around hash function by Austin Appleby. Best for medium to long topic strings. murmur2 size Number of entries in the topic map. 131111 Example: 5.2.10 < topicmap hash-function="djb2" size="5000"> . . . . . .The element determines characteristics of the internal pattern maps. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value hash-function Pattern map hash function to use. Choices are classic - A "classic" good string hash function. Works best when topic names have a constant prefix with a changing suffix. djb2 - The Dan Bernstein algorithm from comp.lang.c. Works best when topic names have a changing prefix with a constant suffix. sdbm - sdbm database library (used in Berkeley DB). A useful alternative to djb2. murmur2 - Good all-around hash function by Austin Appleby. Best for medium to long topic strings. murmur2 size Number of entries in the pattern map. 131111 Example: 5.2.11 . . . 5.2 Elements Reference 65 . . . The element is a container for monitoring configuration elements. • Cardinality: 0 or 1 • Parents: • Children: ?, XML Attributes: XML Attribute Description Default Value interval Monitoring interval, in seconds. 0 disables monitoring. 0 Example: 5.2.12 . . . . . . The element specifies characteristics about the monitoring transport module used. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value module Specifies the monitoring transport module to use. Choices are lbm (LBMM←ON UMS), lbmsnmp (LBMMON SNMP), or udp (LBMMON UDP). lbm options Option string to be passed to the transport module. Available options are config (configuration path and filename), topic (the topic name to use for sending and receiving statistics; default /29west/statistics), and wctopic (for monitor receivers only, a wildcard pattern). none 66 XML Configuration Reference Example: 5.2.13 . . . . . . The element provides specifics about the monitoring format module. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value module Currently, the one available choice is csv (comma-separated variables). csv options Option string to be passed to the format module. The one available option is separator (field separator character). none Example: 5.2.14 . . . . . . The element identifies the address for the web monitor, in the form of interface:port. You can use "∗" to specify the local host. • Cardinality: 0 or 1 • Parents: • Children: None. 5.2 Elements Reference 67 XML Attributes: XML Attribute Description Default Value xml:space How whitespace is handled. default trims leading and trailing whitespace (e.g., tabs, spaces, linefeeds, etc.), and compresses multiple whitespace characters into a single space character. preserve preserves the whitespace exactly as read. default Example: 5.2.15 . . . . . . *:21001 The element configures the Daemon Statistics feature. See Daemon Statistics for general information on Daemon Statistics. • Cardinality: 0 or 1 • Parents: • Children: ?, ?, ?, ? XML Attributes: XML Attribute Description Default Value topic Topic name to use for publishing Daemon Statistics. "tnwgd.monitor" Example: 68 XML Configuration Reference 5.2.16 . . . . . . /path/umrouter_monitor.cfg . . . The element configures whether the UM Router will respond to monitoring apps requests to send on-demand snapshots of daemon statistics. See Daemon Statistics for general information on Daemon Statistics. • Cardinality: 0 or 1 • Parents: • Children: none. XML Attributes: XML Attribute Description Default Value allow Enable or disable snapshot requests. 1 means that the UM Router will respond to snapshot requests. 0 means that snapshot requests will be ignored. 0 Example: 5.2.17 . . . . . . /path/umrouter_monitor.cfg . . . The element configures whether the UM Router will respond to monitoring apps requests to change the rate at which Daemon Statistics messages are published. See Daemon Statistics for general information on Daemon Statistics. • Cardinality: 0 or 1 • Parents: • Children: none. XML Attributes: XML Attribute Description Default Value allow Enable or disable change requests. 1 means that the UM Router will respond to change requests. 0 means that change requests will be ignored. 0 Example: 5.2 Elements Reference 69 5.2.18 . . . . . . /path/umrouter_monitor.cfg . . . The element specifies the UM XML configuration file. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value xml:space How whitespace is handled. default trims leading and trailing whitespace (e.g., tabs, spaces, linefeeds, etc.), and compresses multiple whitespace characters into a single space character. preserve preserves the whitespace exactly as read. default Example: . . . . . . configfile.xml 5.2.19 The element lets you set control parameters for UM Router initial route setup (or reroute) behavior. • Cardinality: 0 or 1 70 XML Configuration Reference • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value propagation-interval The time interval between route information messages that the UM Router sends to other UM Routers How often the UM Router checks to see if a route information message needs to be sent, a UM Router has timed out, and/or the routes need to be recalculated. How long a UM Router waits after receiving no route information messages from another UM Router before determining that that UM Router is out of service or unreachable. The maximum number of UM Routers a route information message can traverse before being discarded. 1000 How whitespace is handled. default trims leading and trailing whitespace (e.g., tabs, spaces, linefeeds, etc.), and compresses multiple whitespace characters into a single space character. preserve preserves the whitespace exactly as read. default check-interval timeout max-hop-count xml:space 750 4000 100 Example: 5.2.20 . . . . . . The element lets you set timing parameters for UM Router rerouting route calculation behavior. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value backoff-interval How long, in milliseconds, the UM Router waits after the last detected change in topology before initiating a route recalculation 5000 warning-interval How long, in milliseconds, the UM Router waits before warning that a route recalculation is being held up due to a non-converging topology. 10000 xml:space How whitespace is handled. default trims leading and trailing whitespace (e.g., tabs, spaces, linefeeds, etc.), and compresses multiple whitespace characters into a single space character. preserve preserves the whitespace exactly as read. default 5.2 Elements Reference 71 Example: 5.2.21 . . . . . . The element is a container for all endpoint and peer portal configuration information. • Cardinality: 0 or 1 • Parents: • Children: ( | )+ XML Attributes:None. Example: . . . . . . 5.2.22. . . . . . The element is a container element for all configuration options of a single endpoint portal. • Cardinality:0 or more • Parents: • Children: , , ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ? XML Attributes: None. Example: 72 XML Configuration Reference 5.2.23 . . . . . . E1 1 1 . . . . . .The element identifies the TRD for this endpoint portal. It must be unique within the UM Router (which means that for any TRD, you can assign only one endpoint portal per UM Router). Also, all endpoints interfacing a given TRD must have the same value. • Cardinality:1 • Parents: • Children: None. XML Attributes: None. Example: 5.2.24 . . . . . . E1 1 1 . . . . . .The element assigns a positive non-zero integer cost to the portal. The default value is 1. • Cardinality: 0 or 1 • Parents: 5.2 Elements Reference 73 • Children: None. XML Attributes: None. Example: 5.2.25 . . . . . . E1 1 25 . . . . . .The element sets the time in milliseconds to wait after a route map change occurs before deleting a proxy source. Such a route map change could be due to failure of a UM Router or link within a network. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: None. Example: 74 XML Configuration Reference 5.2.26 . . . . . . E1 1 500 . . . . . .The element sets the maximum buffer size for blocking messages. If not specified, this defaults to 1000000 bytes. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: None. Example: 5.2.27 . . . . . . E1 1 500000 . . . . . .The element specifies the UM configuration file that contains configuration options associated with this portal. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value xml:space How whitespace is handled. default trims leading and trailing whitespace (e.g., tabs, spaces, linefeeds, etc.), and compresses multiple whitespace characters into a single space character. preserve preserves the whitespace exactly as read. default Example: . . . . . . 5.2.285.2 Elements Reference 75 E2 1 /path/endpoint2.cfg . . . . . .The element is a container for individual UM-option-setting elements. It lets you set individual UM attributes without referencing a UM configuration file. These values override any values set via files referenced by . • Cardinality: 0 or 1 • Parents: • Children: The The element sets parameters for when and how often this endpoint portal sends topic use queries. • Cardinality: 0 or 1 • Parents: • Children: XML Attributes: XML Attribute Description Default Value max Maximum number of topic use queries to send for a given topic, each separated by the timeout value before giving up and removing the topic from the topic list. Before changing the value of this option, please contact Informatica Support. 5 periodic-interval The interval, in milliseconds, between periodic topic use queries being sent for each topic the portal has interest in. Before changing the value of this option, please contact Informatica Support. 300000 timeout The maximum time, in milliseconds, to wait for a topic use response. Before changing the value of this option, please contact Informatica Support. 3000 Example: . . . . . . 86 XML Configuration Reference 5.2.47The element sets rate limits for topic resolution data sent over the network. You can set rate limits individually for each of the following topic resolution message types: • topic use query • pattern use query • topic interest • pattern interest • domain route • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: You can set a limit in bps, objects per second, or both. The UM Router begins limiting when the lower of these attributes is reached. XML Attribute Description Default Value bps The limit in Bits per Second that data will be sent on the network. A value of 0 disables limiting by bits per second. Before changing the value of this option, please contact Informatica Support. For use queries and interest messages←: 500000 For domain route messages: 0 objects-per-second The limit in Objects per Second that data will be sent on the network. A value of 0 disables limiting by objects per second. Before changing the value of this option, please contact Informatica Support. For use queries:500 For interest messages: 0 For domain route messages: 50 Example: . . . . . . The element sets parameters for when and how often this endpoint portal sends pattern use queries. • Cardinality: 0 or 1 • Parents: • Children: XML Attributes: XML Attribute Description Default Value max Maximum number of pattern use queries to send for a given pattern, each separated by the timeout value before giving up and removing the topic from the topic list. Before changing the value of this option, please contact Informatica Support. 5 periodic-interval The interval, in milliseconds, between periodic pattern use queries being sent for each pattern the portal has interest in. Before changing the value of this option, please contact Informatica Support. 300000 timeout The maximum time, in milliseconds, to wait for a pattern use response. Before changing the value of this option, please contact Informatica Support. 3000 Example: . . . . . . 5.2.49The element sets parameters for when and how often this endpoint portal sends topic interest messages. • Cardinality: 0 or 1 • Parents: • Children: XML Attributes: 88 XML Configuration Reference XML Attribute Description Default Value min-interval The minimum interval, in milliseconds, between topic interest messages being sent for each topic the portal has interest in. 1000 max-interval The maximum interval, in milliseconds, between topic interest messages being sent for each topic the portal has interest in. 60000 Example: . . . . . . 5.2.50The element sets parameters for when and how often this endpoint portal sends pattern interest messages. • Cardinality: 0 or 1 • Parents: • Children: XML Attributes: XML Attribute Description Default Value min-interval The minimum interval, in milliseconds, between pattern interest messages being sent for each pattern the portal has interest in. 1000 max-interval The maximum interval, in milliseconds, between pattern interest messages being sent for each pattern the portal has interest in. 60000 Example: . . . . . . 5.2.515.2 Elements Reference 89 The element sets maximum and minimum limits for the interval between periodic domain route messages being sent for each remote domain that the portal is servicing. • Cardinality: 0 or 1 • Parents: • Children: XML Attributes: XML Attribute Description Default Value min-interval The minimum interval, in milliseconds, between domain route messages being sent for each domain. 100 max-interval The maximum interval, in milliseconds, between domain route messages being sent for each domain. 1000 Example: . . . . . . 5.2.52The element determines timings and limits for determination of continued topic interest at this portal. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: 90 XML Configuration Reference XML Attribute Description Default Value check-interval Interval (in milliseconds) between checking individual topics for continued interest. Before changing the value of this option, please contact Informatica Support. 90000 max-topics Maximum number of topics to check at a time. Before changing the value of this option, please contact Informatica Support. 100 timeout Minimum time (in milliseconds) remote interest for a topic must be unrefreshed before interest is removed for that domain. Before changing the value of this option, please contact Informatica Support. 300000 Example: . . . . . . 5.2.53The element determines timings and limits for determination of continued pattern interest at this portal. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value check-interval Interval (in milliseconds) between checking individual patterns for continued interest. Before changing the value of this option, please contact Informatica Support. 90000 max-topics Maximum number of patterns to check at a time. Before changing the value of this option, please contact Informatica Support. 100 timeout Minimum time (in milliseconds) remote interest for a pattern must be unrefreshed before interest is removed for that domain. Before changing the value of this option, please contact Informatica Support. 300000 Example: . . . . . . 5.2.545.2 Elements Reference 91 The element specifies the portal source context name. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value xml:space How whitespace is handled. default trims leading and trailing whitespace (e.g., tabs, spaces, linefeeds, etc.), and compresses multiple whitespace characters into a single space character. preserve preserves the whitespace exactly as read. default Example: . . . . . . 5.2.55SourceContext01 The element specifies the portal receiver context name. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value xml:space How whitespace is handled. default trims leading and trailing whitespace (e.g., tabs, spaces, linefeeds, etc.), and compresses multiple whitespace characters into a single space character. preserve preserves the whitespace exactly as read. default 92 XML Configuration Reference Example: . . . . . . RcvrContext01 The (sequence number window) element specifies the portal's awareness of received message sequence numbers, for the purpose of detecting duplicates. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value increment Determines the minimum increment, in topic (fragment) sequence numbers, by which the sequence number window is moved when the window size (below) is exceeded. Must be a multiple of 8, an even divisor of the window size, and less the window size. Before changing the value of this option, please contact Informatica Support. 2048 size Determines the maximum number of topic (fragment) sequence numbers maintained in the window, for any given source. Must be a multiple of 8. Before changing the value of this option, please contact Informatica Support. 16384 Example: . . . . . . 5.2.57The element determines timing characteristics for context name queries generated at this portal. 5.2 Elements Reference 93 • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value interval Interval (in milliseconds) between groups of context queries. Before changing the value of this option, please contact Informatica Support. 200 max-contexts Maximum number of contexts for which queries are generated at one time. Before changing the value of this option, please contact Informatica Support. 20 periodic-interval Interval (in milliseconds) at which context queries are generated. Before changing the value of this option, please contact Informatica Support. 300000 timeout Minimum time (in seconds) a context query must be unanswered before it is removed for the portal. Before changing the value of this option, please contact Informatica Support. 900 Example: . . . . . . 5.2.58The element is a container element for all configuration options of a single peer portal. • Cardinality:0 or more • Parents: • Children: 5.2.80, ?, ?, ( | ), ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ? XML Attributes: None. Example: 5.2.59 . . . 94 XML Configuration Reference . . . P1 1 . . . . . .The element sets the size of the peer portal's source map. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value size Number of entries in the source map. Must be able to be factorized by all 2s (e.g., 1024, 2048, etc.). 131072 Example: . . . . . . 5.2.60. . . . . . DEPRECATED AS OF UM 6.10. DO NOT USE. The element contains elements for a peer portal's "dual TCP" settings. As of UM 6.10, dual TCP is no longer supported. Please use instead. • Cardinality: 0 or 1 • Parents: ?, , ?, ?, ?, ?, ?, ?, • Children: 5.2 Elements Reference 95 XML Attributes: None. Example: . . . . . . 5.2.6110.28.5.5/24 . . . . . . The element contains the IP host or network address for this peer portal, specified in dotteddecimal or CIDR format. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: None. Example: . . . . . . 5.2.6210.28.5.5/24 . . . . . .The element contains port number on which an acceptor peer portal listens for connections from the initiating peer portal. The initiating peer portal configuration must specify this port as its initiator port. • Cardinality:1 96 XML Configuration Reference • Parents: • Children: None. XML Attributes: None. Example: . . . . . . 5.2.63. . . . . . 46000 The element contains the size of the TCP receive buffer. If not specified, the UM Router uses the system default size. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: None. Example: . . . . . . 5.2.64128000 . . . . . .The element contains the size of the TCP send buffer. If not specified, the UM Router uses the system default size. 5.2 Elements Reference 97 • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: None. Example: . . . . . . 5.2.65128000 . . . . . .The element, when present, enables a TCP keepalive signal transmission, which is disabled by default. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: None. Example: . . . . . . 98 XML Configuration Reference 5.2.66. . . . . . The element, when present, allows immediate sending of messages without waiting for the batching send buffer to fill. This is disabled by default. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: None. Example: . . . . . . 5.2.67. . . . . . The element enables compression and sets the desired data compression algorithm for the peer link. Currently, only LZ4 lossless data compression is supported. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: None. Example: . . . . . . 5.2 Elements Reference 99 5.2.68LZ4 . . . . . .The element contains elements to configure peer link encryption. • Cardinality: 0 or 1 • Parents: , , ?, ?, ? • Children: XML Attributes: None. Example: . . . . . . Note that in this example, the final. . . . . . test.crt test.key CorrectHorseBatteryStaple peers.crt element is omitted. The default is recommended. 5.2.69 The element specifies the path to a file containing an OpenSSL-compatible PEM-formatted certificate that will be presented as the TLS server certificate when a TLS connection is established by a client. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: None. Example: . . . . . . 5.2.70100 XML Configuration Reference . . . . . .test.crt . . . . . . The element specifies the path to a file containing the private key associated with the "server" certificate specified by . Note that this private key must be protected from intruders. For that reason, when the certificate and private key files are generated, the private key file is typically encrypted with a passphrase. The passphrase is supplied using . • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: None. Example: . . . . . . 5.2.71. . . . . . test.key . . . . . . The element specifies the passphrase needed to decrypt the server private key file specified by . • Cardinality: 0 or 1 • Parents: 5.2 Elements Reference 101 • Children: None. XML Attributes: None. Example: . . . . . . 5.2.72. . . . . . CorrectHorseBatteryStaple . . . . . .The element specifies the path to a file containing one or more OpenSSLcompatible PEM-formatted TLS client certificates and certificate authorities. If this element is not supplied, the default behavior is to use the system-level trusted certificates and certificate authorities (operating-system dependent). The TLS server uses these trusted certificates to verify the identity of connecting clients. If a client connects and presents a certificate which is not in the server's trusted certificates file, the connection will be canceled. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: None. Example: . . . . . . 102 XML Configuration Reference 5.2.73. . . . . . peers.crt . . . . . . The element defines the list of one or more (comma separated) names of cipher suites that are acceptable to this context. The names are in OpenSSL format; see https://www.openssl.←org/docs/manmaster/apps/ciphers.html#TLS-v1.2-cipher-suites for a list of valid suite names (the ones with dashes) and the equivalent IANA names (with underscores). If more than suite name one is supplied, they should be in descending order of preference. When a remote context negotiates encrypted T←CP, the two sides must find a cipher suite in common, otherwise the connection will be canceled. The default, TLS_DHE_RSA_WITH_AES_256_GCM_SHA384, is highly secure and is recommended. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: None. Example: . . . . . . 5.2.74. . . . . . TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 . . . . . . DEPRECATED AS OF UM 6.10. DO NOT USE. The element contains the IP address and the port of the companion peer portal on another UM Router, to which this peer is connected via "dual TCP". As of UM 6.10, dual TCP ( ) is no longer supported. Please use instead. • Cardinality: 0 or 1 • Parents: • Children: , XML Attributes: None. Example: 5.2 Elements Reference 103 . . . . . . 5.2.75 The element contains the IP address of the acceptor peer portal on another UM Router, to which this initiator peer is connected via "single TCP". (As of UM 6.10, dual TCP (10.28.3.91 . . . . . .25000 ) is no longer supported.) • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: None. Example: . . . . . . 5.2.7610.28.3.91 . . . . . .25000 The element contains the IP port of the acceptor peer portal on another UM Router, to which this initiator peer is connected. (As of UM 6.10, dual TCP ( ) is no longer supported.) • Cardinality: 0 or 1 104 XML Configuration Reference • Parents: • Children: None. XML Attributes: None. Example: . . . . . . 5.2.7710.28.3.91 . . . . . .25000 The element contains elements for a peer portal's tcp settings, when configuring the peer for single-tcp operation. • Cardinality: 0 or 1 • Parents: ?, ?, ?, ?, ?, ?, ?, ( | ) • Children: XML Attributes: None. Example: . . . . . .. . . . . . 5.2 Elements Reference 105 5.2.7810.28.5.5/24 . . . . . . 23746 The element contains the IP address and the port of the corresponding acceptor peer portal on another UM Router, to which this peer is connected. This element is used in single-tcp configurations. • Cardinality: 0 or 1 • Parents: • Children: , XML Attributes: XML Attribute Description Default Value reconnect-interval The time interval, in milliseconds, to wait before reconnecting to the companion portal if this connection is interrupted. 5000 Example: . . . . . . 5.2.7910.28.3.91 . . . . . .25000 The element contains the listen port address of the corresponding acceptor peer portal on another UM Router, to which this peer is connected. This element is used in single-tcp configurations. • Cardinality: 0 or 1 • Parents: • Children: XML Attributes: None. Example: . . . . . . 106 XML Configuration Reference 25000 The element specifies the maximum size a peer portal will allow an outgoing datagram to be before fragmenting it. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: None. Example: . . . . . . 5.2.8150000 The element enables the smart batching algorithm used by the UM Router when forwarding messages from one portal to another. In general, batching algorithms are used to increase throughput, but many such algorithms can produce latency outliers. The Smart Batching algorithm is designed to ensure low latencies by flushing the batching buffer when no more messages are waiting to be sent out the portal. Smart batching works with both endpoint and peer portals. For endpoint portals, a UM configuration file may be provided to set the implicit_batching_minimum_length (source) option to a large value. For peer portals, the element may be used to set the to a large value. In either case, large values are recommended and will not produce significant latency outliers. • Cardinality: 0 or 1 • Parents: , • Children: None. XML Attributes: None. Example: 5.2 Elements Reference 107 . . . . . . 5.2.821 4096 The element contains batching size and timing parameters for peer link implicit batching. This applies to data messages only: the UM Router sends control messages immediately (flushing any batched data messages). Note: worst-case latency can be dramatically reduced by combining batching with . • Cardinality: 0 or 1 • Parents: • Children: ?, ? XML Attributes: None. Example: . . . . . . 5.2.834096 500 The element specifies the minimum length of a set of batched messages. When the total length of the batched messages reaches or exceeds this value, the batch is sent. If not specified, it defaults to 8192 bytes. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: None. Example: 108 XML Configuration Reference . . . . . . 5.2.844096 500 The element specifies the maximum interval (in milliseconds) between when the first message of a batch is queued until the batch is sent. A message stays in the batch queue until this value or is met or exceeded (whichever occurs first). If not specified, it defaults to 200 milliseconds. The minimum allowed value is 3 milliseconds. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: None. Example: . . . . . . 5.2.854096 500 The element contains parameters for the keepalive signals sent from this peer portal. This is a UM Router-level keepalive, not to be confused with the TCP-level element. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: 5.3 Deprecated Elements 109 XML Attribute Description Default Value idle Determines if UM Router keepalives should be sent only if no traffic has been sent or received in the last interval. Possible values are yes or no. yes interval Minimum interval, in milliseconds, between keepalive messages sent. We recommend setting this to 2000 or greater. A value of 0 (zero) disables keepalives. 5000 timeout Maximum time, in milliseconds, a peer can receive nothing from the companion before determining the connection is dead and disconnecting. We recommend setting this to 3 times the interval value. 15000 Example: . . . . . . 5.3 Deprecated Elements The following option elements are deprecated, and provided only for UM Gateway configuration file backward compatibility. Values assigned to them have no effect on the operation of the UM Router. 5.3.1The element specifies the difference between the shortest and longest propagation delays in the network. This element is deprecated. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value delta The difference, in milliseconds, between the shortest and longest propagation delays in the network. 0 Example: 5.3.2 . . . . . . 110 XML Configuration Reference The element determines how Late Join is handled by this endpoint portal. This element is deprecated. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value forward If late join retransmission requests to a source on the portal are unable to be filled locally, determines if requests are forwarded to the original source. Choices are yes or no. This only applies to sources created on the portal with late join support. yes provide Determines whether sources created on a portal should provide late join to receivers. Allowable values are: source - Provide late join only if the original source provides late join. always - Always provide late join, even if the original source does not. never - Never provide late join, even if the original source does. The UM configuration specified for the portal determines the late join configuration. source Example: . . . . . . 5.3.3The element determines when this portal's proxy receivers can purge topics. This element is deprecated. • Cardinality: 0 or 1 • Parents: 5.3 Deprecated Elements 111 • Children: None. XML Attributes: XML Attribute Description Default Value periodic-interval Interval (in milliseconds) at which receiver topics are checked to determine if they can be purged. 6000 Example: . . . . . . 5.3.4The element determines timing characteristics for interest message generation at this portal. This element is deprecated. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value interval Interval (in milliseconds) between groups of topics. 200 max-topics Maximum topics for which interest is generated at one time. 20 periodic-interval Interval (in milliseconds) at which topic interest is generated. 300000 Example: . . . . . . 112 XML Configuration Reference 5.3.5The element determines how long a domain remains quiescent until it is determined inactive. This element is deprecated. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value timeout Minimum time (in seconds) domain interest for a topic must be unrefreshed before interest is removed for that domain. 900 Example: . . . . . . 5.3.6The element determines when this portal's proxy receivers can purge pattern. This element is deprecated. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value periodic-interval Interval (in milliseconds) at which receiver patterns are checked to determine if they can be purged. 6000 Example: . . . . . . 5.3.75.3 Deprecated Elements 113 The element determines timing characteristics for interest message generation at this portal. This element is deprecated. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value interval Interval (in milliseconds) between groups of patterns. 200 max-patterns Maximum patterns for which interest is generated at one time. 300000 periodic-interval Interval (in milliseconds) at which pattern interest is generated. 300000 Example: . . . . . . 5.3.8The element determines how long a domain remains quiescent until it is determined inactive. This element is deprecated. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: 114 XML Configuration Reference XML Attribute Description Default Value timeout Minimum time (in seconds) domain interest for a pattern must be unrefreshed before interest is removed for that domain. 900 Example: . . . . . . 5.3.9The element checks for interest in topics at periodic intervals. This element is deprecated. • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value periodic-interval The interval (in milliseconds) at which source topics are checked to determine if there is no more interest. Before changing the value of this option, please contact Informatica Support. 300000 Example: . . . . . . 5.3.10The element checks for interest in patterns at periodic intervals. This element is deprecated. 5.3 Deprecated Elements 115 • Cardinality: 0 or 1 • Parents: • Children: None. XML Attributes: XML Attribute Description Default Value periodic-interval The interval (in milliseconds) at which source pattern are checked to determine if there is no more interest. Before changing the value of this option, please contact Informatica Support. 300000 Example: . . . . . . 5.3.11The element configures the rate at which Daemon Statistics messages are published. See Daemon Statistics for general information on Daemon Statistics. • Cardinality: 0 or 1 • Parents: , , • Children: XML Attributes: None. Example: 116 XML Configuration Reference 5.3.12 . . . . . . /path/umrouter_monitor.cfg . . . The element configures the rate at which one particular grouping of Daemon Statistics messages are published. See Daemon Statistics for general information on Daemon Statistics. • Cardinality: 0 or 1 • Parents: • Children: none. XML Attributes: None. Example: 5.4 UM Router Configuration DTD Here is the XML configuration DTD with the comments removed. To see the DTD with comments included, enter tnwgd --dump-dtd. 118 batch-interval ( #PCDATA )> lbm-config ( #PCDATA )> lbm-config xml:space (default | preserve) "default"> lbm-attributes (option+)> option EMPTY> option scope (receiver | context | source | wildcard_receiver | event_queue) #REQUIRED name CDATA #REQUIRED value CDATA #REQUIRED > 119 120 pattern-purge EMPTY> pattern-purge periodic-interval CDATA #IMPLIED> pattern-interest-generate EMPTY> pattern-interest-generate periodic-interval CDATA #IMPLIED max-patterns CDATA #IMPLIED interval CDATA #IMPLIED pattern-domain-activity EMPTY> pattern-domain-activity timeout CDATA #IMPLIED> remote-topic EMPTY> remote-topic check-interval CDATA " 90000 " max-topics CDATA " 100 " timeout CDATA " 300000 " > 5.4 UM Router Configuration DTD 121 122 XML Configuration Reference Chapter 6 UM Router Daemon Statistics This section contains details on the UM Router's Daemon Statistics feature. You should already be familiar with the general information contained in Daemon Statistics. 6.1 UM Router Daemon Statistics Structures The different message types are: • TNWG_DSTATTYPE_MALLINFO • TNWG_DSTATTYPE_GATEWAYCFG • TNWG_DSTATTYPE_PORTCFG • TNWG_DSTATTYPE_RM_LOCAL • TNWG_DSTATTYPE_RM_PORTAL • TNWG_DSTATTYPE_RM_OTHERGW • TNWG_DSTATTYPE_RM_OTHERGW_NBR • TNWG_DSTATTYPE_PORTSTAT Each one has a specific structure associated with it, as detailed in tnwgdmonmsgs.h. Note that message types ending with "CFG" are in the config category. All others are in the stats category. See Daemon Statistics Structures for information on how the two categories are handled differently. 6.1.1 UM Router Daemon Statistics Byte Swapping A monitoring application receiving these messages must detect if there is an endian mismatch (see Daemon Statistics Binary Data). The header structure tnwg_dstat_msg_hdr_t contains a 16-bit field named magic which is set equal to LBM_TNWG_DAEMON_MAGIC. The receiving application should compare it to LBM_TNWG_DAE←MON_MAGIC and LBM_TNWG_DAEMON_ANTIMAGIC. Anything else would represent a serious problem. If the receiving app sees: magic == LBM_TNWG_DAEMON_MAGIC 124 UM Router Daemon Statistics then it can simply access the binary fields directly. However, if it sees: magic == LBM_TNWG_DAEMON_ANTIMAGIC then most (but not all) binary fields need to be byte-swapped. See tnwgdmon.c for an example, paying special attention to the macros COND_SWAPxx (which conditionally swaps based on the magic test) and the functions byte_swapXX() (which performs the byte swapping). 6.1.2 UM Router Daemon Statistics String Buffers UM Router Daemon Statistics data structures sometimes contain string buffers. Strings in these data structures are always null-terminated. These messages are generally sent as fixed-length equal to the sizes of the structures, and therefore include all of the declared bytes of the string fields, even if the contained string uses fewer bytes than declared. For example, the structure tnwg_dstat_record_hdr_t contains the field tnwg_dstat_record_hdr_t_←stct::portal_name which is a char array of size TNWG_DSTAT_MAX_PORTAL_NAME_LEN. If portal_name is set to "p1", then only 3 bytes of the buffer are used (including the null string terminator). However, all TN←WG_DSTAT_MAX_PORTAL_NAME_LEN bytes will be sent in the TNWG_DSTATTYPE_RM_PORTAL message type. Contrast this with Store Daemon Statistics String Buffers. There are two exceptions to this rule: TNWG_DSTATTYPE_PORTCFG and TNWG_DSTATTYPE_GATEWAYC←FG. The TNWG_DSTATTYPE_PORTCFG message is of type tnwg_pcfg_stat_grp_msg_t and has the field tnwg←_pcfg_stat_grp_msg_t_stct::data. This field is a variable-length string buffer which contains one or more nullterminated strings. The total length of the TNWG_DSTATTYPE_PORTCFG message is the sum of the length of its sub-structures plus the number of bytes of string data (characters plus string-terminating nulls). The number of strings in tnwg_pcfg_stat_grp_msg_t_stct::data is given by tnwg_pcfg_stat_grp_msg_t_stct::rechdr->num←_options. The monitoring application must step through the string buffer that many times to find each string. For an example of how to do this, see tnwgdmon.c in the code following, "‘case TNWG_DSTATTYPE_PORTCFG:‘". The TNWG_DSTATTYPE_GATEWAYCFG message is of type tnwg_dstat_gatewaycfg_msg_t and has the field tnwg_dstat_gatewaycfg_msg_t_stct::data. This field is a variable-length string buffer which contains exactly one null-terminated string. This string contains the entirety of the UM Router's configuration file. The individual lines contain the normal line-ending character(s). The total length of the TNWG_DSTATTYPE_GATEWAYCFG message is the length of its sub-structure plus the number of bytes of string data (characters plus string-terminating nulls). 6.2 UM Router Daemon Statistics Configuration There are three places in the UM Router configuration file that Daemon Statistics are configured: • The . . . . . . /path/umrouter_monitor.cfg . . . element inside the definition. Configures all aspects of the Store Daemon Statistics feature, including publishing intervals. • The element inside the definition. Configures only the publishing intervals on a peer portal basis. • The element inside the definition. Configures only the publishing intervals on an endpoint portal basis. Here is an example of configuring daemon statistics. 6.3 UM Router Daemon Statistics Requests 125 In this example, all stats-type messages are (conditionally) published on a 3-second interval, except those of portal G1-TRD1, which are published (conditionally) on a 6-second interval. All config-type messages are published (unconditionally) on a 120-second interval. 6.3 UM Router Daemon Statistics Requests The UM Router Daemon supports a monitoring application to send a specific set of requests to control the operation of Daemon Statistics. The remote-snapshot-request and remote-config-changes-request configuration elements control whether the Store enables this request feature (defaults to disabled). If enabled, the monitoring application can send a command message to the UM Router in the form of a topicless unicast immediate "request" message (see lbm_unicast_immediate_request() with NULL for topic). The format of the message is a simple ascii string, with or without null termination. Due to the simple format of the message, no data structure is defined for it. When the UM Router receives and validates the command, it sends a UM response message back to the requesting application containing a status message (which is not null-terminated). If the status was OK, the Store also performs the requested action. The example program tnwgdcmd.c demonstrates the correct way to send the messages and receive the responses. Commands enabled by remote-snapshot-request: version The UM Router returns in its command response the value of LBM_UMESTORE_DMON_VERSION. No daemon statistics messages are published. snap mallinfo The UM Router immediately publishes the memory allocation usage message of type TNWG_DSTATTYPE←_MALLINFO. 126 UM Router Daemon Statistics snap pstat The UM Router immediately publishes the portal statistics message(s) of type TNWG_DSTATTYPE_PORT←STAT. snap ri The UM Router immediately publishes the route information message(s) of types TNWG_DSTATTYPE_RM←_LOCAL, TNWG_DSTATTYPE_RM_PORTAL TNWG_DSTATTYPE_RM_OTHERGW, and TNWG_DSTA←TTYPE_RM_OTHERGW_NBR. snap gcfg The UM Router immediately publishes the gateway configuration message TNWG_DSTATTYPE_GATEWA←YCFG. snap pcfg The UM Router immediately publishes the portal configuration message(s) TNWG_DSTATTYPE_PORTCFG. Commands enabled by remote-config-changes-request: mallinfo N Set the publishing interval for memory allocation usage. For example: mallinfo 5 ri N Set the publishing interval for the route information messages. For example: ri 5 gcfg N Set the publishing interval for the gateway configuration message. For example: gcfg 5 pstat N Set the publishing interval for the portal statistics messages. This command can be preceded by a portal name in double quote marks to only set the publishing interval for that portal. For example: "G1-TRD1" pstat 5 pcfg N Set the publishing interval for the portal configuration messages. This command can be preceded by a portal name in double quote marks to only set the publishing interval for that portal. For example: "G1-TRD1" pcfg 5 Chapter 7 UM Router Monitoring 7.1 Router Web Monitor The built-in web monitor (configured in the tnwgd XML configuration file; see XML Configuration Reference) provides valuable statistics about the UM Router and its portals, for which, the Web Monitor separates into receive statistics and send statistics. The Web Monitor provides a page for each endpoint and peer portal. 7.1.1 Main Page This page displays general information about the UM Router, and also provides the following links to more detailed statistical and configuration information. UM Router Configuration Displays the UM Router XML configuration file used by this UM Router. Portals Displays portal statistics and information, one portal per page. The Portals page allows you to link to any of the Peer or Endpoint portals configured for the UM Router. Topology Info This links to a page that displays UM Router network connectivity information from the perspective of this UM Router. Path Info This lets you query and display a hop path that messages will take between any two TRDs. On some platforms, the Main page may include a link (GNU malloc info) to a memory allocation display page that displays the following: arena Non-mmapped space allocated (bytes) 128 UM Router Monitoring ordblks Number of free chunks hblks Number of mmapped regions hblkhd Space allocated in mmapped regions (bytes) uordblks Total allocated space (bytes) fordblks Total free space (bytes) 7.1.2 Endpoint Portal Page The Endpoint Portal Page displays Receive and Send statistics for the selected endpoint portal. Receive statistics pertain to messages entering the portal from its connected TRD. Send statistics pertain to messages sent out to the TRD. Click on any of the links at the top of the page to review configuration option values for the portal's UM topic resolution domain. The two columns provide different units of measure for a given statistic type, where the first column is typically in fragments or messages (depending on the statistic type), and the second column is in bytes. Endpoint Portal name Domain ID The ID for the Topic Resolution Domain (TRD) to which this portal is connected. Portal Cost The cost value assigned to this portal. Local Interest Totals (listed below) for topics and patterns in this portal's interest list that originated from receivers in the immediately adjacent TRD. Topics Of the local interest total, the number of topics. PCRE patterns Of the local interest total, the number of wildcard patterns, using PCRE pattern matching. REGEX patterns Of the local interest total, the number of wildcard patterns, using REGEX pattern matching. Remote Interest Totals (listed below) for topics and patterns in this portal's interest list that originated from receivers beyond and downstream from the immediately adjacent TRD. 7.1 Router Web Monitor 129 Topics Of the remote interest total, the number of topics. PCRE patterns Of the remote interest total, the number of wildcard patterns, using PCRE pattern matching. REGEX patterns Of the remote interest total, the number of wildcard patterns, using REGEX pattern matching. Proxy Receivers The number of proxy receivers active in this portal. Receiver Topics The number of topics in which the other portals in the UM Router have detected current interest and summarily propagated to this portal. Receiver PCRE patterns The number of wildcard patterns, using PCRE pattern matching, in which the other portals in the UM Router have detected current interest and summarily propagated to this portal. Receiver REGEX patterns The number of wildcard patterns, using REGEX pattern matching, in which the other portals in the UM Router have detected current interest and summarily propagated to this portal. Proxy Sources The number of proxy sources active in this portal. Endpoint Receive Statistics Transport topic fragments/bytes received The total transport-based topic-related traffic of messages containing user data received by this portal from a TRD. The first column counts the number of fragments (or whole messages for messages that were not fragmented). Transport topic request fragments/bytes received Topic messages received that are request messages, i.e., messages send via lbm_send_request∗() rather than lbm_src_send∗(). Transport topic control msgs/bytes received The total transport-based topic-related traffic received by this portal from a TRD. These are supervisory messages, which include TSNIs, SRIs., etc. The first column counts the number of messages. Immediate topic fragments/bytes received The total number of Multicast Immediate Messaging (MIM) messages or message fragments, and bytes (second column), that have a topic, received at this portal. Immediate topic request fragments/bytes received Of the MIM topic messages received, this is the amount of those that are requests. 130 UM Router Monitoring Immediate topicless fragments/bytes received The total number of MIM messages or message fragments, and bytes (second column), with null topics, received by his portal. Immediate topicless request fragments/bytes received Of the MIM topicless messages received, this is the amount of those that are requests. Unicast data messages/bytes received The total number of Unicast Immediate Messaging (UIM) messages (and bytes, second column) containing user data, received by this portal. Duplicate unicast data messages/bytes dropped UIM data messages discarded because they were duplicates of messages already received. Unicast data messages/bytes received with no stream info UIM data messages discarded because they were from an earlier, incompatible version of UM. This tally should stay at 0; otherwise, contact Informatica Support. Unicast data messages/bytes received with no route to destination UIM data messages that are on a wrong path, possibly due to a route recalculation. This tally should stay at 0, though it may increment a few messages at the time of a topology change. Unicast control messages/bytes received The total number of Unicast Immediate Messaging (UIM) supervisory (non-data) messages (and bytes, second column) received by this portal. Duplicate unicast control messages/bytes dropped Supervisory UIMs dropped because they were duplicates of messages already received. Unicast control messages/bytes received with no stream info Supervisory UIMs dropped because they were from an earlier, incompatible version of UM. This tally should stay at 0; otherwise, contact Informatica Support. Unicast control messages/bytes received with no route to destination Supervisory UIM messages that are on a wrong path, possibly due to a route recalculation. This tally should stay at 0, though it may increment a few messages at the time of a topology change. Endpoint Send Statistics Transport topic fragments/bytes forwarded The total transport-based topic-related traffic forwarded to this portal from other portals in this UM Router. This could include user messages, TSNIs, SRIs, etc. The first column counts the number of fragments (or whole messages for messages that were not fragmented). Transport topic fragments/bytes sent Of the transport topic traffic forwarded, this is the amount of traffic sent out to the TRD. Transport topic request fragments/bytes sent Of the messages sent, this is the amount of those that are requests. 7.1 Router Web Monitor 131 Duplicate transport topic fragments/bytes dropped Of the messages forwarded to this portal, this is the total of those that were discarded because they were duplicates of messages already received. Transport topic fragments/bytes dropped due to blocking Of the messages forwarded to this portal, this is the amount of those that were discarded because they were blocked from sending, and were unable to be buffered. Message rates on other portals probably exceeded the rate controller limit on this portal. Transport topic fragments/bytes dropped due to error Of the messages forwarded to this portal, this is the total of those that were discarded due to an application or network connection failure. Transport topic fragments/bytes dropped due to fragment size error Of the messages forwarded to this portal, this is the total of those that were discarded possibly because of a configuration error. If this count is not at or near 0, verify that maximum datagram size for all transports is the same throughout the network. Immediate topic fragments/bytes forwarded The total number of Multicast Immediate Messaging (MIM) messages or message fragments, and bytes (second column), forwarded to this portal from other portals in this UM Router. Immediate topic fragments/bytes sent Of the MIM topic messages forwarded to this portal, this is the amount of traffic sent out to the TRD. Immediate topic request fragments sent Of the MIM topic messages sent, this is the amount of those that are requests. Immediate topic fragments/bytes dropped due to blocking Of the MIM topic messages forwarded to this portal, this is the amount of those that were discarded because they were blocked from sending, and were unable to be buffered. Message rates on other portals probably exceeded the rate controller limit on this portal. Immediate topic fragments/bytes dropped due to error Of the MIM topic messages forwarded to this portal, those that were discarded due to an application or network connection failure. Immediate topic fragments/bytes dropped due to fragment size error Of the MIM topic messages forwarded to this portal, those that were dropped possibly because of a configuration error. If this count is not at or near 0, verify that maximum datagram size for all transports is the same throughout the network. Immediate topicless fragments/bytes forwarded The total number of Multicast Immediate Messaging (MIM) messages or message fragments, and bytes (second column), with null topics, forwarded to this portal from other portals in this UM Router. Immediate topicless fragments/bytes sent Of the MIM topicless messages forwarded to this portal, this is the amount of traffic sent out to the TRD. Immediate topicless request fragments sent Of the MIM topicless messages sent, this is the amount of those that are requests. 132 UM Router Monitoring Immediate topicless fragments/bytes dropped due to blocking Of the MIM topicless messages forwarded to this portal, this is the amount of those that were discarded because they were blocked from sending, and were unable to be buffered. Message rates on other portals probably exceeded the rate controller limit on this portal. Immediate topicless fragments/bytes dropped due to error Of the MIM topicless messages forwarded to this portal, those that were discarded due to an application or network connection failure. Immediate topicless fragments/bytes dropped due to fragment size error Of the MIM topicless messages forwarded to this portal, those that were dropped possibly because of a configuration error. If this count is not at or near 0, verify that maximum datagram size for all transports is the same throughout the network. Unicast messages/bytes forwarded The total number of Unicast Immediate Messaging (UIM) messages (and bytes, second column), both control and containing user data, forwarded to this portal. Unicast messages/bytes sent Of the UIM data messages forwarded to this portal, this is the amount of traffic sent out to the TRD. Unicast messages/bytes dropped due to error Of the UIM data messages forwarded to this portal, those that were discarded due to an application or network connection failure. Current/maximum data bytes enqueued (limit: n) For bytes in this portal's send buffer (due to a blocking send), the first column is a snapshot of the current amount, and the second column is a high-water mark. The displayed limit (n) is the configuration value for option ... ... G1-TRD1 .... 7.1.3 Peer Portal Page This page allows you to see Receive and Send statistics for the selected peer portal. Click on any of the links at the top of the page to review configuration option values for the portal's UM topic resolution domain. The peer portal page displays the following statistics: Peer Portal name Portal Cost The cost value assigned to this portal. Interest Totals (listed below) for topics and patterns in this portal's interest list that originated from receivers beyond and downstream from the immediately adjacent UM Router. Topics Of the interest total, the number of topics. 7.1 Router Web Monitor 133 PCRE patterns Of the interest total, the number of wildcard patterns, using PCRE pattern matching. REGEX patterns Of the interest total, the number of wildcard patterns, using REGEX pattern matching. Proxy Receivers The number of proxy receivers active in this portal. Receiver topics All topics in which the other portals in the UM Router have detected current interest and summarily propagated to this portal. Receiver PCRE patterns All wildcard patterns, using PCRE pattern matching, in which the other portals in the UM Router have detected current interest and summarily propagated to this portal. Receiver REGEX patterns All wildcard patterns, using REGEX pattern matching, in which the other portals in the UM Router have detected current interest and summarily propagated to this portal. Proxy Sources The number of proxy sources active in this portal. Peer Receive Statistics Data messages/bytes received The total of messages containing data received at this portal. The first column counts the number of fragments (or whole messages for messages that were not fragmented). Transport topic fragment data messages/bytes received The total of user-data messages received on any topic resolved through this portal. The first column counts the number of fragments (or whole messages for messages that were not fragmented). Transport topic fragment data messages/bytes received with unknown source Topic messages received whose source this UM Router has not seen before. Transport topic request fragment data messages/bytes received These are topic messages received that are request messages, i.e., messages send via lbm_send_request∗() rather than lbm_src_send∗(). Transport topic request fragment data messages/bytes received with unknown source Of the request messages received, the topic messages received whose source this UM Router has not seen before. Immediate topic fragments/bytes received The total number of Multicast Immediate Messaging (MIM) messages or message fragments, and bytes (second column), that have a topic, received by all proxy receivers at this portal. 134 UM Router Monitoring Immediate topic request fragments/bytes received Of the MIM topic messages received, this is the total of those that are requests. Immediate topicless fragments/bytes received The total number of MIM messages or message fragments, and bytes (second column), with null topics, received by all proxy receivers at this portal. Immediate topicless request fragments/bytes received Of the MIM topicless messages received, this is the total of those that are requests. Unicast data messages/bytes received The total number of Unicast Immediate Messaging (UIM) messages (and bytes, second column) containing user data, received by this portal. Unicast data messages/bytes received with no stream information UIM data messages discarded because they were from an earlier, incompatible version of UM. This tally should stay at 0; otherwise, contact Informatica Support. Unicast data messages/bytes received with no route to destination UIM data messages that are on a wrong path, possibly due to a route recalculation. This tally should stay at 0, though it may increment a few messages at the time of a topology change. Control messages/bytes received The total of supervisory messages (containing no data) received at this portal. Transport topic control messages/bytes received Of the control messages received, those that are transport/topic based (such as TSNIs, SRIs., etc.). Transport topic control messages/bytes received with unknown source Of the transport/topic control messages received whose source this UM Router has not seen before. Unicast control messages/bytes received The total number of Unicast Immediate Messaging (UIM) supervisory (non-data) messages (and bytes, second column) received by this portal. Retransmission requests/bytes received Supervisory UIMs that are requests for retransmission of lost (or Late Join) messages. Control messages/bytes received with no stream info Supervisory UIMs discarded because they were from an earlier, incompatible version of UM. This tally should stay at 0; otherwise, contact Informatica Support. Control messages/bytes received with no route to destination Supervisory UIM messages that are on a wrong path, possibly due to a route recalculation. Gateway control messages/bytes received The total of UM Router-only, peer-to-peer supervisory messages received at this portal. Unhandled control messages/bytes received Supervisory UIMs discarded because, though they are well-formed, they have no valid action request. This tally should stay at 0; otherwise, contact Informatica Support. 7.1 Router Web Monitor 135 Peer Send Statistics Transport topic fragments/bytes forwarded The total transport-based topic-related traffic forwarded to this portal from other portals in this UM Router. This could include user messages, TSNIs, SRIs., etc. The first column counts the number of fragments (or whole messages for messages that were not fragmented). Transport topic fragments/bytes sent Of transport topic messages forwarded to this portal, the amount of traffic sent to the adjacent UM Router. Transport topic request fragments/bytes sent Of transport topic messages sent, those that were request messages. Transport topic fragments/bytes dropped (duplicate) Of transport topic messages forwarded to this portal, messages discarded because they were duplicates of messages already received. Transport topic fragments/bytes dropped (blocking) Of transport topic messages forwarded to this portal, this is the amount of those that were discarded because they were blocked from sending, probably due to TCP flow control, and were unable to be buffered. The UM Router's XML configuration file may need to be adjusted. Transport topic fragments/bytes dropped (not operational) Of transport topic messages forwarded to this portal, messages discarded because the peer link is down. Transport topic fragments/bytes dropped (queue failure) Of transport topic messages forwarded to this portal, messages discarded due to a memory allocation failure. Unicast messages/bytes forwarded The total number of supervisory (no data payloads) Unicast Immediate Messaging (UIM) messages (and bytes, second column) forwarded to this portal from other portals in this UM Router. These messages can be either control (supervisory) messages or contain user data. Unicast messages/bytes sent Of the UIMs forwarded to this portal, the amount of traffic sent to the adjacent UM Router. Unicast messages/bytes dropped (blocking) Of the UIMs forwarded to this portal, this is the amount of those that were discarded because they were blocked from sending, probably due to TCP flow control, and were unable to be buffered. The UM Router's XML configuration file may need to be adjusted. Unicast messages/bytes dropped (not operational) Of the UIMs forwarded to this portal, messages discarded because the peer link is down. Unicast messages/bytes dropped (queue failure) Of the UIMs forwarded to this portal, messages discarded due to a memory allocation failure. Gateway control messages/bytes sent The total number of UM Router supervisory messages (and bytes, second column), generated at this portal. 136 UM Router Monitoring Gateway control messages/bytes sent Of the UM Router supervisory messages generated, the number sent to the adjacent UM Router. Gateway control messages/bytes dropped (blocking) The amount of UM Router supervisory messages that were discarded because they were blocked from sending, probably due to TCP flow control, and were unable to be buffered. The UM Router's XML configuration file may need to be adjusted. Gateway control messages/bytes dropped (not operational) The amount of UM Router supervisory messages that were discarded because the peer link was down. Gateway control messages/bytes dropped (queue failure) The amount of UM Router supervisory messages that were discarded due to a memory allocation failure. Batches The number of times messages were batched. Minimum messages/bytes per batch The lowest recorded number of messages in a batch, and the number of bytes in that batch. Average messages/bytes per batch The average number of messages in a batch, and the number of bytes in that average batch. Maximum messages/bytes per batch The highest recorded number of messages in a batch, and the number of bytes in that batch. Current/maximum data bytes enqueued For bytes in this portal's send buffer (due to a blocking send), the first column is a snapshot of the current amount, and the second column is a high-water mark. The displayed limit is the configuration value for option . Keepalive/RTT samples The number of keepalive messages that have been set to the other UM Router's portal and responded to. Minimum RTT (microseconds) Of the keepalives sent and responded to, the lowest recorded round-trip time. Mean RTT (microseconds) Of the keepalives sent and responded to, the mean recorded round-trip time. Maximum RTT (microseconds) Of the keepalives sent and responded to, the highest recorded round-trip time. Last keepalive responded to The send timestamp (date and time) of the last sent keepalive message that was responded to. 7.1 Router Web Monitor 7.1.4 137 Topology Info Page This page allows you to see UM Router network connectivity information from the perspective of this UM Router. The Other UM Routers section (below) provides information in the same format as is used for the local UM Router. Local UM Router Name The UM Router name as assigned via configuration. Local UM Router ID A unique value that the UM Router assigns to itself automatically. Self Version A configuration version for this UM Router, as seen collectively by the UM Router network. Topology Signature An identifier for the "map" of this UM Router network's routes. This value should be the same for all UM Routers. Last recalc duration The amount of time in seconds that it took this UM Router to perform its most recent route recalculation. Graph Version The number of times this UM Router has updated its view of the topology. UM Router Count The number of UM Routers in this UM Router network. Topic Resolution Domain Count The number of TRDs in this UM Router network. Portal (endpoint or peer) This display is repeated for each portal of this UM Router. Portal Name The portal's name as assigned via configuration. Adjacent Domain/UM Router ID For an endpoint portal, this is the configured for the connected TRD. For a peer portal, this is an automatically assigned unique identifier for the connected UM Router. Cost This portal's configured cost. Last interest recalc duration The amount of time in seconds that it took this UM Router to perform a recalculation that resulted in an update to the interest status for this portal. Last proxy receiver recalc duration The amount of time in seconds that it took this UM Router to perform recalculation that resulted in an update to the status of proxy receivers (create, maintain, or destroy) for this portal. 138 UM Router Monitoring Other UM Routers This display is repeated for each other UM Router in this UM Router's network. UM Router Name The UM Router name as assigned via configuration. UM Router ID A unique value that the UM Router assigns to itself automatically. Version A configuration version for the UM Router, as seen collectively by the UM Router network. Topology Signature An identifier for the "map" of this UM Router network's routes. This value should be the same for all UM Routers. Last Activity n seconds ago How long since the last time this local UM Router received a route info packet from the designated "other" UM Router. Adjacent Domain ID The configured ID of one of this "other" UM Router's connected TRD, plus the cost assigned to the associate endpoint portal. If there are more than one endpoint portals in the UM Router, this line is repeated for each. Adjacent UM Router ID The automatically assigned ID of one of this "other" UM Router's connected UM Router, plus the cost assigned to the associate peer portal. If there are more than one peer portals in the UM Router, this line is repeated for each. 7.1.5 Path Info The Path Info page lets you query and display a hop path that messages will take between any two TRDs that you enter into the Domain ID 1 and Domain ID 2 text boxes. Fill in the boxes and click the Calculate Shortest Path button, and you see the following fields: Hop Count The number of hops from none node to the next along the displayed route, where a node can be either a UM Router or a TRD. Aggregate Cost A sum of the cost values of all portals along the displayed path. Path A display of the UM Router and TRD hops listed in route order from the starting TRD to the ending TRD. 7.2 UM Router Log Messages 7.2 139 UM Router Log Messages The UM Router daemon generates log messages that are used to monitor its health and operation. You can configure these to be directed to "console" (standard output), "syslog", or a specified log "file", via the configuration element. Normally "console" is only used during testing, as a persistent log file is preferred for production use. The UM Router does not over-write log files on startup, but instead appends them. 7.2.1 UM Router Rolling Logs To prevent unbounded disk file growth, the UM Router supports rolling log files. When the log file rolls, the file is renamed according to the model: CONFIGUREDNAME_PID.DATE.SEQNUM where: • CONFIGUREDNAME - Root name of log file, as configured by user. • PID - Process ID of the UM Router daemon process. • DATE - Date that the log file was rolled, in YYYY-MM-DD format. • SEQNUM - Sequence number, starting at 1 when the process starts, and incrementing each time the log file rolls. For example: umrouterlog_9867.2017-08-20.2 The user can configure when the log file is eligible to roll over by either or both of two criteria: size and frequency. The size criterion is in millions of bytes. The frequency criterion can be daily or hourly. Once one or both criteria are met, the next message written to the log will trigger a roll operation. These criteria are supplied as attributes to the configuration element. If both criteria are supplied, then the first one to be reached will trigger a roll. For example, consider the setting: store.log Let say that the log file grows at 1 million bytes per hour. At 11:00 pm, the log file will reach 23 million bytes, and will roll. Then, at 12:00 midnight, the log file will roll again, even though it is only 1 million bytes in size. Note The rolling logs cannot be configured to automatically overwrite old logs. Thus, the amount of disk space consumed by log files will grow without bound. The user must implement a desired process of archiving or deleting older log files according to the user's preference. 7.2.2 Important UM Router Log Messages Connection Failure Messages peer portal [name] failed to connect to peer at [IP:port] via [interface] [err]: reason peer portal [name] failed to accept connection (accept) [err]: reason Lost Connection Messages 140 peer peer peer peer UM Router Monitoring portal portal portal portal [name] [name] [name] [name] lost connection to peer at [IP:port] via [interface] connection destroyed due to socket failure detected dropped inbound connection (read) [err]: reason detected dropped inbound connection (zero-len read) Endpoint Messages If a UMP store is adjacent to the UM Router, and the UM Router has been restarted, you typically see messages of the form: endpoint portal [name] has no forwarding entry for destination ctxinst [string], dropping msg (lbmc cntl ume) These messages are normal, and cease when the UM Router has established the forwarding information for the given context. Peer Messages Acceptor: peer portal [name] received connection from [IP:port] Initiator: peer portal [name] connected to [IP:port ] 7.3 UM Router Transport Stats Using theelement in a UM Router's XML configuration file and the UMS Monitoring feature, you can monitor the transport activity between the UM Router and its Topic Resolution Domain. The configuration also provides Context and Event Queue statistics. The statistics output identifies individual portals by name. Chapter 8 UM Router Glossary Access Control List (ACL) A portal configuration you can use to filter out messages based on a variety of criteria. forwarding cost A value assigned to a portal to help determine best-path routing selection. UM Router keepalive Control messages exchanged between UM Routers to confirm that UM Routers are still running. Interest Message Control messages exchanged between UM Routers to confirm that UM Routers are still running. Originating Transport ID (OTID) Unique identifier of a message's transport session at the originating source. portal A TCP/IP interface (socket) on a UM Router through which the UM Router passes data. Endpoint portals interface TRDs, and peer portals interface peer portals of other UM Routers. Topic Resolution Domain (TRD) The realm of UDP multicast or unicast connectivity that allows UM topic resolution to occur. Blocking of this UDP connectivity (for example, by a firewall or a restrictive WAN link) defines a TRD's boundaries. Contexts within a TRD must have the same topic resolution configuration option settings (multicast group IP address/port and resolver interface full or CIDR address). Use Query A periodic control message distributed to all members of a TRD to verify the continued presence of receivers for a given topic or pattern. web monitor A web-based real-time UM Router statistics and configuration display. 142 UM Router Glossary Chapter 9 Comparison to Pre-6.0 UM Gateway With the release of Ultra Messaging 6.0, the UM Gateway feature is discontinued and replaced by the Ultra Messaging Dynamic Routing Option (also referred to as the UM Router). The UM Router's primary improvement over the UM Gateway is its ability to intelligently select efficient traffic routes from multiple path choices on a dynamic topic-by-topic basis. Note This release of the UM Router is not backward compatible with earlier versions of the UM Gateway in the sense that you cannot have UM Routers and UM Gateways in the same network. 9.1 Added Features and Differences In addition to routing functionality, the following are features of the UM Router that were not provided in the UM Gateway: • Multi-path, ring, or mesh topologies • Interoperability with MIM and Persistence (see UM Feature Compatibility for complete feature interoperability information) • Ability to restart the UM Router within a transport's activity timeout period • Reduced topic resolution traffic via more efficient use of Use Queries and Use Query Responses • The default value for the portal is 1 (one). 0 (zero) is not a valid cost value. • The UM Router daemon (tnwgd) logs version information on startup. • Compression and/or encryption may now be applied to peer links. The following configuration options exist in the UM Router but not the UM Gateway. See XML Configuration Reference for more information on these options. • (as a child) • • • 144 Comparison to Pre-6.0 UM Gateway • • • • • • • • • •
Source Exif Data:
File Type : PDF File Type Extension : pdf MIME Type : application/pdf PDF Version : 1.5 Linearized : No Page Count : 144 Page Mode : UseOutlines Author : Title : Subject : Creator : LaTeX with hyperref package Producer : pdfTeX-1.40.16 Create Date : 2018:05:09 13:21:49-05:00 Modify Date : 2018:05:09 13:21:49-05:00 Trapped : False PTEX Fullbanner : This is pdfTeX, Version 3.14159265-2.6-1.40.16 (TeX Live 2015) kpathsea version 6.2.1EXIF Metadata provided by EXIF.tools