blob: 30fd9081ad3327c7f1655fe89ea41adfc81f08f7 (
plain)
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
|
# Copyright (C) 2017 MongoDB Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License, version 3,
# as published by the Free Software Foundation.
#
# 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
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
global:
cpp_namespace: "mongo"
imports:
- "mongo/idl/basic_types.idl"
enums:
MetricsEncoding:
description: "Metrics Encoding Methods"
type: string
values:
snappy: "snappy"
structs:
FreeMonRegistrationRequest:
description: "Registration Request to Cloud Server"
fields:
version:
description: "Protocol version, initial version is 1"
type: long
payload:
description: "Payload of registration information"
type: object
id:
description: "Existing Registration Id"
type: string
optional: true
localTime:
description: "Local time at registration send"
type: date
tags:
description: "Tags"
type: array<string>
optional: true
FreeMonRegistrationResponse:
description: "Registration Response from Cloud Server"
fields:
version:
description: "Protocol version, initial version is 1"
type: long
haltMetricsUploading:
description: "True indicates it should not proceed to metrics uploading"
type: bool
id:
description: "Existing Registration Id"
type: string
informationalURL:
description: "Informational HTTP web page for metrics"
type: string
message:
description: "Informational message for shell to display to user"
type: string
reportingInterval:
description: "Metrics Reporting interval in seconds"
type: long
userReminder:
description: "Informational message to display to user to remind them about the service"
type: string
optional: true
FreeMonMetricsRequest:
description: "Metrics Request to Cloud Server"
fields:
version:
description: "Protocol version, initial version is 1"
type: long
id:
description: "Registration Id"
type: string
localTime:
description: "Local time at metrics send"
type: date
encoding:
description: "Compression Encoding"
type: MetricsEncoding
metrics:
description: "Metrics Blob"
type: bindata_generic
# History
# -------
# Version 2 - added resendRegistration bool
#
FreeMonMetricsResponse:
description: "Metrics Response from Cloud Server"
fields:
version:
description: "Protocol version, initial version is 1"
type: long
haltMetricsUploading:
description: "True indicates it should not proceed to metrics uploading"
type: bool
permanentlyDelete:
description: "True indicates it permanently delete the local state"
type: bool
reportingInterval:
description: "Metrics Reporting interval in seconds"
type: long
id:
description: "Existing Registration Id"
type: string
optional: true
message:
description: "Informational message for shell to display to user"
type: string
optional: true
informationalURL:
description: "Informational HTTP web page for metrics"
type: string
optional: true
userReminder:
description: "Message to display to user to remind them about service"
type: string
optional: true
resendRegistration:
description: "If true, resend registration to server"
type: bool
optional: true
|
