summaryrefslogtreecommitdiff
path: root/src/mongo/db/process_health/health_monitoring_server_parameters.idl
blob: 33120033e35dfa2c5ae0c3a9ca42a38fde2e92ef (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
#
# 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.
#

# Feature flag for fault facet support.

global:
    cpp_namespace: "mongo"

imports:
    - "mongo/idl/basic_types.idl"

enums:
    HealthObserverIntensity:
        description: "Enum representing the intensity of a health observer."
        type: string
        values:
            kOff: "off"
            kCritical: "critical"
            kNonCritical: "non-critical"

    HealthObserverType:
        description: "Enum representing available health observer types"
        type: string
        values:
            kLdap: "ldap"
            kDns: "dns"
            kTest: "test"

structs:
    HealthObserverIntensitySetting:
        description: "One health observer intensity setting"
        strict: true
        fields:
            type:
                type: HealthObserverType
                optional: false
            intensity:
                type: HealthObserverIntensity
                optional: false
                default: kOff

    HealthObserverIntensities:
        description: "A struct representing the health observer intensities."
        strict: false
        fields:
            values:
                description: "Array of health observer intensity settings"
                type: array<HealthObserverIntensitySetting>
                optional: true

    HealthObserverIntervalSetting:
        description: "One health observer check interval setting, in milliseconds"
        strict: true
        fields:
            type:
                type: HealthObserverType
                optional: false
            interval:
                type: int
                optional: false
                validator: { gt: 0 }

    HealthObserverIntervals:
        description: "A struct representing the interval in milliseconds for each health observer."
        strict: true
        fields:
            values:
                description: "Array of health observer intervals settings"
                type: array<HealthObserverIntervalSetting>
                optional: true
            
    HealthObserverProgressMonitorConfig:
        description: "A struct representing configuration for health observer liveness checks." 
        strict: true
        fields:
            interval:
                description: "Interval between liveness checks in milliseconds."
                type: int
                default: 50
                validator: { gt: 0 }
            deadline:
                description: "Deadline for liveness checks, after which process should exit, in seconds."
                type: int
                default: 300
                validator: { gt: 0 }

server_parameters:
    healthMonitoringIntensities:
        set_at: ["startup", "runtime"]
        description: "A server parameter for specifying the intensity of fault facets."
        cpp_class:
            name: "HealthMonitoringIntensitiesServerParameter"
            data: "synchronized_value<HealthObserverIntensities>"
            override_set: true

    progressMonitor:
        set_at: ["startup", "runtime"]
        description: "A server parameter for specifying intervals for health monitoring."
        cpp_class:
            name: "HealthMonitoringProgressMonitorServerParameter"
            data: "synchronized_value<HealthObserverProgressMonitorConfig>"
            override_set: true

    healthMonitoringIntervals:
        set_at: [startup, runtime]
        description: "A server parameter for specifying the interval in milliseconds between health checks."
        cpp_class:
            name: "PeriodicHealthCheckIntervalsServerParameter"
            data: "synchronized_value<HealthObserverIntervals>"
            override_set: true

    activeFaultDurationSecs:
        description: "A server parameter for specifying the duration after which we transition to active fault."
        set_at: [startup, runtime]
        cpp_vartype: AtomicWord<int>
        cpp_varname: gActiveFaultDurationSecs
        default:
            expr: 120
        validator:
            gte: 0