Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Flatten the structure of the integrations section #3681

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
57 commits
Select commit Hold shift + click to select a range
27e278c
draft
atovpeko Dec 17, 2024
c7621e0
draft
atovpeko Dec 17, 2024
e2bd4b7
draft
atovpeko Dec 17, 2024
e146627
Merge branch 'latest' into 249-docs-rfc-make-the-grafana-integration-…
atovpeko Dec 17, 2024
d5f9085
draft
atovpeko Dec 17, 2024
f0eab76
draft
atovpeko Dec 17, 2024
97d8d69
draft
atovpeko Dec 17, 2024
da83fe4
Update use-timescale/integrations/observability-alerting/grafana.md
atovpeko Dec 18, 2024
9aadc85
Update use-timescale/integrations/observability-alerting/grafana.md
atovpeko Dec 18, 2024
17d2b9c
Update use-timescale/integrations/observability-alerting/grafana.md
atovpeko Dec 18, 2024
9416833
Update use-timescale/integrations/observability-alerting/grafana.md
atovpeko Dec 18, 2024
011323e
updated file locations
atovpeko Dec 18, 2024
07b81d1
review comments
atovpeko Dec 18, 2024
3ff5870
draft
atovpeko Dec 19, 2024
2e00b98
draft
atovpeko Dec 19, 2024
01d4bc4
draft
atovpeko Dec 20, 2024
171633c
draft
atovpeko Dec 20, 2024
dde18e2
new procedure with geomap
atovpeko Dec 20, 2024
6aa65a6
Merge branch 'latest' of github.com:timescale/docs into 249-docs-rfc-…
atovpeko Dec 20, 2024
0af7b1f
new procedure with geomap
atovpeko Dec 20, 2024
2ccc5a3
Merge branch 'latest' into 249-docs-rfc-make-the-grafana-integration-…
billy-the-fish Dec 20, 2024
4b1c60a
internal links repointed
atovpeko Dec 23, 2024
f0b9313
Merge remote-tracking branch 'origin/249-docs-rfc-make-the-grafana-in…
atovpeko Dec 23, 2024
c0422f9
Merge branch 'latest' of github.com:timescale/docs into 250-docs-rfc-…
atovpeko Dec 23, 2024
924221c
psql consolidated
atovpeko Dec 23, 2024
04e44ad
Merge branch '250-docs-rfc-make-the-psql-pages-into-a-single-page-doc…
atovpeko Jan 2, 2025
798d8ac
flatten structure
atovpeko Jan 2, 2025
45d6594
Merge branch 'latest' of github.com:timescale/docs into 251-docs-rfc-…
atovpeko Jan 6, 2025
b4b50bd
descriptions
atovpeko Jan 6, 2025
67cbaf7
review comments
atovpeko Jan 6, 2025
9837183
Merge branch 'latest' of github.com:timescale/docs into 250-docs-rfc-…
atovpeko Jan 6, 2025
af1ddc3
review comments
atovpeko Jan 6, 2025
cd8a9ed
Merge branch 'latest' into 250-docs-rfc-make-the-psql-pages-into-a-si…
atovpeko Jan 6, 2025
4f4e83f
review comments
atovpeko Jan 6, 2025
3b9b4f3
Merge remote-tracking branch 'origin/250-docs-rfc-make-the-psql-pages…
atovpeko Jan 6, 2025
6e0d478
review comments
atovpeko Jan 6, 2025
04ddf67
review comments
atovpeko Jan 6, 2025
a78642f
Merge branch 'latest' into 251-docs-rfc-flatten-the-structure-of-the-…
atovpeko Jan 6, 2025
de7c9f6
Merge branch '250-docs-rfc-make-the-psql-pages-into-a-single-page-doc…
atovpeko Jan 8, 2025
0792616
review comments
atovpeko Jan 8, 2025
1c0e451
Merge branch 'latest' into 251-docs-rfc-flatten-the-structure-of-the-…
atovpeko Jan 9, 2025
8e98249
Merge branch 'latest' into 251-docs-rfc-flatten-the-structure-of-the-…
atovpeko Jan 13, 2025
49be590
update
atovpeko Jan 13, 2025
e480eb7
Merge branch '251-docs-rfc-flatten-the-structure-of-the-integrations-…
atovpeko Jan 13, 2025
73655c8
update
atovpeko Jan 13, 2025
276063e
update
atovpeko Jan 13, 2025
17b48af
Update use-timescale/integrations/index.md
atovpeko Jan 13, 2025
788d300
Merge branch 'latest' of github.com:timescale/docs into 251-docs-rfc-…
atovpeko Jan 13, 2025
48de0b6
Merge remote-tracking branch 'origin/251-docs-rfc-flatten-the-structu…
atovpeko Jan 13, 2025
4e07b3e
update
atovpeko Jan 13, 2025
a083195
Merge branch 'latest' of github.com:timescale/docs into 251-docs-rfc-…
atovpeko Jan 13, 2025
83e3fff
redirects
atovpeko Jan 13, 2025
d753f9e
redirects
atovpeko Jan 13, 2025
8022ad8
cleanup
atovpeko Jan 13, 2025
8e53e61
cleanup
atovpeko Jan 14, 2025
c3f43a7
fixed some links
atovpeko Jan 14, 2025
f669dce
cleanup
atovpeko Jan 15, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions _partials/_grafana-connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import IntegrationPrereqs from "versionContent/_partials/_integration-prereqs.md

