@@ -50,18 +50,18 @@ natively supported by Grafana via the PostgreSQL/TimescaleDB datasource.
50
50
51
51
## Getting started with Helm (recommended)
52
52
53
- The quickest way to get started is by using the Helm chart from
54
- [ timescale-observability ] ( https://github.com/timescale/timescale-observability ) ,
55
- which provides a broader framework for installing an end-to-end
56
- monitoring stack.
53
+ The quickest way to get started is by using
54
+ [ The Observability Stack for Kubernetes (tobs) ] ( https://github.com/timescale/tobs ) ,
55
+ which provides a helm chart and CLI tool for installing an end-to-end
56
+ observability stack.
57
57
58
58
The following command will install Prometheus, TimescaleDB,
59
59
Timescale-Prometheus Connector, and Grafana
60
60
into your Kubernetes cluster:
61
61
```
62
62
helm repo add timescale https://charts.timescale.com/
63
63
helm repo update
64
- helm install --devel <release_name> timescale/timescale-observability
64
+ helm install --devel <release_name> timescale/tobs
65
65
```
66
66
67
67
## Quick tips
@@ -89,14 +89,14 @@ We describe how to use our pre-defined views and functions to work with the prom
89
89
90
90
A Reference for our SQL API is [ available here] ( docs/sql_api.md ) .
91
91
92
- ### Prometheus HTTP API
92
+ ### Prometheus HTTP API
93
93
94
94
The Timescale-Prometheus Connector can be used directly as a Prometheus Data Source in Grafana, or other software.
95
95
96
- It implements some endpoints of the currently stable (V1)
97
- [ Prometheus HTTP API] ( https://prometheus.io/docs/prometheus/latest/querying/api ) .
96
+ It implements some endpoints of the currently stable (V1)
97
+ [ Prometheus HTTP API] ( https://prometheus.io/docs/prometheus/latest/querying/api ) .
98
98
The API is accessible at ` http://timescale_prometheus_connector:9201/api/v1 ` and can be used to execute instant or range
99
- PromQL queries against the data in TimescaleDB, as well as retrieve the metadata for series, label names and label
99
+ PromQL queries against the data in TimescaleDB, as well as retrieve the metadata for series, label names and label
100
100
values.
101
101
102
102
A Reference for the implemented endpoints of the Prometheus HTTP API is [ available here] ( docs/prometheus_api.md )
@@ -106,20 +106,20 @@ A Reference for the implemented endpoints of the Prometheus HTTP API is [availab
106
106
### Configuring the Helm Chart
107
107
108
108
To get a fully-documented configuration file for
109
- ` timescale-observability ` , please run:
109
+ ` tobs ` , please run:
110
110
111
111
```
112
- helm show values timescale/timescale-observability > my_values.yml
112
+ helm show values timescale/tobs > my_values.yml
113
113
```
114
114
115
115
You can then edit ` my_values.yml ` and deploy the release with the
116
116
following command:
117
117
118
118
```
119
- helm upgrade --install <release_name> --values my_values.yml timescale/timescale-observability
119
+ helm upgrade --install <release_name> --values my_values.yml timescale/tobs
120
120
```
121
121
122
- By default, the ` timescale-observability ` Helm chart sets up a
122
+ By default, the ` tobs ` Helm chart sets up a
123
123
single-instance of TimescaleDB; if you are
124
124
interested in a replicated setup for high-availabilty with automated
125
125
backups, please see
@@ -130,7 +130,7 @@ backups, please see
130
130
A Helm chart for only the Timescale-Prometheus Connector is available in
131
131
the [ helm-chart directory] ( helm-chart/README.md ) of this repository.
132
132
133
- This is used as a dependency from the ` timescale-observability ` Helm
133
+ This is used as a dependency from the ` tobs ` Helm
134
134
chart and can be used as a dependency in your own custom Helm chart.
135
135
136
136
## Non-Helm deployment
@@ -140,7 +140,7 @@ chart and can be used as a dependency in your own custom Helm chart.
140
140
Any non-helm installations also need to make sure the ` drop_chunks `
141
141
procedure on a regular
142
142
basis (e.g. via CRON). We recommend executing it every 30 minutes.
143
- This is necessary to execute data retention policies according to the
143
+ This is necessary to execute data retention policies according to the
144
144
configured policy. This is set up automatically in helm.
145
145
146
146
We also recommend running this with a Timescaledb installation that
0 commit comments