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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
/**
* Copyright (C) 2022-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 "mongo/db/pipeline/document_source.h"
#include "mongo/db/pipeline/lite_parsed_document_source.h"
#include "mongo/db/query/telemetry.h"
#include "mongo/util/producer_consumer_queue.h"
namespace mongo {
using namespace telemetry;
class DocumentSourceTelemetry final : public DocumentSource {
public:
static constexpr StringData kStageName = "$telemetry"_sd;
class LiteParsed final : public LiteParsedDocumentSource {
public:
static std::unique_ptr<LiteParsed> parse(const NamespaceString& nss,
const BSONElement& spec);
LiteParsed(std::string parseTimeName, bool applyHmacToIdentifiers, std::string hmacKey)
: LiteParsedDocumentSource(std::move(parseTimeName)),
_applyHmacToIdentifiers(applyHmacToIdentifiers),
_hmacKey(hmacKey) {}
stdx::unordered_set<NamespaceString> getInvolvedNamespaces() const override {
return stdx::unordered_set<NamespaceString>();
}
PrivilegeVector requiredPrivileges(bool isMongos,
bool bypassDocumentValidation) const override {
return {Privilege(ResourcePattern::forClusterResource(), ActionType::telemetryRead)};
;
}
bool allowedToPassthroughFromMongos() const final {
// $telemetry must be run locally on a mongod.
return false;
}
bool isInitialSource() const final {
return true;
}
void assertSupportsMultiDocumentTransaction() const {
transactionNotSupported(kStageName);
}
bool _applyHmacToIdentifiers;
std::string _hmacKey;
};
static boost::intrusive_ptr<DocumentSource> createFromBson(
BSONElement elem, const boost::intrusive_ptr<ExpressionContext>& pExpCtx);
virtual ~DocumentSourceTelemetry() = default;
StageConstraints constraints(
Pipeline::SplitState = Pipeline::SplitState::kUnsplit) const override {
StageConstraints constraints{StreamType::kStreaming,
PositionRequirement::kFirst,
HostTypeRequirement::kLocalOnly,
DiskUseRequirement::kNoDiskUse,
FacetRequirement::kNotAllowed,
TransactionRequirement::kNotAllowed,
LookupRequirement::kNotAllowed,
UnionRequirement::kNotAllowed};
constraints.requiresInputDocSource = false;
constraints.isIndependentOfAnyCollection = true;
return constraints;
}
boost::optional<DistributedPlanLogic> distributedPlanLogic() final {
return boost::none;
}
const char* getSourceName() const override {
return kStageName.rawData();
}
Value serialize(SerializationOptions opts = SerializationOptions()) const final override;
void addVariableRefs(std::set<Variables::Id>* refs) const final {}
private:
DocumentSourceTelemetry(const boost::intrusive_ptr<ExpressionContext>& expCtx,
bool applyHmacToIdentifiers = false,
std::string hmacKey = {})
: DocumentSource(kStageName, expCtx),
_applyHmacToIdentifiers(applyHmacToIdentifiers),
_hmacKey(hmacKey) {}
GetNextResult doGetNext() final;
/**
* The current partition materialized as a set of Document instances. We pop from the queue and
* return DocumentSource results.
*/
std::deque<Document> _materializedPartition;
/**
* Iterator over all telemetry partitions. This is incremented when we exhaust the current
* _materializedPartition.
*/
TelemetryStore::PartitionId _currentPartition = -1;
// When true, apply hmac to field names from returned query shapes.
bool _applyHmacToIdentifiers;
/**
* Key used for SHA-256 HMAC application on field names.
*/
std::string _hmacKey;
};
} // namespace mongo
|
