kibana-alert-exporter

command module
v0.0.0-...-11e42d3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 18, 2024 License: MIT Imports: 1 Imported by: 0

README

Kibana Alert Exporter

codecov Docker Pulls

Overview

Kibana Alert Exporter is a tool designed to export alerts from Kibana. It provides a simple interface to interact with Kibana's alerting API and retrieve alert data.

Features

  • Export alerts from Kibana - Supports multiple alert types - Easy integration with CI/CD pipelines

Installation

Using Docker

You can pull the Docker image from Docker Hub:

docker pull schmiddim/kibana-alert-exporter 

From Source

To build and run the project from source, ensure you have Go installed and run the following commands:

git clone https://github.com/schmiddim/kibana-alert-exporter.git 
cd kibana-alert-exporter 
go build -o kibana-alert-exporter 
./kibana-alert-exporter 

Usage

Command Line

Run the exporter with the following command:

export KIBANA_URL=<KIBANA_URL>
exporter API_KEY=<API_KEY>
./kibana-alert-exporter --kibana-url <KIBANA_URL> --api-key <API_KEY> 

Docker

Run the Docker container with the necessary environment variables:

docker run -e KIBANA_URL=<KIBANA_URL> -e API_KEY=<API_KEY> schmiddim/kibana-alert-exporter 

Helm Chart

To deploy the exporter using Helm, use the following commands:

helm repo add schmiddim https://schmiddim.github.io/helm-charts/
helm repo update
helm upgrade kibana-alert-exporter schmiddim/kibana-alert-exporter --install

Configuration

The following environment variables can be set to configure the exporter:

  • KIBANA_URL: The URL of the Kibana instance.
  • API_KEY: The API key for authenticating with Kibana.

Development

Running Tests

To run the tests, use the following command:

go test ./... 

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL