Skip to content
This repository was archived by the owner on Apr 2, 2024. It is now read-only.

Commit 3e5e64e

Browse files
committed
Improve docs for installing with extension
1 parent 3db9232 commit 3e5e64e

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,12 @@ basis (e.g. via CRON). We recommend executing it every 30 minutes.
7979
This is necessary to execute data retention policies according to the configured policy.
8080
This is set up automatically in helm.
8181

82+
We also recommend running this with a Timescaledb installation that includes the `timescale_prometheus_extra`
83+
Postgres extension. While this isn't a requirement, it does optimize certain queries.
84+
A docker image of Timescaledb with the extension is available at on Docker Hub at
85+
[`timescaledev/timescale_prometheus_extra:latest-pg12`](https://hub.docker.com/r/timescaledev/timescale_prometheus_extra).
86+
Instructions on how to compile and install the extension are in the extensions [README](extension/Readme.md).
87+
8288
### Binaries
8389

8490
You can download pre-built binaries for the Timescale-Prometheus Connector [on our release page](https://github.com/timescale/timescale-prometheus/releases).
@@ -88,6 +94,9 @@ You can download pre-built binaries for the Timescale-Prometheus Connector [on o
8894
A docker image for the Timescale-Prometheus Connector is available
8995
on Docker Hub at [timescale/timescale-prometheus](https://hub.docker.com/r/timescale/timescale-prometheus/).
9096

97+
A docker image of timescaledb with the `timescale_prometheus_extra` extension is available at on Docker Hub at
98+
[`timescaledev/timescale_prometheus_extra:latest-pg12`](https://hub.docker.com/r/timescaledev/timescale_prometheus_extra).
99+
91100
## Non-Helm Configuration
92101

93102
### Configuring Prometheus to use this remote storage connector

extension/Readme.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,13 @@
33
This [Postgres extension](https://www.postgresql.org/docs/12/extend-extensions.html)
44
contains support functions to improve the performance of Timescale-Prometheus.
55
While Timescale-Prometheus will run without it, adding this extension will
6-
cause it perform better.
6+
cause it to perform better.
77

88
## Installation ##
99

10-
The extension is installed by default on the timescale-prometheus docker image,
11-
and will be installed automatically by timescale-prometheus, if it has
12-
permission.
10+
The extension is installed by default on the
11+
[`timescaledev/timescale_prometheus_extra:latest-pg12`](https://hub.docker.com/r/timescaledev/timescale_prometheus_extra) docker image.
12+
13+
To compile and install from source run: `make && make install`.
14+
15+
This extension will be installed automatically by the timescale-prometheus connector.

0 commit comments

Comments
 (0)