You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
/opt/homebrew/opt/postgresql@17/bin/psql -h localhost -d postgres -c "CREATE EXTENSION IF NOT EXISTS timescaledb; SELECT extversion FROM pg_extension WHERE extname = 'timescaledb';"
The server powers Tuist’s server-side features like authentication, accounts and projects, cache storage, insights, previews, registry, and integrations (GitHub, Slack, and SSO). It is a Phoenix/Elixir application with Postgres and ClickHouse.
15
15
16
-
::: warning TIMESCALEDB DEPRECATION
17
-
<!---->
18
-
TimescaleDB is deprecated and will be removed. For now, if you need it for local setup or migrations, use the [TimescaleDB installation docs](https://docs.timescale.com/self-hosted/latest/install/installation-macos/).
19
-
<!---->
20
-
:::
21
-
22
16
## How to contribute {#how-to-contribute}
23
17
24
18
Contributions to the server require signing the CLA (`server/CLA.md`).
TimescaleDB is currently a required PostgreSQL extension for Tuist server, used for time-series data storage and querying. However, **TimescaleDB is deprecated** and will be dropped as a required dependency in the near future as we migrate all time-series functionality to ClickHouse. For now, ensure your PostgreSQL instance has TimescaleDB installed and enabled.
We distribute the server as a [Docker](https://www.docker.com/) image via [GitHub’s Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry).
@@ -73,19 +66,17 @@ To run it, your infrastructure must support running Docker images. Note that mos
73
66
74
67
### Postgres database {#postgres-database}
75
68
76
-
In addition to running the Docker images, you'll need a [Postgres database](https://www.postgresql.org/) with the [TimescaleDB extension](https://www.timescale.com/) to store relational and time-series data. Most infrastructure providers include Postgres databases in their offering (e.g., [AWS](https://aws.amazon.com/rds/postgresql/) & [Google Cloud](https://cloud.google.com/sql/docs/postgres)).
77
-
78
-
**TimescaleDB Extension Required:** Tuist requires the TimescaleDB extension for efficient time-series data storage and querying. This extension is used for command events, analytics, and other time-based features. Ensure your PostgreSQL instance has TimescaleDB installed and enabled before running Tuist.
69
+
In addition to running the Docker images, you'll need a [Postgres database](https://www.postgresql.org/) to store relational data. Most infrastructure providers include Postgres databases in their offering (e.g., [AWS](https://aws.amazon.com/rds/postgresql/) & [Google Cloud](https://cloud.google.com/sql/docs/postgres)).
79
70
80
71
::: info MIGRATIONS
81
72
<!-- -->
82
-
The Docker image's entrypoint automatically runs any pending schema migrations before starting the service. If migrations fail due to a missing TimescaleDB extension, you'll need to install it in your database first.
73
+
The Docker image's entrypoint automatically runs any pending schema migrations before starting the service.
83
74
<!-- -->
84
75
:::
85
76
86
77
### ClickHouse database {#clickhouse-database}
87
78
88
-
Tuist uses [ClickHouse](https://clickhouse.com/) for storing and querying large amounts of analytics data. ClickHouse is **required** for features like build insights and will be the primary time-series database as we phase out TimescaleDB. You can choose whether to self-host ClickHouse or use their hosted service.
79
+
Tuist uses [ClickHouse](https://clickhouse.com/) for storing and querying large amounts of analytics data. ClickHouse is **required** for features like build insights. You can choose whether to self-host ClickHouse or use their hosted service.
89
80
90
81
::: info MIGRATIONS
91
82
<!-- -->
@@ -301,7 +292,7 @@ On top of the `TUIST_GITHUB_APP_CLIENT_ID` and `TUIST_GITHUB_APP_CLIENT_SECRET`,
301
292
302
293
We provide a comprehensive Docker Compose configuration that includes all required dependencies for testing Tuist server on your local machine before deploying to your infrastructure:
303
294
304
-
- PostgreSQL 15 with TimescaleDB 2.16 extension (deprecated)
1. You are now connected to the local Tuist Server! You can try running `tuist cache` and see the binaries being uploaded.
43
42
44
-
> [!IMPORTANT]
45
-
> If the execution of database migrations fails because the TimescaleDB extension is not installed, you'll have to [install the extension](https://docs.timescale.com/self-hosted/latest/install/installation-macos/#set-up-the-timescaledb-extension) in the `tuist_development` database.
- Alert history (triggered alerts with current/previous values, timestamps)
39
39
40
-
### Analytics Data
40
+
### Analytics Data (ClickHouse)
41
+
The following data is stored in ClickHouse for analytics purposes:
42
+
-**Build runs** (`build_runs` table): Complete build execution data including duration, status, cache statistics, CI metadata, git information, and custom tags
43
+
-**Build issues** (`build_issues` table): Compilation warnings and errors from builds
0 commit comments