1 /*-
2  * See the file LICENSE for redistribution information.
3  *
4  * Copyright (c) 2002, 2014 Oracle and/or its affiliates.  All rights reserved.
5  *
6  */
7 
8 package com.sleepycat.je.rep.utilint;
9 
10 import com.sleepycat.je.utilint.StatDefinition;
11 
12 /**
13  * Per-stat Metadata for each BinaryProtocol statistics.
14  */
15 public class BinaryProtocolStatDefinition {
16 
17     public static final String GROUP_NAME = "BinaryProtocol";
18     public static final String GROUP_DESC =
19         "Network traffic due to the replication stream.";
20 
21     public static final StatDefinition N_READ_NANOS =
22         new StatDefinition
23         ("nReadNanos",
24          "The number of nanoseconds spent reading from the network channel.");
25 
26     public static final StatDefinition N_WRITE_NANOS =
27         new StatDefinition
28         ("nWriteNanos",
29          "The number of nanoseconds spent writing to the network channel.");
30 
31     public static final StatDefinition N_BYTES_READ =
32         new StatDefinition
33         ("nBytesRead",
34          "The number of bytes of Replication Stream read over the network. " +
35          "It does not include the TCP/IP overhead.");
36 
37     public static final StatDefinition N_MESSAGES_READ =
38         new StatDefinition
39         ("nMessagesRead",
40          "The number of Replication Stream messages read over the network.");
41 
42     public static final StatDefinition N_BYTES_WRITTEN =
43         new StatDefinition
44         ("nBytesWritten",
45          "The number of Replication Stream bytes written over the network.");
46 
47     public static final StatDefinition N_MESSAGES_WRITTEN =
48         new StatDefinition
49         ("nMessagesWritten",
50          "The total number of Replication Stream messages written over the " +
51          "network.");
52 
53     public static final StatDefinition N_MESSAGES_BATCHED =
54         new StatDefinition
55         ("nMessagesBatched",
56          "The number of Replication Stream messages that were batched " +
57          "into larger network level writes instead of being " +
58          "written individually (a subset of N_MESSAGES_WRITTEN.)");
59 
60     public static final StatDefinition N_MESSAGE_BATCHES =
61         new StatDefinition
62         ("nMessageBatches",
63          "The number of message batches written.");
64 
65     public static final StatDefinition MESSAGE_READ_RATE =
66         new StatDefinition
67         ("messagesReadPerSecond", "Incoming message throughput.");
68 
69     public static final StatDefinition MESSAGE_WRITE_RATE =
70         new StatDefinition
71         ("messagesWrittenPerSecond", "Outgoing message throughput.");
72 
73     public static final StatDefinition BYTES_READ_RATE =
74         new StatDefinition
75         ("bytesReadPerSecond", "Bytes read throughput.");
76 
77     public static final StatDefinition BYTES_WRITE_RATE =
78         new StatDefinition
79         ("bytesWrittenPerSecond", "Bytes written throughput.");
80 
81     public static final StatDefinition N_ACK_MESSAGES =
82         new StatDefinition
83         ("nAckMessages", "Count of all singleton ACK messages.");
84 
85     public static final StatDefinition N_GROUP_ACK_MESSAGES =
86         new StatDefinition
87         ("nGroupAckMessages", "Count of all group ACK messages.");
88 
89     public static final StatDefinition N_MAX_GROUPED_ACKS =
90         new StatDefinition
91         ("nMaxGroupedAcks", "Max number of acks sent via a single "
92             + "group ACK message.");
93 
94     public static final StatDefinition N_GROUPED_ACKS =
95         new StatDefinition
96         ("nGroupedAcks", "Sum of all acks sent via group ACK messages.");
97 
98     public static final StatDefinition N_ENTRIES_WRITTEN_OLD_VERSION =
99         new StatDefinition(
100             "nEntriesOldVersion",
101             "The number of messages containing log entries that were written" +
102             " to the replication stream using the previous log format, to" +
103             " support replication to a replica running an earlier version" +
104             " during an upgrade.");
105 }
106