slacka

Documentation

Overview

Package slacka is a package to send alert to Slack App.

Index

• type Client
  • func New(userame, serviceName, iconURL string) *Client
  • func (c *Client) Debug(message string) error
  • func (c *Client) Debugf(format string, a ...interface{}) error
  • func (c *Client) Error(message string) error
  • func (c *Client) Errorf(format string, a ...interface{}) error
  • func (c *Client) Fatal(message string) error
  • func (c *Client) Fatalf(format string, a ...interface{}) error
  • func (c *Client) Info(message string) error
  • func (c *Client) Infof(format string, a ...interface{}) error
  • func (c *Client) Send(urlKey, message string, options ...WebhookOption) error
  • func (c *Client) SetErrorURL(url string)
  • func (c *Client) SetURL(key, url string)
  • func (c *Client) Warn(message string) error
  • func (c *Client) Warnf(format string, a ...interface{}) error
• type WebhookOption
  • func WebhookIconURL(iconURL string) WebhookOption
  • func WebhookUsername(username string) WebhookOption

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a client struct of slacka package.

func New

func New(userame, serviceName, iconURL string) *Client

New returns slacka client.

func (*Client) Debug

func (c *Client) Debug(message string) error

Debug sends a debug message to Slack Error Channel.

func (*Client) Debugf

func (c *Client) Debugf(format string, a ...interface{}) error

Debugf sends a debug message using format to Slack Error Channel.

func (*Client) Error

func (c *Client) Error(message string) error

Error sends a error message to Slack Error Channel.

func (*Client) Errorf

func (c *Client) Errorf(format string, a ...interface{}) error

Errorf sends a error message using format to Slack Error Channel.

func (*Client) Fatal

func (c *Client) Fatal(message string) error

Fatal sends a fatal message to Slack Error Channel. This method doesn't call os.Exit(1).

func (*Client) Fatalf

func (c *Client) Fatalf(format string, a ...interface{}) error

Fatalf sends a fatal message using format to Slack Error Channel. This method doesn't call os.Exit(1).

func (*Client) Info

func (c *Client) Info(message string) error

Info sends a info message to Slack Error Channel.

func (*Client) Infof

func (c *Client) Infof(format string, a ...interface{}) error

Infof sends a info message using format to Slack Error Channel.

func (*Client) Send

func (c *Client) Send(urlKey, message string, options ...WebhookOption) error

Send is a function to send message to Slack.

func (*Client) SetErrorURL

func (c *Client) SetErrorURL(url string)

SetErrorURL is a function to set Webhook URL for error alert to the client. If the error alert URL is already set, this function throws a panic.

func (*Client) SetURL

func (c *Client) SetURL(key, url string)

SetURL is a function to set Webhook URL to the client. If the key is already set, this function throws a panic.

func (*Client) Warn

func (c *Client) Warn(message string) error

Warn sends a warning message to Slack Error Channel.

func (*Client) Warnf

func (c *Client) Warnf(format string, a ...interface{}) error

Warnf sends a warn message using format to Slack Error Channel.

type WebhookOption

type WebhookOption func(*slack.WebhookMessage)

WebhookOption changes some parameters of the webhook message.

func WebhookIconURL

func WebhookIconURL(iconURL string) WebhookOption

WebhookIconURL changes icon url of the webhook message.

func WebhookUsername

func WebhookUsername(username string) WebhookOption

WebhookUsername changes username of the webhook message.