Skip to content
This repository was archived by the owner on Dec 24, 2022. It is now read-only.

Commit cdb26de

Browse files
committed
Add API docs to RedisStats
1 parent 0e79417 commit cdb26de

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

src/ServiceStack.Redis/RedisStats.cs

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,66 +5,107 @@ namespace ServiceStack.Redis
55
{
66
public static class RedisStats
77
{
8+
/// <summary>
9+
/// Number of times the Redis Client Managers have FailoverTo() either by sentinel or manually
10+
/// </summary>
811
public static long TotalFailovers
912
{
1013
get { return Interlocked.Read(ref RedisState.TotalFailovers); }
1114
}
1215

16+
/// <summary>
17+
/// Number of times a Client was deactivated from the pool, either by FailoverTo() or exceptions on client
18+
/// </summary>
1319
public static long TotalDeactivatedClients
1420
{
1521
get { return Interlocked.Read(ref RedisState.TotalDeactivatedClients); }
1622
}
1723

24+
/// <summary>
25+
/// Number of times connecting to a Sentinel has failed
26+
/// </summary>
1827
public static long TotalFailedSentinelWorkers
1928
{
2029
get { return Interlocked.Read(ref RedisState.TotalFailedSentinelWorkers); }
2130
}
2231

32+
33+
/// <summary>
34+
/// Number of times we've forced Sentinel to failover to another master due to
35+
/// consecutive errors beyond sentinel.WaitBeforeForcingMasterFailover
36+
/// </summary>
2337
public static long TotalForcedMasterFailovers
2438
{
2539
get { return Interlocked.Read(ref RedisState.TotalForcedMasterFailovers); }
2640
}
2741

42+
/// <summary>
43+
/// Number of times a connecting to a reported Master wasn't actually a Master
44+
/// </summary>
2845
public static long TotalInvalidMasters
2946
{
3047
get { return Interlocked.Read(ref RedisState.TotalInvalidMasters); }
3148
}
3249

50+
/// <summary>
51+
/// Number of times no Masters could be found in any of the configured hosts
52+
/// </summary>
3353
public static long TotalNoMastersFound
3454
{
3555
get { return Interlocked.Read(ref RedisState.TotalNoMastersFound); }
3656
}
3757

58+
/// <summary>
59+
/// Number of Redis Client instances created with RedisConfig.ClientFactory
60+
/// </summary>
3861
public static long TotalClientsCreated
3962
{
4063
get { return Interlocked.Read(ref RedisState.TotalClientsCreated); }
4164
}
4265

66+
/// <summary>
67+
/// Number of times a Redis Client was created outside of pool, either due to overflow or reserved slot was overridden
68+
/// </summary>
4369
public static long TotalClientsCreatedOutsidePool
4470
{
4571
get { return Interlocked.Read(ref RedisState.TotalClientsCreatedOutsidePool); }
4672
}
4773

74+
/// <summary>
75+
/// Number of times Redis Sentinel reported a Subjective Down (sdown)
76+
/// </summary>
4877
public static long TotalSubjectiveServersDown
4978
{
5079
get { return Interlocked.Read(ref RedisState.TotalSubjectiveServersDown); }
5180
}
5281

82+
/// <summary>
83+
/// Number of times Redis Sentinel reported an Objective Down (sdown)
84+
/// </summary>
5385
public static long TotalObjectiveServersDown
5486
{
5587
get { return Interlocked.Read(ref RedisState.TotalObjectiveServersDown); }
5688
}
5789

90+
/// <summary>
91+
/// Number of times a Redis Request was retried due to Socket or Retryable exception
92+
/// </summary>
5893
public static long TotalRetryCount
5994
{
6095
get { return Interlocked.Read(ref RedisState.TotalRetryCount); }
6196
}
6297

98+
/// <summary>
99+
/// Number of times a Request succeeded after it was retried
100+
/// </summary>
63101
public static long TotalRetrySuccess
64102
{
65103
get { return Interlocked.Read(ref RedisState.TotalRetrySuccess); }
66104
}
67105

106+
/// <summary>
107+
/// Number of times a Retry Request failed after exceeding RetryTimeout
108+
/// </summary>
68109
public static long TotalRetryTimedout
69110
{
70111
get { return Interlocked.Read(ref RedisState.TotalRetryTimedout); }

0 commit comments

Comments
 (0)