https://github.com/snapp-incubator/thanos-federate-proxy
A proxy to add `/federate` to Thanos monitoring
https://github.com/snapp-incubator/thanos-federate-proxy
golang observability oss prometheus proxy snappcloud thanos
Last synced: about 2 months ago
JSON representation
A proxy to add `/federate` to Thanos monitoring
- Host: GitHub
- URL: https://github.com/snapp-incubator/thanos-federate-proxy
- Owner: snapp-incubator
- License: apache-2.0
- Created: 2021-09-07T04:04:36.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-01T08:12:25.000Z (11 months ago)
- Last Synced: 2024-12-01T09:23:03.213Z (11 months ago)
- Topics: golang, observability, oss, prometheus, proxy, snappcloud, thanos
- Language: Go
- Homepage:
- Size: 110 KB
- Stars: 34
- Watchers: 3
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Thanos Federate Proxy
A proxy to convert `/federate` queries to `/v1/api/query` and respond in open metrics format.
The most common use case for this proxy is to be used as a side car with [Thanos](https://github.com/thanos-io/thanos), to provide `/federate` api for thanos (currently Thanos does not support it). So this way you can add Thanos as a federation source in another prometheus. Also Thanos does not support remote write (Note that being able to write metrics remotely from thanos to another prometheus is a different concept than thanos receiver component).
## Usage
### Docker
```bash
sudo docker run -p 9099:9099 ghcr.io/snapp-incubator/thanos-federate-proxy:main -insecure-listen-address="0.0.0.0:9099"
```
### Binary releases
```bash
export VERSION=0.1.0
wget https://github.com/snapp-incubator/thanos-federate-proxy/releases/download/v${VERSION}/thanos-federate-proxy-${VERSION}.linux-amd64.tar.gz
tar xvzf thanos-federate-proxy-${VERSION}.linux-amd64.tar.gz thanos-federate-proxy-${VERSION}.linux-amd64/thanos-federate-proxy
```
### From source
```sh
git clone https://github.com/snapp-incubator/thanos-federate-proxy
cd thanos-federate-proxy && go build
./thanos-federate-proxy
```
## Configuration
Flags:
```text
-insecure-listen-address string
The address which proxy listens on (default "127.0.0.1:9099")
-tlsSkipVerify
Skip TLS Verfication (default false)
-upstream string
The upstream thanos URL (default "http://127.0.0.1:9090")
-bearer-file string
Path to file containing Authorization bearer token, if needed.
-force-get
Force prometheus api.Client to use GET requests instead of POST (default false)
```
Sample k8s deployment (as a side car with thanos or prometheus):
```yml
containers:
...
- name: thanos-federate-proxy
image: ghcr.io/snapp-incubator/thanos-federate-proxy:main
args:
- -insecure-listen-address=0.0.0.0:9099
- -upstream=http://127.0.0.1:9090
ports:
- containerPort: 9099
name: fedproxy
protocol: TCP
```
Sample prometheus config for federation:
```yml
scrape_configs:
- job_name: 'thanos-federate'
scrape_timeout: 1m
metrics_path: '/federate'
params:
'match[]':
- 'up{namespace=~"perfix.*"}'
static_configs:
- targets:
- 'thanos.svc.cluster:9099'
```
## Limitations
The following limitations will be addressed in future releases (see [Roadmap](#roadmap)):
- You can not pass empty matcher to prometheus for scraping all the metrics (see [this prometheus issue](https://github.com/prometheus/prometheus/issues/2162)). A workaround is to use the following matcher:
```yml
'match[]':
- '{__name__=~".+"}'
```
Note that `{__name__=~".*"}` won't also work and you should use `".+"` instead of `".*"`.
## Roadmap
- [x] test federation
- [x] tlsSkipVerify flag
- [x] Dockerfile
- [x] Github actions
- [x] metrics
- [x] support multiple matchers
- [ ] support empty matchers
- [ ] support store-API for better performance
- [ ] return error message instead of only logging it (??)
- [ ] remove space after comma in metrics (causing no issues)
- [ ] make query timeouts configurable
- [ ] add markdown lint to CI
## Metrics
| Metric | Notes |
| -------------------------------------------------- | ---------------------------------------------------------------- |
| thanosfederateproxy_scrape_duration_seconds_count | Total number of scrape requests with response code |
| thanosfederateproxy_scrape_duration_seconds_sum | Duration of scrape requests with response code |
| thanosfederateproxy_scrape_duration_seconds_bucket | Count of scrape requests per bucket (for calculating percentile) |
## Changelog
See [CHANGELOG.md](./CHANGELOG.md)
## Security
### Reporting security vulnerabilities
If you find a security vulnerability or any security related issues, please DO NOT file a public issue, instead send your report privately to cloud@snapp.cab. Security reports are greatly appreciated and we will publicly thank you for it.
## License
Apache-2.0 License, see [LICENSE](LICENSE).