Skip to content

Commit 527aae7

Browse files
mfhunruhmfhunruh
committed
feat: initial commit
Signed-off-by: Maksim Loviagin <[email protected]>
0 parents  commit 527aae7

File tree

14 files changed

+918
-0
lines changed

14 files changed

+918
-0
lines changed

‎.dockerignore‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
/.env
2+
/.helm
3+
/.gitignore
4+
/.gitlab-ci.yml
5+
/docker-compose.yaml
6+
/werf.yaml
7+
/main
8+
__debug_*

‎.github/workflows/build.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Build
2+
3+
on:
4+
push:
5+
tags:
6+
- "**"
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- uses: actions/checkout@v4
14+
15+
- name: Set up Go
16+
uses: actions/setup-go@v5
17+
with:
18+
go-version: 1.25
19+
20+
- name: Build
21+
run: |
22+
versionflags="-X main.appVersion=${{ github.ref_name }}"
23+
for GOOS in linux; do
24+
for GOARCH in amd64 arm64; do
25+
export GOOS GOARCH
26+
CGO_ENABLED=0 go build -v -a -tags netgo -ldflags="-extldflags '-static' -s -w $versionflags" -o build/rediskey-${GOOS}-${GOARCH} cmd/rediskey/main.go
27+
done
28+
done
29+
cd build; sha256sum * > sha256sums.txt
30+
31+
- name: Release
32+
uses: softprops/action-gh-release@v1
33+
with:
34+
generate_release_notes: true
35+
token: ${{ secrets.GITHUB_TOKEN }}
36+
files: |
37+
build/*

‎.github/workflows/docker.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Docker Image
2+
3+
on:
4+
push:
5+
tags:
6+
- "**"
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- uses: actions/checkout@v4
14+
15+
- name: Docker meta
16+
id: meta
17+
uses: docker/metadata-action@v5
18+
with:
19+
images: ghcr.io/${{ github.repository }}
20+
tags: |
21+
type=schedule
22+
type=ref,event=branch
23+
type=ref,event=pr
24+
type=semver,pattern={{version}}
25+
type=semver,pattern={{major}}.{{minor}}
26+
type=semver,pattern={{major}}
27+
type=sha
28+
29+
- name: Set up Docker Buildx
30+
id: buildx
31+
uses: docker/setup-buildx-action@v3
32+
33+
- name: Login to Github Packages
34+
uses: docker/login-action@v3
35+
with:
36+
registry: ghcr.io
37+
username: ${{ github.repository_owner }}
38+
password: ${{ secrets.GITHUB_TOKEN }}
39+
40+
- name: Set build date
41+
run: echo "BUILD_DATE=$(date +%Y%m%d%H%M)" >> $GITHUB_ENV
42+
43+
- name: Build and push
44+
uses: docker/build-push-action@v5
45+
with:
46+
context: .
47+
build-args: |
48+
versionflags=-X 'main.appVersion=${{ github.ref_name }}'
49+
push: ${{ github.event_name != 'pull_request' }}
50+
tags: ${{ steps.meta.outputs.tags }}
51+
labels: ${{ steps.meta.outputs.labels }}

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
/main
2+
/.env
3+
__debug_*

‎Dockerfile‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
ARG GO_VERSION=1.25.4
2+
3+
# STAGE 1: building the executable
4+
FROM docker.io/library/golang:${GO_VERSION}-alpine AS build
5+
6+
WORKDIR /src
7+
8+
COPY ./ ./
9+
10+
# Build the executable
11+
RUN CGO_ENABLED=0 go build \
12+
-installsuffix 'static' \
13+
-o /rediskey ./cmd/rediskey
14+
15+
# STAGE 2: build the container to run
16+
FROM scratch AS final
17+
18+
LABEL org.opencontainers.image.authors="Maksim Loviagin <[email protected]>"
19+
LABEL org.opencontainers.image.documentation="https://github.com/flant/rediskey"
20+
LABEL org.opencontainers.image.source="https://github.com/flant/rediskey"
21+
LABEL org.opencontainers.image.vendor="Flant"
22+
LABEL org.opencontainers.image.licenses="Apache-2.0"
23+
LABEL org.opencontainers.image.description="RedisKey is a lightweight Prometheus exporter that exposes numerical Redis key values as metrics."
24+
25+
COPY --from=build /rediskey /rediskey
26+
27+
# Copy CA certificates
28+
COPY --from=build /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
29+
30+
USER 101
31+
32+
ENTRYPOINT ["/rediskey"]

‎LICENSE.txt‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2025 Flant JSC
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Redis Key Exporter (RedisKey)
2+
3+
RedisKey is a lightweight Prometheus exporter that exposes numerical Redis key values (via GET *key*) or the number of items in the Redis list key (via LLEN *key*) as metrics.
4+
It connects to Redis using either a standalone host or Redis Sentinel and periodically refreshes metrics at a configurable interval.
5+
6+
Each Redis key you specify becomes a Prometheus gauge metric, and the exporter also provides an internal error counter
7+
to help monitor failures when fetching or parsing Redis values.
8+
9+
## Requirements
10+
11+
```
12+
- Go >= 1.25.4
13+
```
14+
15+
## Installation
16+
17+
```sh
18+
$ git clone https://github.com/flant/rediskey.git
19+
$ cd rediskey
20+
$ go build cmd/rediskey/main.go
21+
$ sudo install -m 755 main /usr/local/bin/rediskey
22+
```
23+
24+
## Configuration
25+
26+
RedisKey is configured entirely through environment variables. Below is the full list of supported variables:
27+
28+
| Variable | Required | Default | Description |
29+
| ---------------------- | -------- | -------------- | ---------------------------------------- |
30+
| `RKE_LISTEN_ADDRESS` | No | `0.0.0.0:8080` | Address and port where RedisKey listens. |
31+
| `RKE_REDIS_DB` | No | `0` | Redis database number to connect to. |
32+
| `RKE_REDIS_KEYS_GET` | No | *none* | Comma-separated list of Redis keys to monitor via GET. Only keys with a numerical value are supported. |
33+
| `RKE_REDIS_KEYS_LLEN` | No | *none* | Comma-separated list of Redis keys to monitor via LLEN. |
34+
| `RKE_REDIS_HOST` | No | *none* | Standalone Redis host and port in the format host:port. Ignored if sentinels are set. |
35+
| `RKE_REDIS_PASSWORD` | No | *none* | Password for Redis authentication, if required. |
36+
| `RKE_REDIS_SENTINELS` | No | *none* | Comma-separated list of Redis Sentinel addresses in the format host1:port,host2:port. |
37+
| `RKE_REDIS_MASTER_NAME`| No | `mymaster` | Master name for Sentinel mode. |
38+
| `RKE_METRICS_PATH` | No | `/metrics` | HTTP path where Prometheus metrics are exposed. |
39+
| `RKE_REFRESH_INTERVAL` | No | `10` | Interval in seconds between metric refreshes from Redis. |
40+
41+
## Running RedisKey
42+
43+
### 1. Set required environment variables
44+
45+
These are the minimum variables needed to run RedisKey:
46+
47+
```sh
48+
$ export RKE_REDIS_HOST="rfrm-redis:6379"
49+
$ export RKE_REDIS_KEYS_GET="queue.message_id"
50+
$ export RKE_REDIS_KEYS_LLEN="queue.waiting"
51+
```
52+
53+
### 2. Start the exporter
54+
55+
```sh
56+
$ rediskey
57+
2025/11/28 19:11:57 Starting Redis Key Exporter...
58+
2025/11/28 19:11:57 Listening on 0.0.0.0:8080/metrics
59+
```

0 commit comments

Comments
 (0)