https://github.com/1password/events-api-splunk

https://github.com/1password/events-api-splunk

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/1password/events-api-splunk
• Owner: 1Password
• Created: 2021-06-17T13:21:15.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-05T15:32:28.000Z (9 months ago)
• Last Synced: 2024-06-19T06:56:18.347Z (5 months ago)
• Language: Go
• Size: 2.08 MB
• Stars: 7
• Watchers: 12
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Events Reporting for Splunk

This repository contains code to integrate Splunk with 1Password's Events API. It includes a Splunk Add-on that meets Splunk's AppInspect requirements, binary source code, and make commands to build the project.

## Directory Structure

The top level directory only contains two files, this `README.md` and a `Makefile` which has all the commands to build the Splunk Add-on for various distributions as well as build the linux specific version for running the application locally in docker.

### src/

This folder contains the go source and dependency code used in the Splunk Add-on. Changing this source code will not be reflected in the Splunk Add-on until you recompile the source. Use the `make compile_app_binary` to accomplish this.

### app/

This folder contains the necessary Splunk configuration files and compiled go source code. See this folder's `README.md` to learn about running the Splunk add-on locally.

### builds/

This folder will contain the OS specific Add-ons, compressed to Splunk's distribution requirements as well as installation steps.

## Requirements

### Go

If you do not have `go` locally installed, you can find installation steps [here](https://golang.org/doc/install).

## Commands

- `make compile_app_binary`

  This command will update the Splunk Add-on, found in `app`, with any changes made from `src`.

- `make new_version`

  This command will update the JS portion of the Splunk Add-on to `Makefile VERSION` and build a release bundle for the web app.

- `make build_all_binaries build_all_apps` will first compile the `src` code to various Operating System distributions, and then bundle them with the Splunk specific configurations (found in `app`). The output will be found in `builds/bin`.