summaryrefslogtreecommitdiff
path: root/src/mongo/db/free_mon/free_mon_protocol.idl
blob: 7f24df4b08540fa3fe29c7b8961c34ec35f2b58b (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
137
138
139
140
141
142
143
144
145
146
147
148
149
# 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.
#
global:
    cpp_namespace: "mongo"

imports:
    - "mongo/db/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