https://github.com/hartfordfive/eck-escluster-eru-limit-exporter

A basic prometheus exporter to expose a limit for a list of ECK-provisioned Elasticsearch clusters
https://github.com/hartfordfive/eck-escluster-eru-limit-exporter

Last synced: about 8 hours ago
JSON representation

A basic prometheus exporter to expose a limit for a list of ECK-provisioned Elasticsearch clusters

• Host: GitHub
• URL: https://github.com/hartfordfive/eck-escluster-eru-limit-exporter
• Owner: hartfordfive
• License: mit
• Created: 2023-02-04T21:49:20.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-06T16:22:17.000Z (almost 2 years ago)
• Last Synced: 2024-06-21T20:40:58.676Z (5 months ago)
• Language: Go
• Size: 9.77 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# ECK Elasticsearch Cluster ERU Limit Exporter

## Description

## Usage

Running the server:

```

./eck-escluster-eru-limit-exporter -conf /path/to/config.yaml [-debug] [-version] [-validate]

```

## Command Flags

`-conf` : The path to the configuration file to be used

`-debug` : Enable debug mode

`-version` : Show version and exit

`-validate` : Validate configuration and exit

*A sample configuration can be found in the `examples/` directory.*

## Available endpoints

* **GET /cluster-limit?cluster=**

    * Return the ERU limit for the specified `cluster` in bytes

* **GET /metrics**

    * Return the list of prometheus metrics for the exporter

* **GET /healthz**

    *  Return the current health status of the exporter

* **GET /config**

    * Return the current config which has been used to start the exporter

* **GET /debug/profile**

    * Generate a debugging profile.  See [here](https://go.dev/blog/pprof) for more details.

## Building

### 1. Checkout required code version

First, ensure you have checked out the proper release tag in order to get all files/dependencies corresponding to that version. 

### 2. Build Go binary

Run `make build` to build the the binary for the current operatory system or run `make build-all` to build for both Linux and OSX.   Refer to the makefile for additional options.

### 3. Build Docker container

Run the following docker command to build the image

```

docker build -t eck-escluster-eru-limit-exporter:$(cat VERSION.txt) --build-arg VERSION=$(cat VERSION.txt) .

```

## License

Covered under the [MIT license](LICENSE.md).

## Author

Alain Lefebvre