https://github.com/kashalls/kromgo

Easily expose preconfigured prometheus metrics to the outside using badges.
https://github.com/kashalls/kromgo

go kubernetes prometheus promql

Last synced: 27 days ago
JSON representation

Easily expose preconfigured prometheus metrics to the outside using badges.

• Host: GitHub
• URL: https://github.com/kashalls/kromgo
• Owner: kashalls
• Created: 2023-12-15T03:57:59.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-09-09T07:19:04.000Z (2 months ago)
• Last Synced: 2024-09-10T05:55:05.448Z (2 months ago)
• Topics: go, kubernetes, prometheus, promql
• Language: Go
• Homepage:
• Size: 174 KB
• Stars: 62
• Watchers: 2
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Kromgo

A simple go project that allows you to expose prometheus metrics "safely" to a public source. Uses the official prometheus go api client. Better than exposing a grafana image rendering instance to the WWW.

It allows you to define your own metric names and your own prometheus queries as long as they return a single value at the end. There is config support to allow you to format the response with strings before and after the value.

You can use [shields.io](https://shields.io) and use either the [Dynamic JSON Badge](https://shields.io/badges/dynamic-json-badge) or the [Endpoint Badge](https://shields.io/badges/endpoint-badge) and add dynamic coloring with ranges you set.

[Config Example](./config.yaml.example)

[Configuration Structure](./cmd/kromgo/init/configuration/configuration.go)

- Reads configuration file from `/kromgo/config.yaml`

- Requires `PROMETHEUS_URL` be set in ENV.

- Optional `SERVER_PORT` to change server port.

## Performance

Queries take around 5ms ~ 75ms to complete depending on how many breaks my prometheus server takes. This was running on my [home-cluster](https://github.com/kashalls/home-cluster) and runs 3 instances, so depending on the query YMMV.

## Example Request

### Endpoint Response

This format is provided to support Shield.io's [Endpoint Badge](https://shields.io/badges/endpoint-badge) endpoint.

`HTTP GET localhost:8080/node_cpu_usage`

```json

{

    "color": "green",

    "label": "node_cpu_usage",

    "message": "17.5",

    "schemaVersion": 1

}

```

### Raw Response

`HTTP GET localhost:8080/node_cpu_usage?format=raw`

```json

[

    {

        "metric": {},

        "value": [

            1702664619.78,

            "17.5"

        ]

    }

]

```

### Badge Response

Like the `endpoint` format but serves an svg badge with `label` and `message`

`HTTP GET localhost:8080/node_cpu_usage?format=badge`

```

content-type: image/svg+xml