Skip to content

Commit

Permalink
Update Ingest data tree (#3505)
Browse files Browse the repository at this point in the history
* update ingest data tree

Co-authored-by: Iain <[email protected]>
  • Loading branch information
VineethReddy02 and billy-the-fish authored Oct 21, 2024
1 parent 5eda9f5 commit 934a69f
Show file tree
Hide file tree
Showing 16 changed files with 533 additions and 518 deletions.
92 changes: 31 additions & 61 deletions _partials/_grafana-connect.md
Original file line number Diff line number Diff line change
@@ -1,77 +1,47 @@

## Add Timescale as a data source in Grafana

You can use Grafana to visualize queries directly from your Timescale database.

Before you begin, make sure you have:
import ImportPrerequisites from "versionContent/_partials/_migrate_import_prerequisites.mdx";

* Created a [Timescale Cloud][cloud-login] service.
* Installed a self-managed Grafana account, or signed up for
[Grafana Cloud][install-grafana].
* Found the connection details for the database you want to use as a data
source. The details are contained in the cheatsheet you downloaded when you
created the service.
## Add Timescale as a data source in Grafana

<Tabs label="Add Timescale as a data source in Grafana">
Grafana is and open source analytics and monitoring solution. You use Grafana to visualize queries
directly from your $SERVICE_LONG.

<Tab title="Self-hosted Grafana">
### Prerequisites

<Procedure>
<ImportPrerequisites />

### Adding Timescale as a data source in self-hosted Grafana
* Install self-managed Grafana, or sign up for [Grafana Cloud][install-grafana]

1. In your web browser, log in to the Grafana dashboard at
`http://localhost:3000/`. The default username is `admin` with a default
password of `admin`.
1. In the Grafana dashboard, navigate to `Configuration``Data sources`.
Click `Add data source`.
1. In the `Add data source` page, search for PostgreSQL, and select it.
1. Configure the data source using your connection details:
* In the `Name` field, type a name to use for the dataset.
* In the `Host` field, type the host and port for your connection, in this
format: `<HOST>:<PORT>`. For example,
`example.tsdb.cloud.timescale.com:35177`.
* In the `Database` field, type `tsdb`.
* In the `User` field, type `tsdbadmin`, or another privileged user.
* In the `Password` field, type the password.
* In the `TLS/SSL Mode` field, select `require`
* In the `PostgreSQL details` section, toggle `TimescaleDB` on.
* All other fields can be left as default values.
1. Click `Save & test` to check your details have been set correctly.
### Add your $SERVICE_LONG as a data source in Grafana

</Procedure>

</Tab>

<Tab title="Grafana Cloud">
To connect the data in your $SERVICE_LONG to Grafana:

<Procedure>

### Adding Timescale as a data source in Grafana Cloud

1. In your web browser, log in to the Grafana dashboard with the URL and
credentials you set when you created your account.
1. In the Grafana dashboard, navigate to `Configuration``Data sources`.
Click `Add new data source`.
1. In the `Add data source` page, search for PostgreSQL, and select it.
1. Configure the data source using your connection details:
* In the `Name` field, type a name to use for the dataset.
* In the `Host` field, type the host and port for your connection, in this
format: `<HOST>:<PORT>`. For example,
`example.tsdb.cloud.timescale.com:35177`.
* In the `Database` field, type `tsdb`.
* In the `User` field, type `tsdbadmin`, or another privileged user.
* In the `Password` field, type the password.
* In the `TLS/SSL Mode` field, select `require`
* In the `PostgreSQL details` section, toggle `TimescaleDB` on.
* All other fields can be left as default values.
1. Click `Save & test` to check your details have been set correctly.
1. **Log in 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. In the Grafana dashboard, navigate to `Configuration` > `Data sources`, then click `Add data source`.
1. In `Add data source`, select `PostgreSQL`.
1. Configure the data source using the connection in `$TARGET`:
- `Name`: the name to use for the dataset
- `Host`: the host and port for your $SERVICE_SHORT, in this format: `<HOST>:<PORT>`.

For example: `example.tsdb.cloud.timescale.com:35177`.
- `Database`: `tsdb`
- `User`: `tsdbadmin`, or another privileged user
- `Password`: the password for `User`
- `TLS/SSL Mode`: select `require`
- `PostgreSQL details`: enable `TimescaleDB`
- Leave the default setting for all other fields
1. Click `Save & test`.

Grafana checks that your details are set correctly.

</Procedure>

</Tab>

</Tabs>

[install-grafana]: https://grafana.com/get/
[cloud-login]: https://console.cloud.timescale.com/
16 changes: 16 additions & 0 deletions _partials/_migrate_import_prerequisites.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@

Before you import your data:

- [Create a target Timescale Cloud service][created-a-database-service-in-timescale].

Each Timescale Cloud service [has a single database] that supports the
[most popular extensions][all available extensions]. Timescale Cloud services do not support [tablespaces],
and [there is no superuser associated with a Timescale service][no-superuser-for-timescale-instance].

[created-a-database-service-in-timescale]: /getting-started/:currentVersion:/services/
[has a single database]: /migrate/:currentVersion:/troubleshooting/#only-one-database-per-instance
[all available extensions]: /migrate/:currentVersion:/troubleshooting/#extension-availability
[tablespaces]: /migrate/:currentVersion:/troubleshooting/#tablespaces
[no-superuser-for-timescale-instance]: /migrate/:currentVersion:/troubleshooting/#superuser-privileges
[create-ec2-instance]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EC2_GetStarted.html#ec2-launch-instance

9 changes: 9 additions & 0 deletions _partials/_migrate_import_setup_connection_strings_parquet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
This variable hold the connection information for the target Timescale Cloud service.

In Terminal on the source machine, set the following:

```bash
export TARGET=postgres://tsdbadmin:<PASSWORD>@<HOST>:<PORT>/tsdb?sslmode=require
```
You find the connection information for your Timescale Cloud service in the configuration file you
downloaded when you created the service.
20 changes: 0 additions & 20 deletions use-timescale/ingest-data/about-ingesting.md

This file was deleted.

83 changes: 0 additions & 83 deletions use-timescale/ingest-data/about-timescaledb-parallel-copy.md

This file was deleted.

Loading

0 comments on commit 934a69f

Please sign in to comment.