https://github.com/mattermost-community/mattermost-plugin-splunk
Mattermost plugin for Splunk
https://github.com/mattermost-community/mattermost-plugin-splunk
hacktoberfest mattermost mattermost-plugin
Last synced: 6 months ago
JSON representation
Mattermost plugin for Splunk
- Host: GitHub
- URL: https://github.com/mattermost-community/mattermost-plugin-splunk
- Owner: mattermost-community
- License: apache-2.0
- Created: 2020-08-30T19:29:05.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T22:55:16.000Z (11 months ago)
- Last Synced: 2025-04-14T12:14:18.730Z (6 months ago)
- Topics: hacktoberfest, mattermost, mattermost-plugin
- Language: Go
- Homepage:
- Size: 2.59 MB
- Stars: 2
- Watchers: 21
- Forks: 9
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mattermost Splunk Plugin
[](https://codecov.io/gh/mattermost/mattermost-plugin-splunk/branch/master)
[](https://goreportcard.com/report/github.com/mattermost/mattermost-plugin-splunk)
[](https://github.com/mattermost/mattermost-plugin-splunk/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22Up+For+Grabs%22+label%3A%22Help+Wanted%22)
**Maintainer:** [@dbejanishvili](https://github.com/dbejanishvili)
**Co-Maintainers:** [@bakurits](https://github.com/bakurits) [@Gvantsats](https://github.com/Gvantsats)
## Contents
- [Overview](#overview)
- [Installation](#installation)
- [End User Guide](#end-user-guide)
- [Contribute](#contribute)
- [Development](#development)
- [License](#license)
- [Get Help](#get-help)
- [Help Wanted](#help-wanted)
## Overview
A Splunk integration for Mattermost which enables users to get logs and alerts from Splunk server.
## Installation
You can download the [latest plugin binary release](https://github.com/mattermost/mattermost-plugin-splunk/releases) and upload it to your server via **System Console > Plugin Management**.
## End User Guide
- **Authenticate user**: Use ``/splunk auth login [server base url] [splunk username]/[token]``.
- You must be logged into the system before you can 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 future logins can be done by providing only the username too. The command is ``/splunk auth login [server base url] [splunk username]``.
- After successful authentication this message is shown:
- **Get a list of all logs from the Splunk server**: Use ``/splunk log list``.
- **Get specific log from server**: Use ``/splunk log [logname]``.
- **Subscribe to alerts**: Use ``/splunk alert subscribe``. Use this slash command and add a link for Splunk. After receiving the alert, the Splunk bot posts in the channel that new alert has been received.
## Contribute
This plugin contains both a server and web app portion. Read our documentation about the [Developer Workflow](https://developers.mattermost.com/extend/plugins/developer-workflow/) and [Developer Setup](https://developers.mattermost.com/extend/plugins/developer-setup/) for more information about developing and extending plugins.
## Development
### Set 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](https://github.com/golang/go/wiki/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`.
### Run a Splunk server with Docker
There is a [docker-compose.yml](https://github.com/mattermost/mattermost-plugin-splunk/blob/master/dev/docker-compose.yml) in the dev folder of the repository, configured to run a Splunk server for development. You can run make splunk in the root of the repository to spin up the Splunk server. The Splunk web application will be served at `http://localhost:8000` and the API will be served at `https://localhost:8089`.
The `SPLUNK_PASSWORD` environment variable is set to `SplunkPass`, as defined in the `docker-compose.yml` file. You can login with these credentials:
Username: `admin`
Password: `SplunkPass`
If you want to modify the default Alert hostname, you can do so editing the `default.yml` file and replace `` with your valid hostname (ex: `https://myhost.ngrok.io`).
### Build and deploy
To build your plugin use `make`, you can use `MM_DEBUG=1` as an envvar to generate a debug version of the plugin, including an unminified version of the Javascript webapp.
Use make `check-style` to check the style, use `make dist` and make deploy to build and deploy the application.
`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](https://developers.mattermost.com/integrate/reference/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 Mattermost System Console. See the [Mattermost Developer documentation](https://developers.mattermost.com/integrate/plugins/using-and-managing-plugins/) for details.
## License
This repository is licensed under the [Apache 2.0 License](https://github.com/mattermost/mattermost-plugin-splunk/blob/master/LICENSE).
## Get Help
For questions, suggestions, and help, visit the [Splunk Plugin channel](https://community.mattermost.com/core/channels/plugin-splunk) on our Community server. To report a bug, please open a GitHub issue.
## Help Wanted
If you're interested in joining our community of developers who contribute to Mattermost, check out the current set of issues that are being requested. You can also find issues labeled "Help Wanted" in the Jira repository that we have laid out the primary requirements for and could use some coding help from the community.