Package org.logevents.observers.slack

Class SlackLogEventsFormatter

java.lang.Object

org.logevents.observers.slack.SlackLogEventsFormatter

All Implemented Interfaces:

JsonLogEventsBatchFormatter

Direct Known Subclasses:

SlackAlertOnlyFormatter

public class SlackLogEventsFormatter
extends Object
implements JsonLogEventsBatchFormatter

Formats log event batches for suitable display on Slack. Writes the most important log event as messages text and creates attachments for MDCs, Markers, Level etc. Inherit to create your own slack experience.

Field Summary

Fields

Modifier and Type	Field	Description
protected Optional<String>	channel
protected Optional<String>	detailUrl
protected Optional<String>	iconEmoji
protected Optional<String>	username

Constructor Summary

Constructors

Constructor	Description
SlackLogEventsFormatter()
SlackLogEventsFormatter(Map<String,String> properties, String prefix)
SlackLogEventsFormatter(Optional<String> username, Optional<String> channel)
SlackLogEventsFormatter(Configuration configuration)

Method Summary

Modifier and Type	Method	Description
protected String	bold(String s)
void	configureSourceCode(Configuration configuration)
protected List<Map<String,Object>>	createAttachments(LogEventBatch batch)	Override this method to customize the contents of messages to Slack
protected Map<String,Object>	createDetailsAttachment(LogEvent event)
protected List<Map<String,Object>>	createDetailsField(LogEvent event)
protected Map<String,Object>	createMdcAttachment(LogEvent event)
Map<String,Object>	createMessage(LogEventBatch batch)
protected Map<String,Object>	createStackTraceAttachment(LogEvent event)
protected String	createText(LogEvent event)	Override this method to customize the contents of messages to Slack
protected Map<String,Object>	createThrottledEventsAttachment(LogEventBatch batch)
protected String	detailLink(LogEvent event, String url)
protected String	formatMessage(LogEvent logEvent)
protected String	getColor(org.slf4j.event.Level level)
void	setChannel(Optional<String> channel)
void	setDetailUrl(Optional<String> detailUrl)
void	setIconEmoji(Optional<String> iconEmoji)
void	setMdcFilter(MdcFilter mdcFilter)
void	setPackageFilter(List<String> packageFilter)
void	setShowRepeatsIndividually(boolean showRepeatsIndividually)
void	setUsername(Optional<String> username)
protected Map<String,Object>	slackMessageField(String title, String value, boolean isShort)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

username

protected Optional<String> username

channel

protected Optional<String> channel

iconEmoji

protected Optional<String> iconEmoji

detailUrl

protected Optional<String> detailUrl

Constructor Detail

SlackLogEventsFormatter

public SlackLogEventsFormatter()

SlackLogEventsFormatter

public SlackLogEventsFormatter(Optional<String> username,
                               Optional<String> channel)

SlackLogEventsFormatter

public SlackLogEventsFormatter(Map<String,String> properties,
                               String prefix)

SlackLogEventsFormatter

public SlackLogEventsFormatter(Configuration configuration)

Method Detail

createMessage

public Map<String,Object> createMessage(LogEventBatch batch)

Specified by:

createMessage in interface JsonLogEventsBatchFormatter

createText

protected String createText(LogEvent event)

Override this method to customize the contents of messages to Slack

createAttachments

protected List<Map<String,Object>> createAttachments(LogEventBatch batch)

Override this method to customize the contents of messages to Slack

createMdcAttachment

protected Map<String,Object> createMdcAttachment(LogEvent event)

createThrottledEventsAttachment

protected Map<String,Object> createThrottledEventsAttachment(LogEventBatch batch)

formatMessage

protected String formatMessage(LogEvent logEvent)

getColor

protected String getColor(org.slf4j.event.Level level)

createDetailsAttachment

protected Map<String,Object> createDetailsAttachment(LogEvent event)

createDetailsField

protected List<Map<String,Object>> createDetailsField(LogEvent event)

detailLink

protected String detailLink(LogEvent event,
                            String url)

createStackTraceAttachment

protected Map<String,Object> createStackTraceAttachment(LogEvent event)

slackMessageField

protected Map<String,Object> slackMessageField(String title,
                                                     String value,
                                                     boolean isShort)

bold

protected String bold(String s)

setPackageFilter

public void setPackageFilter(List<String> packageFilter)

setUsername

public void setUsername(Optional<String> username)

setChannel

public void setChannel(Optional<String> channel)

setIconEmoji

public void setIconEmoji(Optional<String> iconEmoji)

setShowRepeatsIndividually

public void setShowRepeatsIndividually(boolean showRepeatsIndividually)

toString

public String toString()

Overrides:

toString in class Object

configureSourceCode

public void configureSourceCode(Configuration configuration)

setDetailUrl

public void setDetailUrl(Optional<String> detailUrl)

setMdcFilter

public void setMdcFilter(MdcFilter mdcFilter)