Skip to content

Commit

Permalink
Combineв psql pages into one
Browse files Browse the repository at this point in the history
  • Loading branch information
atovpeko authored Jan 13, 2025
1 parent 612ffcb commit 0229ba9
Show file tree
Hide file tree
Showing 17 changed files with 259 additions and 366 deletions.
33 changes: 13 additions & 20 deletions _partials/_grafana-connect.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
## Prerequisites

* [Create a target $SERVICE_LONG][create-service]
* Install [self-managed Grafana][grafana-self-managed], or sign up for [Grafana Cloud][grafana-cloud]
import IntegrationPrereqs from "versionContent/_partials/_integration-prereqs.mdx";

## Add your $SERVICE_LONG as a data source
<IntegrationPrereqs />

To connect the data in your $SERVICE_LONG to Grafana:
* Install [self-managed Grafana][grafana-self-managed] or sign up for [Grafana Cloud][grafana-cloud].

## Add your $SERVICE_SHORT or database as a data source

To connect the data in your $SERVICE_SHORT to Grafana:

<Procedure>

Expand All @@ -14,27 +17,16 @@ To connect the data in your $SERVICE_LONG to Grafana:
In your browser, log in to either:
- Self-hosted Grafana: at `http://localhost:3000/`. The default credentials are `admin`, `admin`.
- Grafana Cloud: use the URL and credentials you set when you created your account.
1. **Add your $SERVICE_LONG as a data source**
1. **Add your $SERVICE_SHORT as a data source**
1. Open `Connections` > `Data sources`, then click `Add new data source`.
1. Select `PostgreSQL` from the list.
1. Configure the following fields:
- `Host URL`: the host and port for your $SERVICE_SHORT, in this format: `<HOST>:<PORT>`.
- `Database name`: the name to use for the dataset.
- `Username`: `tsdbadmin`, or another privileged user.
- `Password`: the password for `User`.
- `Database`: `tsdb`.
1. Configure the connection:
- `Host URL`, `Username`, `Password`, and `Database`: configure using your [connection details][connection-info].
- `Database name`: provide the name for your dataset.
- `TLS/SSL Mode`: select `require`.
- `PostgreSQL options`: enable `TimescaleDB`.
- Leave the default setting for all other fields.

Get the values for `Host URL` and `Password` from the connection string generated when you created your $SERVICE_LONG. For example, in the following connection string:

```bash
postgres://tsdbadmin:[email protected]:39941/tsdb?sslmode=require
```

`krifchuf3r8c5onn` is the password and `s5pq0es2cy.vfbtkqzhtm.tsdb.cloud.timescale.com:39941` is the host URL in the required format.

1. **Click `Save & test`**

Grafana checks that your details are set correctly.
Expand All @@ -44,4 +36,5 @@ To connect the data in your $SERVICE_LONG to Grafana:
[grafana-self-managed]: https://grafana.com/get/?tab=self-managed
[grafana-cloud]: https://grafana.com/get/
[cloud-login]: https://console.cloud.timescale.com/
[create-service]: /getting-started/:currentVersion:/services/
[create-service]: /getting-started/:currentVersion:/services/
[connection-info]: /use-timescale/:currentVersion:/integrations/query-admin/find-connection-details/
9 changes: 9 additions & 0 deletions _partials/_integration-prereqs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Before integrating:

* Create a [target $SERVICE_LONG][create-service]. You need [your connection details][connection-info] to follow this procedure.

This procedure also works for [self-hosted $TIMESCALE_DB][enable-timescaledb].