* 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
## Add your $SERVICE_SHORT as a data source

To connect the data in your $SERVICE_SHORT to Grafana:

Expand Down Expand Up @@ -37,4 +37,4 @@ To connect the data in your $SERVICE_SHORT to Grafana:
[grafana-cloud]: https://grafana.com/get/
[cloud-login]: https://console.cloud.timescale.com/
[create-service]: /getting-started/:currentVersion:/services/
[connection-info]: /use-timescale/:currentVersion:/integrations/query-admin/find-connection-details/
[connection-info]: /use-timescale/:currentVersion:/integrations/find-connection-details/
2 changes: 1 addition & 1 deletion _partials/_integration-prereqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ Before integrating:

[create-service]: /getting-started/:currentVersion:/services/
[enable-timescaledb]: /self-hosted/:currentVersion:/install/
[connection-info]: /use-timescale/:currentVersion:/integrations/query-admin/find-connection-details/
[connection-info]: /use-timescale/:currentVersion:/integrations/find-connection-details/
66 changes: 55 additions & 11 deletions lambda/redirects.js
Original file line number Diff line number Diff line change
Expand Up @@ -564,7 +564,7 @@ module.exports = [
},
{
from: "/tutorials/latest/grafana/",
to: "https://docs.timescale.com/use-timescale/latest/integrations/observability-alerting/grafana/",
to: "https://docs.timescale.com/use-timescale/latest/integrations/grafana/",
},
{
from: "/tutorials/latest/howto-monitor-django-prometheus",
Expand Down Expand Up @@ -605,27 +605,27 @@ module.exports = [
{ from: "/tutorials", to: "https://docs.timescale.com/tutorials/latest/" },
{
from: "/use-timescale/latest/connecting/",
to: "https://docs.timescale.com/use-timescale/latest/integrations/query-admin/",
to: "https://docs.timescale.com/use-timescale/latest/integrations/",
},
{
from: "/use-timescale/latest/connecting/about-connecting",
to: "https://docs.timescale.com/use-timescale/latest/integrations/query-admin/about-connecting/",
to: "https://docs.timescale.com/use-timescale/latest/integrations/find-connection-details/",
},
{
from: "/use-timescale/latest/connecting/about-psql/",
to: "https://docs.timescale.com/use-timescale/latest/integrations/query-admin/about-psql/",
to: "https://docs.timescale.com/use-timescale/latest/integrations/psql/",
},
{
from: "/use-timescale/latest/connecting/dbeaver/",
to: "https://docs.timescale.com/use-timescale/latest/integrations/query-admin/dbeaver/",
to: "https://docs.timescale.com/use-timescale/latest/integrations/dbeaver/",
},
{
from: "/use-timescale/latest/connecting/pgadmin/",
to: "https://docs.timescale.com/use-timescale/latest/integrations/query-admin/",
to: "https://docs.timescale.com/use-timescale/latest/integrations/pgadmin/",
},
{
from: "/use-timescale/latest/connecting/psql/",
to: "https://docs.timescale.com/use-timescale/latest/integrations/query-admin/about-psql/",
to: "https://docs.timescale.com/use-timescale/latest/integrations/psql/",
},
{
from: "/use-timescale/latest/data-tiering/move-data/",
Expand Down Expand Up @@ -721,7 +721,7 @@ module.exports = [
},
{
from: "/using-timescaledb/visualizing-data",
to: "https://docs.timescale.com/use-timescale/latest/integrations/observability-alerting/grafana/",
to: "https://docs.timescale.com/use-timescale/latest/integrations/grafana/",
},
{
from: "/use-timescale/latest/account-management/",
Expand Down Expand Up @@ -759,15 +759,15 @@ module.exports = [
},
{
from: "/timescaledb/latest/tutorials/grafana/visualizations/pie-chart/",
to: "https://docs.timescale.com/use-timescale/latest/integrations/observability-alerting/grafana/",
to: "https://docs.timescale.com/use-timescale/latest/integrations/grafana/",
},
{
from: "/promscale/latest/about-promscale/#promscale-schema-for-metric-data",
to: "https://docs.timescale.com/",
},
{
from: "/promscale/latest/visualize-data/grafana",
to: "https://docs.timescale.com/use-timescale/latest/integrations/observability-alerting/grafana/",
to: "https://docs.timescale.com/use-timescale/latest/integrations/grafana/",
},
{
from: "/install/latest/self-hosted/installation-redhat/#where-to-next",
Expand All @@ -783,7 +783,7 @@ module.exports = [
},
{
from: "/timescaledb/latest/tutorials/grafana/grafana-variables/",
to: "https://docs.timescale.com/use-timescale/latest/integrations/observability-alerting/grafana/",
to: "https://docs.timescale.com/use-timescale/latest/integrations/grafana/",
},
{
from: "/clustering/using-timescaledb/update-db",
Expand Down Expand Up @@ -821,4 +821,48 @@ module.exports = [
from: "/use-timescale/latest/compression/backfill-historical-data/",
to: "https://github.com/timescale/timescaledb-extras/blob/master/backfill.sql",
},
{
from: '/use-timescale/latest/integrations/observability-alerting/grafana/installation/',
to: 'https://docs.timescale.com/use-timescale/latest/integrations/grafana/',
},
{
from: '/use-timescale/latest/integrations/observability-alerting/grafana/geospatial-dashboards/',
to: 'https://docs.timescale.com/use-timescale/latest/integrations/grafana/',
},
{
from: '/use-timescale/latest/integrations/observability-alerting/grafana/create-dashboard-and-panel/',
to: 'https://docs.timescale.com/use-timescale/latest/integrations/grafana/',
},
{
from: '/use-timescale/latest/integrations/query-admin/about-psql/',
to: 'https://docs.timescale.com/use-timescale/latest/integrations/psql/',
},
{
from: '/use-timescale/latest/integrations/query-admin/about-connecting/',
to: 'https://docs.timescale.com/use-timescale/latest/integrations/find-connection-details/',
},
{
from: '/use-timescale/latest/integrations/query-admin/azure-data-studio/',
to: 'https://docs.timescale.com/use-timescale/latest/integrations/azure-data-studio/',
},
{
from: '/use-timescale/latest/integrations/query-admin/dbeaver/',
to: 'https://docs.timescale.com/use-timescale/latest/integrations/dbeaver/',
},
{
from: '/use-timescale/latest/integrations/query-admin/pgadmin/',
to: 'https://docs.timescale.com/use-timescale/latest/integrations/pgadmin/',
},
{
from: '/use-timescale/latest/integrations/query-admin/qstudio/',
to: 'https://docs.timescale.com/use-timescale/latest/integrations/qstudio/',
},
{
from: '/use-timescale/latest/integrations/config-deploy/terraform/',
to: 'https://docs.timescale.com/use-timescale/latest/integrations/terraform/',
},
{
from: '/use-timescale/latest/integrations/observability-alerting/tableau/',
to: 'https://docs.timescale.com/use-timescale/latest/integrations/tableau/',
},
];
4 changes: 2 additions & 2 deletions use-timescale/ingest-data/ingest-telegraf.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,6 @@ see the [PostgreQL output plugin][output-plugin].
[output-plugin]: https://github.com/influxdata/telegraf/blob/release-1.24/plugins/outputs/postgresql/README.md
[install-telegraf]: https://docs.influxdata.com/telegraf/v1.21/introduction/installation/
[create-service]: /getting-started/latest/
[connect-timescaledb]: /use-timescale/:currentVersion:/integrations/query-admin/about-connecting/
[grafana]: /use-timescale/:currentVersion:/integrations/observability-alerting/grafana/
[connect-timescaledb]: /use-timescale/:currentVersion:/integrations/find-connection-details/
[grafana]: /use-timescale/:currentVersion:/integrations/grafana/
[about-hypertables]: /use-timescale/:currentVersion:/hypertables/about-hypertables/
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ keywords: [connect]

# Connect to Timescale using Azure Data Studio

Azure Data Studio is a cross-platform database tool for data professionals using
on-premises and cloud data platforms on Windows, macOS, and Linux.
Azure Data Studio is an open-source, cross-platform hybrid data analytics tool designed to simplify the data landscape.

## Before you begin

Expand Down
13 changes: 0 additions & 13 deletions use-timescale/integrations/config-deploy/index.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ keywords: [connect]

# Connect to Timescale using DBeaver

[DBeaver][dbeaver] is a free and open source database tool that is available for
Microsoft Windows, Apple macOS, and many Linux versions. DBeaver provides a
powerful SQL editor, administration features, ability to migrate data and
[DBeaver][dbeaver] is a free cross-platform database tool for developers, database administrators, analysts, and everyone working with data. DBeaver provides a powerful SQL editor, administration features, ability to migrate data and
schema, and the ability to monitor database connection sessions. You can connect
to Timescale hosted on your local machine or on a remote server or a Timescale
service.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To connect to your $SERVICE_SHORT or self-hosted database, you need at least the
- Password
- Database name

Find the connection details based on your installation type.
Find the connection details based on your deployment type:

<Tabs label="Connection details">

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ keywords: [Grafana, visualizations, analytics, monitoring]

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

# Grafana
# Integrate Grafana and Timescale Cloud

[Grafana](https://grafana.com/docs/) enables you to query, visualize, alert on, and explore your metrics, logs, and traces wherever they’re stored.

Expand All @@ -22,6 +22,8 @@ view into the performance of a system, and each dashboard consists of one or
more panels, which represent information about a specific metric related to
that system.

To create a new dashboard:

<Procedure>

1. **On the `Dashboards` page, click `New` and select `New dashboard`**
Expand All @@ -48,7 +50,7 @@ that system.

## Use the time filter function

Grafana time-series panels include a time filter.
Grafana time-series panels include a time filter:

<Procedure>

Expand Down Expand Up @@ -165,9 +167,9 @@ tutorial as a starting point.

Add thresholds for 7 and 10, to mark rides over 7 and 10 miles in different colors, respectively.

You now have a visualization that looks like this:
You now have a visualization that looks like this:

![Timescale and Grafana integration](https://assets.timescale.com/docs/images/timescale-grafana-integration.png)
![Timescale and Grafana integration](https://assets.timescale.com/docs/images/timescale-grafana-integration.png)


</Procedure>
Expand Down
72 changes: 42 additions & 30 deletions use-timescale/integrations/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,47 @@ keywords: [integrations]
tags: [integrations]
---

# $CLOUD_LONG Integrations

# Integrate tooling with Timescale Cloud

You can integrate your Timescale database with third-party solutions to expand
and extend what you can do with your data.

|[Query and administration][query-admin]|[Configuration and deployment][config-deploy]|[Observability and alerting][observability-alerting]|
|-|-|-|
|[PopSQL][popsql]|
|[psql][psql]|[Terraform][terraform]|[Grafana][grafana]|
|[DBeaver][dbeaver]||[Tableau][tableau]|
|[Azure Data Studio][ads]|
|[pgAdmin][pgadmin]|
|[qStudio][qstudio]|



[query-admin]: /use-timescale/:currentVersion:/integrations/query-admin/
[observability-alerting]: /use-timescale/:currentVersion:/integrations/observability-alerting/
[data-ingest]: /use-timescale/:currentVersion:/integrations/data-ingest/
[config-deploy]: /use-timescale/:currentVersion:/integrations/config-deploy/
[psql]: /use-timescale/:currentVersion:/integrations/query-admin/psql/
[dbeaver]: /use-timescale/:currentVersion:/integrations/query-admin/dbeaver/
[ads]: /use-timescale/:currentVersion:/integrations/query-admin/azure-data-studio/
[pgadmin]: /use-timescale/:currentVersion:/integrations/query-admin/pgadmin/
[qstudio]: /use-timescale/:currentVersion:/integrations/query-admin/qstudio/
[grafana]: /use-timescale/:currentVersion:/integrations/observability-alerting/grafana/
[telegraf]: /use-timescale/:currentVersion:/integrations/data-ingest/telegraf/
[tableau]: /use-timescale/:currentVersion:/integrations/observability-alerting/tableau/
[terraform]: /use-timescale/:currentVersion:/integrations/config-deploy/terraform/
[popsql]: /getting-started/:currentVersion:/run-queries-from-console/#data-mode
You can integrate your $SERVICE_LONG with third-party solutions to expand and extend what you can do with your data.

## Integrates with PostgreSQL? Integrates with your $SERVICE_SHORT!

A $SERVICE_LONG is a PostgreSQL database instance extended by $COMPANY with custom capabilities. This means that any third-party solution that you can integrate with PostgreSQL, you can also integrate with $CLOUD_LONG. See the full list of PostgreSQL integrations [here][postgresql-integrations].

Some of the most in-demand integrations for $CLOUD_LONG are listed below, with links to detailed integration steps.

## Query and administration

| Name | Description |
|:------------------------:|-------------------------------------------------------------------------------------------------------------------------------------------------|
| [Azure Data Studio][ads] | An open-source, cross-platform hybrid data analytics tool designed to simplify the data landscape. |
| [DBeaver][dbeaver] | A free cross-platform database tool for developers, database administrators, analysts, and everyone working with data. |
| [pgAdmin][pgadmin] | A feature-rich open-source administration and development platform for PostgreSQL. |
| [psql][psql] | A terminal-based frontend to PostgreSQL that enables you to type in queries interactively, issue them to PostgreSQL, and see the query results. |
| [qStudio][qstudio] | A modern free SQL editor that provides syntax highlighting, code completion, excel export, charting, and more. |


## Observability and alerting

| Name | Description |
|:---------------------------:|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Grafana][grafana] | An open-source analytics and monitoring solution that enables you to query, visualize, alert on, and explore your metrics, logs. |
| [Tableau][tableau] | A popular analytics platform that helps you gain greater intelligence about your business. |


## Configuration and deployment

| Name | Description |
|:---------------------------:|-----------------------------------------------------------------------------------------------------------------------------|
| [Terraform][terraform] | An infrastructure-as-code tool that enables you to safely and predictably provision and manage infrastructure in any cloud. |

[psql]: /use-timescale/:currentVersion:/integrations/psql/
[qstudio]: /use-timescale/:currentVersion:/integrations/qstudio/
[dbeaver]: /use-timescale/:currentVersion:/integrations/dbeaver/
[ads]: /use-timescale/:currentVersion:/integrations/azure-data-studio/
[pgadmin]: /use-timescale/:currentVersion:/integrations/pgadmin/
[grafana]: /use-timescale/:currentVersion:/integrations/grafana/
[tableau]: /use-timescale/:currentVersion:/integrations/tableau/
[terraform]: /use-timescale/:currentVersion:/integrations/terraform
[postgresql-integrations]: https://slashdot.org/software/p/PostgreSQL/integrations/
17 changes: 0 additions & 17 deletions use-timescale/integrations/observability-alerting/index.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ keywords: [connect]

# Connect to Timescale using pgAdmin

The `pgAdmin` tool is a database administration tool that can be run on the
desktop, or in your browser. It is available for Chrome, Firefox, Edge, and
The `pgAdmin` tool is a feature-rich open-source administration and development platform for PostgreSQL. It is available for Chrome, Firefox, Edge, and
Safari browsers, or can be installed on Microsoft Windows, Apple macOS, or
various Linux flavors.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import IntegrationPrereqs from "versionContent/_partials/_integration-prereqs.md

# Connect with psql

`psql` is a terminal-based front-end to PostgreSQL that enables you to type in queries interactively, issue them to Postgres, and see the query results.
[`psql`][psql-docs] is a terminal-based frontend to PostgreSQL that enables you to type in queries interactively, issue them to Postgres, and see the query results.

This page shows you how to use the `psql` command line tool to interact with your $SERVICE_LONG.

Expand Down Expand Up @@ -208,7 +208,7 @@ When you start using `psql`, these are the commands you are likely to use most f
|`\x`|Show expanded query results|
|`\?`|List all `psql` slash commands|

For more on `psql` commands, see the [Timescale psql cheat sheet][psql-cheat-sheet] and [psql documentation][psql-docs].
For more on `psql` commands, see the [$COMPANY psql cheat sheet][psql-cheat-sheet] and [psql documentation][psql-docs].

## Save query results to a file

Expand Down Expand Up @@ -251,11 +251,11 @@ loaded into the editor. When you have made your changes, press `Esc`, then type
edited query by pressing ``, and press `Enter` to run it.

[psql-cheat-sheet]: https://www.timescale.com/learn/postgres-cheat-sheet
[psql-docs]: https://www.postgresql.org/docs/13/app-psql.html
[psql-docs]: https://www.postgresql.org/docs/current/app-psql.html
[ssl-mode]: /use-timescale/:currentVersion:/security/strict-ssl/
[homebrew]: https://docs.brew.sh/Installation
[macports]: https://guide.macports.org/#installing.macports
[windows-installer]: https://www.postgresql.org/download/windows/
[connect-database]:/use-timescale/:currentVersion:/integrations/query-admin/psql/#connect-to-your-service
[connection-info]: /use-timescale/:currentVersion:/integrations/query-admin/find-connection-details/
[connect-database]:/use-timescale/:currentVersion:/integrations/psql/#connect-to-your-service
[connection-info]: /use-timescale/:currentVersion:/integrations/find-connection-details/

Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ keywords: [connect]

# Connect to Timescale using qStudio

You can use [qStudio][qstudio] to run queries, browse tables, and create charts
for your Timescale database.
[qStudio][qstudio] is a modern free SQL editor that provides syntax highlighting, code-completion, excel export, charting, and much more. You can use it to run queries, browse tables, and create charts for your Timescale database.

For more information about `qStudio`, including download and installation
instructions, see [timestored.com][qstudio-downloads].
Expand Down
Loading
Loading