1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
/**
* Copyright (C) 2018-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the Server Side Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include <set>
#include <string>
#include <vector>
#include "mongo/base/status_with.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/shard_id.h"
namespace mongo {
class BSONObj;
class OperationContext;
/**
* This interface serves as means for obtaining data distribution and shard utilization statistics
* for the entire sharded cluster. Implementations may choose whatever means necessary to perform
* the statistics collection. There should be one instance of this object per service context.
*/
class ClusterStatistics {
ClusterStatistics(const ClusterStatistics&) = delete;
ClusterStatistics& operator=(const ClusterStatistics&) = delete;
public:
/**
* Structure, which describes the statistics of a single shard host.
*/
struct ShardStatistics {
public:
// hack so we do not accidentally miss code using MB
struct use_bytes_t {
explicit use_bytes_t() = default;
};
ShardStatistics(ShardId shardId,
uint64_t maxSizeBytes,
uint64_t currSizeBytes,
bool isDraining,
std::set<std::string> shardZones,
std::string mongoVersion,
use_bytes_t t);
ShardStatistics(ShardId shardId,
uint64_t maxSizeMB,
uint64_t currSizeMB,
bool isDraining,
std::set<std::string> shardZones,
std::string mongoVersion);
/**
* Returns true if a shard is not allowed to receive any new chunks because it has reached
* the per-shard data size limit.
*/
bool isSizeMaxed() const;
// The id of the shard for which this statistic applies
ShardId shardId;
// The maximum storage size allowed for the shard. Zero means no maximum specified.
uint64_t maxSizeBytes{0};
// The current storage size of the shard.
uint64_t currSizeBytes{0};
// Whether the shard is in draining mode
bool isDraining{false};
// Set of zones for the shard
std::set<std::string> shardZones;
// Version of mongod, which runs on this shard's primary
std::string mongoVersion;
};
virtual ~ClusterStatistics();
/**
* Retrieves a snapshot of the current shard utilization state. The implementation of this
* method may block if necessary in order to refresh its state or may return a cached value.
*/
virtual StatusWith<std::vector<ShardStatistics>> getStats(OperationContext* opCtx) = 0;
virtual StatusWith<std::vector<ShardStatistics>> getCollStats(OperationContext* opCtx,
NamespaceString const& ns) = 0;
protected:
ClusterStatistics();
};
} // namespace mongo
|