[create-service]: /getting-started/:currentVersion:/services/
[enable-timescaledb]: /self-hosted/:currentVersion:/install/
[connection-info]: /use-timescale/:currentVersion:/integrations/query-admin/find-connection-details/
2 changes: 1 addition & 1 deletion mst/installation-mst.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ You can always [contact us][contact] if you need help working something out, or
if you want to have a chat.
[contact]: https://www.timescale.com/contact
[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/about-psql/
[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
[mst-docs]: /mst/:currentVersion:/
[tutorials]: /tutorials/:currentVersion:/
[mst-signup]: https://www.timescale.com/mst-signup
Expand Down
2 changes: 1 addition & 1 deletion mst/migrate-to-mst.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ them. The migration still occurs successfully.
[install-mst]: /mst/:currentVersion:/installation-mst/#create-your-first-service
[pg_dump]: https://www.postgresql.org/docs/current/app-pgdump.html
[pg_restore]: https://www.postgresql.org/docs/current/app-pgrestore.html
[psql]: /use-timescale/:currentVersion:/integrations/query-admin/about-psql/
[psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
[upgrading-postgresql]: https://kb-managed.timescale.com/en/articles/5368016-perform-a-postgresql-major-version-upgrade
[upgrading-postgresql-self-hosted]: /self-hosted/:currentVersion:/upgrades/upgrade-pg/
[upgrading-timescaledb]: /self-hosted/:currentVersion:/upgrades/major-upgrade/
2 changes: 1 addition & 1 deletion quick-start/ruby.md
Original file line number Diff line number Diff line change
Expand Up @@ -720,7 +720,7 @@ page by page, or all pages together, and group by path or not:
[add-performance]: #add-performance-and-path-attributes-to-pageload
[explore]: #explore-aggregation-functions
[install]: /getting-started/latest/
[psql-install]: /use-timescale/:currentVersion:/integrations/query-admin/about-psql/
[psql-install]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
[rails-guide]: https://guides.rubyonrails.org/getting_started.html
[ab]: https://httpd.apache.org/docs/2.4/programs/ab.html
[active-record-query]: https://guides.rubyonrails.org/active_record_querying.html
Expand Down
2 changes: 1 addition & 1 deletion self-hosted/install/installation-macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ And that is it! You have TimescaleDB running on a database on a self-hosted inst
For the latest functionality, install MacOS 14 Sanoma. The oldest supported version is macOS 10.15 Catalina

[homebrew]: https://docs.brew.sh/Installation
[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/about-psql/
[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
[macports]: https://guide.macports.org/#installing.macports
[install-from-source]: /self-hosted/:currentVersion:/install/installation-source/
[install-postgresql]: https://www.postgresql.org/download/macosx/
2 changes: 1 addition & 1 deletion self-hosted/install/installation-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ And that is it! You have TimescaleDB running on a database on a self-hosted inst

<WhereTo />

[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/about-psql/
[install-psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
[config]: /self-hosted/:currentVersion:/configuration/
[postgres-download]: https://www.postgresql.org/download/
[cmake-download]: https://cmake.org/download/
Expand Down
2 changes: 1 addition & 1 deletion self-hosted/migration/entire-database.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ information about compression and decompression, see [Compression][compression].
[migrate-separately]: /self-hosted/:currentVersion:/migration/schema-then-data/
[pg_dump]: https://www.postgresql.org/docs/current/app-pgdump.html
[pg_restore]: https://www.postgresql.org/docs/current/app-pgrestore.html
[psql]: /use-timescale/:currentVersion:/integrations/query-admin/about-psql/
[psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
[timescaledb_pre_restore]: /api/:currentVersion:/administration/#timescaledb_pre_restore
[timescaledb_post_restore]: /api/:currentVersion:/administration/#timescaledb_post_restore
[upgrading-postgresql-self-hosted]: /self-hosted/:currentVersion:/upgrades/upgrade-pg/
Expand Down
2 changes: 1 addition & 1 deletion self-hosted/migration/schema-then-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ the [compression section](https://docs.timescale.com/use-timescale/latest/compre
[install-selfhosted]: /self-hosted/:currentVersion:/install/
[pg_dump]: https://www.postgresql.org/docs/current/app-pgdump.html
[pg_restore]: https://www.postgresql.org/docs/current/app-pgrestore.html
[psql]: /use-timescale/:currentVersion:/integrations/query-admin/about-psql/
[psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
[timescaledb-parallel-copy]: https://github.com/timescale/timescaledb-parallel-copy
[upgrading-postgresql]: https://kb-managed.timescale.com/en/articles/5368016-perform-a-postgresql-major-version-upgrade
[upgrading-postgresql-self-hosted]: /self-hosted/:currentVersion:/upgrades/upgrade-pg/
Expand Down
2 changes: 1 addition & 1 deletion tutorials/OLD-financial-candlestick-tick-data/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,4 @@ Follow this tutorial and see how to set up your TimescaleDB database to consume
[create]: /tutorials/:currentVersion:/financial-candlestick-tick-data/create-candlestick-aggregates
[query]: /tutorials/:currentVersion:/financial-candlestick-tick-data/query-candlestick-views
[manage]: /tutorials/:currentVersion:/financial-candlestick-tick-data/advanced-data-management
[psql]: /use-timescale/:currentVersion:/integrations/query-admin/about-psql/
[psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
14 changes: 7 additions & 7 deletions use-timescale/integrations/observability-alerting/grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ keywords: [Grafana, visualizations, analytics, monitoring]

import GrafanaConnect from "versionContent/_partials/_grafana-connect.mdx";

# Integrate Grafana and Timescale Cloud
# Grafana

You can use [Grafana](https://grafana.com/docs/) to monitor, visualize and perform analytics on data stored in your $SERVICE_LONG.
[Grafana](https://grafana.com/docs/) enables you to query, visualize, alert on, and explore your metrics, logs, and traces wherever they’re stored.

This page shows you how to connect Grafana with a $SERVICE_LONG, create a dashboard and panel, then visualize geospatial data.
This page shows you how to integrate Grafana with a $SERVICE_LONG, create a dashboard and panel, then visualize geospatial data.

<GrafanaConnect />

Expand All @@ -30,7 +30,7 @@ that system.

1. **Select the data source**

Select your $SERVICE_LONG from the list of pre-configured data sources or configure a new one.
Select your $SERVICE_SHORT from the list of pre-configured data sources or configure a new one.

1. **Configure your panel**

Expand Down Expand Up @@ -124,11 +124,11 @@ tutorial as a starting point.

1. In your Grafana dashboard, click `Add` > `Visualization`.

1. Select `Geomap` in the visualization type drop-down.
1. Select `Geomap` in the visualization type drop-down at the top right.

1. **Configure the data format**

1. In the `Queries` tab, select your data source.
1. In the `Queries` tab below, select your data source.

1. In the `Format` drop-down, select `Table`.

Expand All @@ -155,7 +155,7 @@ tutorial as a starting point.

With default settings, the visualization uses green circles of the fixed size. Configure at least the following for a more representative view:

-`Map layers` > `Styles` > `Size` > `value`.
- `Map layers` > `Styles` > `Size` > `value`.

This changes the size of the circle depending on the value, with bigger circles representing bigger values.

Expand Down
89 changes: 0 additions & 89 deletions use-timescale/integrations/query-admin/about-connecting.md

This file was deleted.

109 changes: 0 additions & 109 deletions use-timescale/integrations/query-admin/about-psql.md

This file was deleted.

Loading

0 comments on commit 0229ba9

Please sign in to comment.