Splunk Plugin

Maintainer: @dbejanishvili Co-Maintainers: @bakurits @Gvantsats

Splunk integration for mattermost. Enabling users to get logs and alerts from splunk server. To learn more about Mattermost plugins, see Mattermost plugin documentation.

Table of Contents

• License
• System Admin Instructions
  • Plugin Setup
• User Instructions
  • Slash Commands
• Developer/Contributor Instructions
  • Setting Up Environment
  • Building And Deployment

License

This repository is licensed under the Apache 2.0 License.

For Mattermost System Admins

Plugin Setup

You can install the plugin from mattermost plugin marketplace, or follow the instructions given in Building And Deployment section

For Users

Slash Commands

• Authenticate user - use /splunk auth --login [server base url] [username/token] you must be logged into the system before you use any slash commands regarding logging. To authenticate the user you can use this slash command with two required parameters Splunk server base URL, Splunk username, or token. If you already logged in to a plugin with a token, the second and next logins can be done with username too. After successful authentication this message is shown:

  

• Get list of all logs from server - use /splunk log --list this slash command returns list of all available logs from splunk server.

  

• Get specific log from server - use /splunk log [logname] to get specific log from server you can use this slash command.

  

• Subscribe to alerts - use /splunk alert --subscribe to subsribe to alerts you must first use this slash command and add link for splunk

  

  after receiving alert splunk bot posts in the channel that new alert is received.

  

• Help! - use /splunk help command, to see how to properly use slash commands

For Developers And Contributors

Setting Up Environment

Fork the repository to your own account and then clone it to a directory outside of $GOPATH matching your plugin name:

git clone https://github.com/owner/mattermost-plugin-splunk

Note that this project uses Go modules. Be sure to locate the project outside of $GOPATH, or allow the use of Go modules within your $GOPATH with an export GO111MODULE=on.

Building And Deployment

To build your plugin use make

Use make check-style to check the style.

Use make debug-dist and make debug-deploy in place of make dist and make deploy to configure webpack to generate unminified Javascript.

make will produce a single plugin file (with support for multiple architectures) for upload to your Mattermost server:

dist/com.example.my-plugin.tar.gz

Alternatively you can deploy a plugin automatically to your server, but it requires login credentials:

export MM_SERVICESETTINGS_SITEURL=http://localhost:8065
export MM_ADMIN_USERNAME=admin
export MM_ADMIN_PASSWORD=password
make deploy

or configuration of a personal access token:

export MM_SERVICESETTINGS_SITEURL=http://localhost:8065
export MM_ADMIN_TOKEN=j44acwd8obn78cdcx7koid4jkr
make deploy

In production, deploy and upload your plugin via the System Console.