Add adj-rib-in llgr-stale flag
[bgpcep.git] / docs / pcep / pcep-user-guide-session-statistics.rst
1 .. _pcep-user-guide-session-statistics:
2
3 Session statistics
4 ==================
5 The PCEP statistics provides information about PCE <-> PCC session and its stateful listener (topology-provider).
6
7 Usage
8 '''''
9
10 **URL:** ``/restconf/operational/network-topology:network-topology/topology/pcep-topology/node/pcc:%2F%2F43.43.43.43/pcep-session-state``
11
12 **Method:** ``GET``
13
14 **Response Body:**
15
16 .. code-block:: xml
17    :linenos:
18    :emphasize-lines: 3,4,5,6,7,8,9,10,13,14,15,16,19,20,21,22,25,26,27,28,31,32,33,35,36,37
19
20    <pcep-session-state xmlns="urn:opendaylight:params:xml:ns:yang:topology:pcep:stats">
21       <messages>
22          <last-received-rpt-msg-timestamp xmlns="urn:opendaylight:params:xml:ns:yang:pcep:stateful:stats">1512640592</last-received-rpt-msg-timestamp>
23          <sent-upd-msg-count xmlns="urn:opendaylight:params:xml:ns:yang:pcep:stateful:stats">0</sent-upd-msg-count>
24          <received-rpt-msg-count xmlns="urn:opendaylight:params:xml:ns:yang:pcep:stateful:stats">2</received-rpt-msg-count>
25          <sent-init-msg-count xmlns="urn:opendaylight:params:xml:ns:yang:pcep:stateful:stats">0</sent-init-msg-count>
26          <sent-msg-count>0</sent-msg-count>
27          <last-sent-msg-timestamp>0</last-sent-msg-timestamp>
28          <unknown-msg-received>0</unknown-msg-received>
29          <received-msg-count>2</received-msg-count>
30          <error-messages>
31             <last-sent-error></last-sent-error>
32             <received-error-msg-count>0</received-error-msg-count>
33             <sent-error-msg-count>0</sent-error-msg-count>
34             <last-received-error></last-received-error>
35          </error-messages>
36          <reply-time>
37             <average-time>0</average-time>
38             <min-time>0</min-time>
39             <max-time>0</max-time>
40          </reply-time>
41       </messages>
42       <peer-pref>
43          <keepalive>30</keepalive>
44          <deadtimer>120</deadtimer>
45          <ip-address>127.0.0.1</ip-address>
46          <session-id>0</session-id>
47       </peer-pref>
48       <local-pref>
49          <keepalive>30</keepalive>
50          <deadtimer>120</deadtimer>
51          <ip-address>127.0.0.1</ip-address>
52          <session-id>0</session-id>
53       </local-pref>
54       <peer-capabilities>
55          <stateful xmlns="urn:opendaylight:params:xml:ns:yang:pcep:stateful:stats">true</stateful>
56          <instantiation xmlns="urn:opendaylight:params:xml:ns:yang:pcep:stateful:stats">true</instantiation>
57          <active xmlns="urn:opendaylight:params:xml:ns:yang:pcep:stateful:stats">true</active>
58       </peer-capabilities>
59       <session-duration>0:00:00:18</session-duration>
60       <delegated-lsps-count>1</delegated-lsps-count>
61       <synchronized>true</synchronized>
62    </pcep-session-state>
63
64 @line 3: **last-received-rpt-msg-timestamp** - The timestamp of last received PCRpt message.
65
66 @line 4: **sent-upd-msg-count** - The number of sent PCUpd messages.
67
68 @line 5: **received-rpt-msg-count** - The number of received PcRpt messages.
69
70 @line 6: **sent-init-msg-count** - The number of sent PCInitiate messages.
71
72 @line 7: **sent-msg-count** - Total number of sent PCEP messages.
73
74 @line 8: **last-sent-msg-timestamp** - The timestamp of last sent message.
75
76 @line 9: **unknown-msg-received** - The number of received unknown messages.
77
78 @line 10: **received-msg-count** - Total number of received PCEP messages.
79
80 @line 13: **last-sent-error** - Type/value tuple of last sent error.
81
82 @line 14: **received-error-msg-count** - Total number of received PCErr messages.
83
84 @line 15: **sent-error-msg-count** - Total number of sent PCErr messages.
85
86 @line 16: **last-received-error** - Type/value tuple of last sent error.
87
88 @line 19: **keepalive** - Advertised keep-alive value.
89
90 @line 20: **deadtimer** - Advertised deadtimer value.
91
92 @line 21: **ip-address** - Peer's IP address.
93
94 @line 22: **session-id** - Peer's session identifier.
95
96 @line 25: **keepalive** - Advertised keep-alive value.
97
98 @line 26: **deadtimer** - Advertised deadtimer value.
99
100 @line 27: **ip-address** - Peer's IP address.
101
102 @line 28: **session-id** - Peer's session identifier.
103
104 @line 31: **stateful** - Represents peer's stateful/stateless capability.
105
106 @line 32: **instantiation** - Represents peer's instantiation capability.
107
108 @line 33: **active** - Represents peer's LSP update capability.
109
110 @line 35: **session-duration** - Elapsed time (in d:H:m:s) from session-up until last statistic update.
111
112 @line 36: **delegated-lsps-count** - The number of delegated LSPs (tunnels) from PCC.
113
114 @line 37: **synchronized** - Represents synchronization status.