-
Notifications
You must be signed in to change notification settings - Fork 31
/
xmatters.go
201 lines (188 loc) · 8.99 KB
/
xmatters.go
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
/**
* @license
* Copyright 2020 Dynatrace LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package notifications
import (
"encoding/json"
"github.com/dynatrace-oss/terraform-provider-dynatrace/terraform/hcl"
"github.com/dynatrace-oss/terraform-provider-dynatrace/dynatrace/xjson"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
)
// XMattersConfig Configuration of the xMatters notification.
type XMattersConfig struct {
BaseNotificationConfig
URL string `json:"url"` // The URL of the xMatters WebHook.
AcceptAnyCertificate bool `json:"acceptAnyCertificate"` // Accept any, including self-signed and invalid, SSL certificate (`true`) or only trusted (`false`) certificates.
Headers []*HTTPHeader `json:"headers,omitempty"` // A list of the additional HTTP headers.
Payload string `json:"payload"` // The content of the message. You can use the following placeholders: * `{ImpactedEntities}`: Details about the entities impacted by the problem in form of a JSON array. * `{ImpactedEntity}`: The entity impacted by the problem or *X* impacted entities. * `{PID}`: The ID of the reported problem. * `{ProblemDetailsHTML}`: All problem event details, including root cause, as an HTML-formatted string. * `{ProblemDetailsJSON}`: All problem event details, including root cause, as a JSON object. * `{ProblemDetailsMarkdown}`: All problem event details, including root cause, as a [Markdown-formatted](https://www.markdownguide.org/cheat-sheet/) string. * `{ProblemDetailsText}`: All problem event details, including root cause, as a text-formatted string. * `{ProblemID}`: The display number of the reported problem. * `{ProblemImpact}`: The [impact level](https://www.dynatrace.com/support/help/shortlink/impact-analysis) of the problem. Possible values are `APPLICATION`, `SERVICE`, and `INFRASTRUCTURE`. * `{ProblemSeverity}`: The [severity level](https://www.dynatrace.com/support/help/shortlink/event-types) of the problem. Possible values are `AVAILABILITY`, `ERROR`, `PERFORMANCE`, `RESOURCE_CONTENTION`, and `CUSTOM_ALERT`. * `{ProblemTitle}`: A short description of the problem. * `{ProblemURL}`: The URL of the problem within Dynatrace. * `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. * `{Tags}`: The list of tags that are defined for all impacted entities, separated by commas.
}
func (me *XMattersConfig) GetType() Type {
return Types.Xmatters
}
func (me *XMattersConfig) Schema() map[string]*schema.Schema {
return map[string]*schema.Schema{
"name": {
Type: schema.TypeString,
Description: "The name of the notification configuration",
Required: true,
},
"active": {
Type: schema.TypeBool,
Description: "The configuration is enabled (`true`) or disabled (`false`)",
Required: true,
},
"alerting_profile": {
Type: schema.TypeString,
Description: "The ID of the associated alerting profile",
Required: true,
},
"unknowns": {
Type: schema.TypeString,
Description: "allows for configuring properties that are not explicitly supported by the current version of this provider",
Optional: true,
},
"url": {
Type: schema.TypeString,
Description: "The URL of the xMatters WebHook",
Required: true,
},
"accept_any_certificate": {
Type: schema.TypeBool,
Description: "Accept any, including self-signed and invalid, SSL certificate (`true`) or only trusted (`false`) certificates",
Required: true,
},
"header": {
Type: schema.TypeSet,
Optional: true,
Description: "A list of the additional HTTP headers",
Elem: &schema.Resource{Schema: new(HTTPHeader).Schema()},
},
"payload": {
Type: schema.TypeString,
Description: "The content of the notification message. You can use the following placeholders: * `{ImpactedEntities}`: Details about the entities impacted by the problem in form of a JSON array. * `{ImpactedEntity}`: The entity impacted by the problem or *X* impacted entities. * `{PID}`: The ID of the reported problem. * `{ProblemDetailsHTML}`: All problem event details, including root cause, as an HTML-formatted string. * `{ProblemDetailsJSON}`: All problem event details, including root cause, as a JSON object. * `{ProblemDetailsMarkdown}`: All problem event details, including root cause, as a [Markdown-formatted](https://www.markdownguide.org/cheat-sheet/) string. * `{ProblemDetailsText}`: All problem event details, including root cause, as a text-formatted string. * `{ProblemID}`: The display number of the reported problem. * `{ProblemImpact}`: The [impact level](https://www.dynatrace.com/support/help/shortlink/impact-analysis) of the problem. Possible values are `APPLICATION`, `SERVICE`, and `INFRASTRUCTURE`. * `{ProblemSeverity}`: The [severity level](https://www.dynatrace.com/support/help/shortlink/event-types) of the problem. Possible values are `AVAILABILITY`, `ERROR`, `PERFORMANCE`, `RESOURCE_CONTENTION`, and `CUSTOM_ALERT`. * `{ProblemTitle}`: A short description of the problem. * `{ProblemURL}`: The URL of the problem within Dynatrace. * `{State}`: The state of the problem. Possible values are `OPEN` and `RESOLVED`. * `{Tags}`: The list of tags that are defined for all impacted entities, separated by commas",
Required: true,
},
}
}
func (me *XMattersConfig) MarshalHCL(properties hcl.Properties) error {
if err := properties.Unknowns(me.Unknowns); err != nil {
return err
}
if err := properties.Encode("name", me.Name); err != nil {
return err
}
if err := properties.Encode("active", me.Active); err != nil {
return err
}
if err := properties.Encode("alerting_profile", me.AlertingProfile); err != nil {
return err
}
if err := properties.Encode("accept_any_certificate", me.AcceptAnyCertificate); err != nil {
return err
}
if err := properties.Encode("header", me.Headers); err != nil {
return err
}
if err := properties.Encode("payload", me.Payload); err != nil {
return err
}
if err := properties.Encode("url", me.URL); err != nil {
return err
}
return nil
}
func (me *XMattersConfig) UnmarshalHCL(decoder hcl.Decoder) error {
if value, ok := decoder.GetOk("unknowns"); ok {
if err := json.Unmarshal([]byte(value.(string)), me); err != nil {
return err
}
if err := json.Unmarshal([]byte(value.(string)), &me.Unknowns); err != nil {
return err
}
delete(me.Unknowns, "name")
delete(me.Unknowns, "active")
delete(me.Unknowns, "alertingProfile")
delete(me.Unknowns, "acceptAnyCertificate")
delete(me.Unknowns, "header")
delete(me.Unknowns, "payload")
delete(me.Unknowns, "url")
if len(me.Unknowns) == 0 {
me.Unknowns = nil
}
}
if value, ok := decoder.GetOk("name"); ok {
me.Name = value.(string)
}
if value, ok := decoder.GetOk("active"); ok {
me.Active = value.(bool)
}
if value, ok := decoder.GetOk("accept_any_certificate"); ok {
me.AcceptAnyCertificate = value.(bool)
}
if value, ok := decoder.GetOk("alerting_profile"); ok {
me.AlertingProfile = value.(string)
}
if err := decoder.DecodeSlice("header", &me.Headers); err != nil {
return err
}
if value, ok := decoder.GetOk("payload"); ok {
me.Payload = value.(string)
}
if value, ok := decoder.GetOk("url"); ok {
me.URL = value.(string)
}
return nil
}
func (me *XMattersConfig) MarshalJSON() ([]byte, error) {
properties := xjson.NewProperties(me.Unknowns)
if err := properties.MarshalAll(map[string]any{
"id": me.ID,
"name": me.Name,
"type": me.GetType(),
"active": me.Active,
"alertingProfile": me.AlertingProfile,
"acceptAnyCertificate": me.AcceptAnyCertificate,
"headers": me.Headers,
"payload": me.Payload,
"url": me.URL,
}); err != nil {
return nil, err
}
return json.Marshal(properties)
}
func (me *XMattersConfig) UnmarshalJSON(data []byte) error {
properties := xjson.Properties{}
if err := json.Unmarshal(data, &properties); err != nil {
return err
}
if err := properties.UnmarshalAll(map[string]any{
"id": &me.ID,
"name": &me.Name,
"type": &me.Type,
"active": &me.Active,
"alertingProfile": &me.AlertingProfile,
"acceptAnyCertificate": &me.AcceptAnyCertificate,
"headers": &me.Headers,
"payload": &me.Payload,
"url": &me.URL,
}); err != nil {
return err
}
if len(properties) > 0 {
me.Unknowns = properties
}
return nil
}