Alert handlers through API

sloach · April 3, 2017, 8:08pm

In Kapacitor, I want to create a slack alert handler through the CLI or API. This seems to apply ok but I can’t get alerts and I get this in the logs:

[alert] 2017/04/03 19:49:50 E! failed to send event to Slack service is not enabled
[net_alert:alert2] 2017/04/03 19:49:50 E! failed to send event to Slack service is not enabled

Is it possible to specify alerts without configuring them in the config file? Any idea what I might be missing? I did have “enabled”: true in my alert handler definition.

jackzampolin · April 4, 2017, 1:22am

@sloach This feature was just added to kapacitor. There is some documentation of the API here.

sloach · April 4, 2017, 7:13pm

Right, the problem I’m having is it doesn’t seem to work. I can setup my alert handler through Kapacitor and it looks fine, but I get that error message I pasted in my original post.

sloach · April 17, 2017, 2:50pm

I spent some more time looking into this. It seems that only part of the handler config is exposed through the API. For Slack, the channel, username, and icon-emoji are exposed through the API, but the URL and enabled flat and other config is not.

Can anyone explain the reason for this? I was hoping to be able to use multiple different slack handlers with different destinations but it looks like I might have to use multiple instances of Kapacitor to achieve this.

jackzampolin · April 17, 2017, 3:12pm

@sloach I dont think thats the case. Can you post where you are seeing that?

sloach · April 17, 2017, 3:45pm

In the Handle() function, you can see that it only sends the Handle, Channel and IconEmoji from the HandlerConfig:

github.com

influxdata/kapacitor/blob/master/services/slack/service.go#L202


      
          // slack attachment info
          type attachment struct {
          	Fallback  string   `json:"fallback"`
          	Color     string   `json:"color"`
          	Text      string   `json:"text"`
          	Mrkdwn_in []string `json:"mrkdwn_in"`
          }
          
          
type testOptions struct {
          	Workspace string      `json:"workspace"`
          	Channel   string      `json:"channel"`
          	Message   string      `json:"message"`
          	Level     alert.Level `json:"level"`
          	Username  string      `json:"username"`
          	IconEmoji string      `json:"icon-emoji"`
          }
          
          
func (s *Service) TestOptions() interface{} {
          	c, _ := s.config("")
          	return &testOptions{
          		Workspace: c.Workspace,

And, in fact, that is all that exists for the HandlerConfig:

github.com

influxdata/kapacitor/blob/master/services/slack/service.go#L174


      
          				if err != nil {
          					return err
          				}
          			} else {
          				s.workspaces[conf.Workspace].Update(conf)
          			}
          
          
			// We'll stash the default workspace with the empty string as a key.
          			// Either there's a single config with no workspace name, or else
          			// we have multiple configs that all have names.
          			if conf.Default && conf.Workspace != "" {
          				s.workspaces[""] = s.workspaces[conf.Workspace]
          			}
          		} else {
          			return fmt.Errorf("expected config object to be of type %T, got %T", v, conf)
          		}
          	}
          	return nil
          }
          
          
func (s *Service) Global() bool {

The enabled flag, URL, etc come from the config file but it doesn’t seem to be possible to specify these in the Handler object via the CLI/API.

github.com

influxdata/kapacitor/blob/master/services/slack/config.go

package slack

import (
	"net/url"

	"github.com/influxdata/kapacitor/listmap"
	"github.com/pkg/errors"
)

const DefaultUsername = "kapacitor"

type Config struct {
	// Whether Slack integration is enabled.
	Enabled bool `toml:"enabled" override:"enabled"`
	// Whether this is the default slack config.
	Default bool `toml:"default" override:"default"`
	// ID assigned if multiple slack configs are given
	Workspace string `toml:"workspace"  override:"workspace"`
	// The Slack webhook URL.
	// For new-style slack apps, use "https://slack.com/api/chat.postMessage".

This file has been truncated. show original

Happy to be corrected if I am missing something.

nathaniel · April 17, 2017, 9:36pm

Yeah there are two different configs.

The configuration for the Slack service itself.
The config for each handler.

The Slack service config is set via the kapacitor.conf file or via the /kapacitor/v1/config/slack API endpoint.

The handlers config doesn’t effect the aspects of the service itself. This is because the handlers consume the service, meaning you can have multiple Slack handlers to that go to different channels etc, but they all use the same Slack service.

Topic		Replies	Views
API for exec handlers? Kapacitor kapacitor	0	390	July 18, 2020
Error in log kapacitor, please solution for solve	0	2672	August 20, 2018
No kapacitor messages sent to Alerta Kapacitor	6	1215	April 17, 2017
Handler per sevirity kapacitor	5	689	August 8, 2018
How to debug Kapacitor Alert? kapacitor	8	5173	November 12, 2019

Alert handlers through API

Related topics