Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gree/superexporter
Extend memcached_exporter interface to support multiple remote target pattern
https://github.com/gree/superexporter
memcached prometheus prometheus-exporter
Last synced: about 2 months ago
JSON representation
Extend memcached_exporter interface to support multiple remote target pattern
- Host: GitHub
- URL: https://github.com/gree/superexporter
- Owner: gree
- License: apache-2.0
- Created: 2022-09-09T11:41:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-28T18:04:49.000Z (about 2 years ago)
- Last Synced: 2023-04-11T17:40:43.720Z (over 1 year ago)
- Topics: memcached, prometheus, prometheus-exporter
- Language: Go
- Homepage:
- Size: 56.6 KB
- Stars: 8
- Watchers: 4
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Superexporter provides the multi-target pattern for other exporters
Superexporter is a super server for [memcached_exporter](https://github.com/prometheus/memcached_exporter) to support the multi-target pattern.
You can scrape multiple memcahed metrics from a single superexporter endpoint by specifying the target in a query parameter.
It is designed for multiple remote targets, such as SaaS managed memcached (GCP Memorystore, AWS Elasticache).
## How it works
Superexporter dynamically forks exporters for requested targets and acts as a HTTP proxy to them.
```
\_ /bin/superexporter
\_ /path/to/memcached_exporter --memcached.address memcached-host-a:11211 --web.listen-address localhost:45123
\_ /path/to/memcached_exporter --memcached.address memcached-host-b:11211 --web.listen-address localhost:45321
\_ /path/to/memcached_exporter --memcached.address memcached-host-c:11211 --web.listen-address localhost:46123
```
```mermaid
sequenceDiagram
participant prometheus
participant superexporter
participant memcached_exporter
Note right of memcached_exporter: exporter for memcached-host-N
prometheus->>superexporter: GET /scrape?target=memcached-host-N:11211
superexporter->>memcached_exporter: proxy
Note right of superexporter: fork & exec exporter if not exist
memcached_exporter-->>superexporter: respond metrics
superexporter-->>prometheus: respond metrics
```
And it cleans up child exporters that have not been requested for several minutes.
## Running the exporter
### Docker image
```
docker run -p 9150:9150 ghcr.io/gree/superexporter:latest
```
To verify:
```
curl 'localhost:9150/scrape?target=your-memcached-host:11211'
```
### Pre-built binary
Pre-built binary is available at [the releases](https://github.com/gree/superexporter/releases).
### Build from source
#### Prerequisite
The superexporter needs the memcached_exporter executable in PATH.
You can find the released binaries on https://github.com/prometheus/memcached_exporter/releases.
#### Build and run
```
$ which memcached_exporter
/some/path/to/memcached_exporter
$ make
$ ./superexporter
```
To verify:
```
curl 'localhost:9150/scrape?target=your-memcached-host:11211'
```
### Prometheus configuration for multiple memcached hosts
Use `GET superexporter-host:9150/scrape` endpoint with `target=` parameter like [redis_exporter](https://github.com/oliver006/redis_exporter#prometheus-configuration-to-scrape-multiple-redis-hosts).
An example with `static_configs` is here:
```
- job_name: memcached
metrics_path: /scrape
static_configs:
- targets
- memcached-host-a:11211
- memcached-host-b:11211
- memcached-host-c:11211
relabel_configs:
- source_labels: [__address__]
target_label: __param_target
- source_labels: [__param_target]
target_label: instance
- target_label: __address__
replacement: superexporter-host:9150
## config for scraping the superexporter itself
- job_name: superexporter
metrics_path: /metrics
static_configs:
- targets
- superexporter-host:9150
```
Of course, you can use other `xxx_sd_config`s. For example, this is for the case for `file_sd_config`.
```
- job_name: memcached
metrics_path: /scrape
file_sd_configs:
- files:
- target-memcached-instances.json
relabel_configs:
- source_labels: [__address__]
target_label: __param_target
- source_labels: [__param_target]
target_label: instance
- target_label: __address__
replacement: superexporter-host:9150
## config for scraping the superexporter itself
- job_name: superexporter
metrics_path: /metrics
static_configs:
- targets
- superexporter-host:9150
```
Where `target-memcached-instances.json` is the following content:
```
[
{
"targets": [ "memcached-host-a:11211", "memcached-host-b:11211", "memcached-host-c:11211" ],
"labels": { }
}
]
```