Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Discord notifier: Add username and avatar_url #4081

Merged
merged 4 commits into from
Oct 24, 2024
Merged

Discord notifier: Add username and avatar_url #4081

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4bfbecb
Feat(discord):
featheredtoast Oct 23, 2024
155e76e
Merge branch 'main' into discord-username-avatar
gotjosh Oct 24, 2024
6e1f76b
Test the new fields
gotjosh Oct 24, 2024
a769cf3
These are not templeatable strings
gotjosh Oct 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions config/notifiers.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,9 +251,11 @@ type DiscordConfig struct {
WebhookURL *SecretURL `yaml:"webhook_url,omitempty" json:"webhook_url,omitempty"`
WebhookURLFile string `yaml:"webhook_url_file,omitempty" json:"webhook_url_file,omitempty"`

Content string `yaml:"content,omitempty" json:"content,omitempty"`
Title string `yaml:"title,omitempty" json:"title,omitempty"`
Message string `yaml:"message,omitempty" json:"message,omitempty"`
Content string `yaml:"content,omitempty" json:"content,omitempty"`
Title string `yaml:"title,omitempty" json:"title,omitempty"`
Message string `yaml:"message,omitempty" json:"message,omitempty"`
Username string `yaml:"username,omitempty" json:"username,omitempty"`
AvatarURL string `yaml:"avatar_url,omitempty" json:"avatar_url,omitempty"`
}

// UnmarshalYAML implements the yaml.Unmarshaler interface.
Expand Down
6 changes: 6 additions & 0 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -886,6 +886,12 @@ webhook_url_file: <filepath>
# Message content template. Limited to 2000 characters.
[ content: <tmpl_string> | default = '{{ template "discord.default.content" . }}' ]

# Message username.
[ username: <string> | default = '' ]

# Message avatar URL.
[ avatar_url: <string> | default = '' ]

# The HTTP client's configuration.
[ http_config: <http_config> | default = global.http_config ]
```
Expand Down
18 changes: 15 additions & 3 deletions notify/discord/discord.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import (
"encoding/json"
"fmt"
"net/http"
netUrl "net/url"
"os"
"strings"

Expand Down Expand Up @@ -76,8 +77,10 @@ func New(c *config.DiscordConfig, t *template.Template, l log.Logger, httpOpts .
}

type webhook struct {
Content string `json:"content"`
Embeds []webhookEmbed `json:"embeds"`
Content string `json:"content"`
Embeds []webhookEmbed `json:"embeds"`
Username string `json:"username,omitempty"`
AvatarURL string `json:"avatar_url,omitempty"`
}

type webhookEmbed struct {
Expand Down Expand Up @@ -145,14 +148,23 @@ func (n *Notifier) Notify(ctx context.Context, as ...*types.Alert) (bool, error)
}

w := webhook{
Content: content,
Content: content,
Username: n.conf.Username,
Embeds: []webhookEmbed{{
Title: title,
Description: description,
Color: color,
}},
}

if len(n.conf.AvatarURL) != 0 {
if _, err := netUrl.Parse(n.conf.AvatarURL); err == nil {
w.AvatarURL = n.conf.AvatarURL
} else {
level.Warn(n.logger).Log("msg", "Bad avatar url", "key", key)
}
}

var payload bytes.Buffer
if err = json.NewEncoder(&payload).Encode(w); err != nil {
return false, err
Expand Down
4 changes: 3 additions & 1 deletion notify/discord/discord_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,8 @@ func TestDiscord_Notify(t *testing.T) {
Title: "Test Title",
Message: "Test Message",
Content: "Test Content",
Username: "Test Username",
AvatarURL: "http://example.com/avatar.png",
}

// Create a new Discord notifier
Expand All @@ -227,5 +229,5 @@ func TestDiscord_Notify(t *testing.T) {
require.NoError(t, err)
require.False(t, ok)

require.Equal(t, "{\"content\":\"Test Content\",\"embeds\":[{\"title\":\"Test Title\",\"description\":\"Test Message\",\"color\":10038562}]}\n", resp)
require.Equal(t, "{\"content\":\"Test Content\",\"embeds\":[{\"title\":\"Test Title\",\"description\":\"Test Message\",\"color\":10038562}],\"username\":\"Test Username\",\"avatar_url\":\"http://example.com/avatar.png\"}\n", resp)
}
Loading