[ { "path": ".github/workflows/docker-api.yaml", "content": "name: API Docker build\n\non:\n push:\n\njobs:\n docker:\n runs-on: ubuntu-latest\n\n permissions:\n contents: read\n packages: write\n\n steps:\n -\n uses: actions/checkout@v3\n -\n name: Set up QEMU\n uses: docker/setup-qemu-action@v2\n with:\n platforms: arm64\n -\n name: Set up Docker Buildx\n uses: docker/setup-buildx-action@v2\n -\n name: Docker image metadata\n id: meta\n uses: docker/metadata-action@v4\n with:\n images: ghcr.io/${{ github.repository }}/api\n tags: |\n type=raw,value=latest,enable=${{ github.ref == 'refs/heads/main' }}\n type=raw,value=main,enable=${{ github.ref == 'refs/heads/main' }}\n type=ref,event=pr\n type=sha\n -\n name: Login to GitHub Container Registry\n uses: docker/login-action@v2\n with:\n registry: ghcr.io\n username: ${{ github.actor }}\n password: ${{ secrets.GITHUB_TOKEN }}\n -\n name: Build and push\n uses: docker/build-push-action@v4\n with:\n context: .\n platforms: linux/amd64,linux/arm64\n push: ${{ github.event_name != 'pull_request' }}\n tags: ${{ steps.meta.outputs.tags }}\n labels: ${{ steps.meta.outputs.labels }}\n" }, { "path": ".github/workflows/docker-frontend.yaml", "content": "name: Frontend Docker build\n\non:\n push:\n\njobs:\n docker:\n runs-on: ubuntu-latest\n defaults:\n run:\n working-directory: \"frontend\"\n\n permissions:\n contents: read\n packages: write\n\n steps:\n - uses: actions/checkout@v3\n - name: Set up QEMU\n uses: docker/setup-qemu-action@v2\n with:\n platforms: arm64\n - name: Set up Docker Buildx\n uses: docker/setup-buildx-action@v2\n - name: Docker image metadata\n id: meta\n uses: docker/metadata-action@v4\n with:\n images: ghcr.io/${{ github.repository }}/frontend\n tags: |\n type=raw,value=latest,enable=${{ github.ref == 'refs/heads/main' }}\n type=raw,value=main,enable=${{ github.ref == 'refs/heads/main' }}\n type=ref,event=pr\n type=sha\n - name: Login to GitHub Container Registry\n uses: docker/login-action@v2\n with:\n registry: ghcr.io\n username: ${{ github.actor }}\n password: ${{ secrets.GITHUB_TOKEN }}\n - uses: pnpm/action-setup@v2\n with:\n version: 8.6.12\n - name: Install Node.js\n uses: actions/setup-node@v4\n with:\n node-version-file: frontend/.node-version\n cache: \"pnpm\"\n cache-dependency-path: frontend/pnpm-lock.yaml\n\n - name: Install dependencies\n run: pnpm i --frozen-lockfile\n\n - name: Build\n run: pnpm build\n\n - name: Build and push\n uses: docker/build-push-action@v4\n with:\n context: frontend/\n platforms: linux/amd64,linux/arm64\n push: ${{ github.event_name != 'pull_request' }}\n tags: ${{ steps.meta.outputs.tags }}\n labels: ${{ steps.meta.outputs.labels }}\n" }, { "path": ".github/workflows/release-chart.yaml", "content": "name: Release Chart\n\non:\n pull_request:\n paths:\n - charts/**\n - .github/workflows/release-chart.yaml\n push:\n branches:\n - main\n paths:\n - charts/**\n - .github/workflows/release-chart.yaml\n\njobs:\n release:\n name: Release chart to repo\n runs-on: ubuntu-latest\n\n permissions:\n contents: write\n\n steps:\n - name: Checkout\n uses: actions/checkout@v3\n\n - name: Install Helm\n uses: azure/setup-helm@v1\n with:\n version: v3.12.2\n\n - name: Add - to version in charts/housewatch/Chart.yaml and update Chart.lock\n if: github.ref != 'refs/heads/main'\n run: |\n sed -i 's/^version: \\(.*\\)$/version: \\1-${{ github.sha }}/g' charts/housewatch/Chart.yaml\n\n - name: Configure Git\n run: |\n git config user.name \"Max Hedgehog\"\n git config user.email \"127861667+max-hedgehog[bot]@users.noreply.github.com\"\n git fetch origin gh-pages --depth=1\n\n - name: Package\n run: |\n helm dependency update charts/housewatch/\n mkdir -p .cr-release-packages\n cd .cr-release-packages\n helm package ../charts/housewatch\n cd -\n set -x\n\n - name: Run chart-releaser\n uses: helm/chart-releaser-action@4b85f2c82c80ff4284ff8520f47bbe69dd89b0aa\n if: github.ref == 'refs/heads/main' && github.repository == 'PostHog/HouseWatch'\n env:\n CR_TOKEN: \"${{ secrets.GITHUB_TOKEN }}\"\n with:\n skip_existing: true\n skip_packaging: true\n" }, { "path": ".gitignore", "content": "# Byte-compiled / optimized / DLL files\n__pycache__/\n*.py[cod]\n*$py.class\n\n# C extensions\n*.so\n\n# Distribution / packaging\n.Python\nbuild/\ndevelop-eggs/\ndist/\ndownloads/\neggs/\n.eggs/\nlib/\nlib64/\nparts/\nsdist/\nvar/\nwheels/\nshare/python-wheels/\n*.egg-info/\n.installed.cfg\n*.egg\nMANIFEST\n\n# PyInstaller\n# Usually these files are written by a python script from a template\n# before PyInstaller builds the exe, so as to inject date/other infos into it.\n*.manifest\n*.spec\n\n# Installer logs\npip-log.txt\npip-delete-this-directory.txt\n\n# Unit test / coverage reports\nhtmlcov/\n.tox/\n.nox/\n.coverage\n.coverage.*\n.cache\nnosetests.xml\ncoverage.xml\n*.cover\n*.py,cover\n.hypothesis/\n.pytest_cache/\ncover/\n\n# Translations\n*.mo\n*.pot\n\n# Django stuff:\n*.log\nlocal_settings.py\ndb.sqlite3\ndb.sqlite3-journal\n\n# Flask stuff:\ninstance/\n.webassets-cache\n\n# Scrapy stuff:\n.scrapy\n\n# Sphinx documentation\ndocs/_build/\n\n# PyBuilder\n.pybuilder/\ntarget/\n\n# Jupyter Notebook\n.ipynb_checkpoints\n\n# IPython\nprofile_default/\nipython_config.py\n\n# pyenv\n# For a library or package, you might want to ignore these files since the code is\n# intended to run in multiple environments; otherwise, check them in:\n# .python-version\n\n# pipenv\n# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.\n# However, in case of collaboration, if having platform-specific dependencies or dependencies\n# having no cross-platform support, pipenv may install dependencies that don't work, or not\n# install all needed dependencies.\n#Pipfile.lock\n\n# poetry\n# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.\n# This is especially recommended for binary packages to ensure reproducibility, and is more\n# commonly ignored for libraries.\n# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control\n#poetry.lock\n\n# pdm\n# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.\n#pdm.lock\n# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it\n# in version control.\n# https://pdm.fming.dev/#use-with-ide\n.pdm.toml\n\n# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm\n__pypackages__/\n\n# Celery stuff\ncelerybeat-schedule\ncelerybeat.pid\n\n# SageMath parsed files\n*.sage.py\n\n# Environments\n.env\n.venv\nenv/\nvenv/\nENV/\nenv.bak/\nvenv.bak/\n\n# Spyder project settings\n.spyderproject\n.spyproject\n\n# Rope project settings\n.ropeproject\n\n# mkdocs documentation\n/site\n\n# mypy\n.mypy_cache/\n.dmypy.json\ndmypy.json\n\n# Pyre type checker\n.pyre/\n\n# pytype static type analyzer\n.pytype/\n\n# Cython debug symbols\ncython_debug/\n\n# PyCharm\n# JetBrains specific template is maintained in a separate JetBrains.gitignore that can\n# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore\n# and can be added to the global gitignore or merged into this file. For a more nuclear\n# option (not recommended) you can uncomment the following to ignore the entire idea folder.\n#.idea/\n\n\nenv/\n__pycache__/\nnode_modules\nhousewatch.sqlite3\n.DS_Store\nyarn.lock\n\ncharts/housewatch/charts/\n.pnpm/" }, { "path": ".pre-commit-config.yaml", "content": "repos:\n - repo: https://github.com/pre-commit/pre-commit-hooks\n rev: v2.3.0\n hooks:\n - id: check-yaml\n - id: end-of-file-fixer\n - id: trailing-whitespace\n - repo: https://github.com/astral-sh/ruff-pre-commit\n # Ruff version.\n rev: v0.0.275\n hooks:\n - id: ruff\n args: [--fix, --exit-non-zero-on-fix]\n - repo: https://github.com/psf/black\n rev: 22.10.0\n hooks:\n - id: black\n" }, { "path": "Dockerfile", "content": "FROM python:3.10\n\nENV PYTHONUNBUFFERED 1\n\nWORKDIR /code\n\nCOPY requirements.txt ./\n\nRUN apt-get update && \\\n apt-get install -y --no-install-recommends \\\n \"build-essential\" \\\n \"git\" \\\n \"libpq-dev\" \\\n \"libxmlsec1\" \\\n \"libxmlsec1-dev\" \\\n \"libffi-dev\" \\\n \"pkg-config\" \\\n && \\\n rm -rf /var/lib/apt/lists/* && \\\n pip install -r requirements.txt --compile --no-cache-dir\n\n\nUSER root\n\nCOPY manage.py manage.py\nCOPY housewatch housewatch/\nCOPY bin bin/\n\nRUN DEBUG=1 python manage.py collectstatic --noinput\n" }, { "path": "LICENSE", "content": "MIT License\n\nCopyright (c) 2023 PostHog\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "README.md", "content": "

\n \n

\n\n\n

\n \n

\n\n\n## 📈 Open source tool for monitoring and managing ClickHouse clusters\n\n- Get an overview of cluster load and performance\n- Drill down into your queries and understand the load they put on your cluster\n- Search through logs and errors\n- Monitor and kill running queries with the click of a button\n- Get stats on your disk usage per node, and understand how much disk space tables, columns, and parts take up\n- Run your own queries straight from the interface to further dig into performance and cluster issues\n- Setup operations to run in the background with automatic rollbacks for failures\n\n## 💻 Deploy\n\nTo deploy HouseWatch, clone this repo and then run the following, substituting the environment variables for the relevant values of one of your ClickHouse instances:\n\n```bash\nSITE_ADDRESS= \\\nCLICKHOUSE_HOST=localhost \\\nCLICKHOUSE_CLUSTER=mycluster \\\nCLICKHOUSE_USER=default \\\nCLICKHOUSE_PASSWORD=xxxxxxxxxxx \\\ndocker compose -f docker-compose.yml up\n```\n\n`SITE_ADDRESS` here is the address that the UI will be running on. It can be a domain name or simply a port like `:80`.\n\nAfter running the above, the UI will be running on the address you specified. This will be something like http://localhost if you used `:80` for your `SITE_ADDRESS` above. I would think twice about exposing this to the internet, as it is not currently secured in any way.\n\n
\n\nRead more\n\n
\n\nThe following are the supported environment variables for configuring your HouseWatch deployment:\n\n- `CLICKHOUSE_HOST`: Required - hostname of the instance to connect to.\n- `CLICKHOUSE_USER`: Required - username to access ClickHouse. Can be a read-only user, but in that case not all features will work.\n- `CLICKHOUSE_PASSWORD`: Required - password for the specified user.\n- `CLICKHOUSE_DATABASE`: Optional - database to connect to by default.\n- `CLICKHOUSE_CLUSTER`: Optional - cluster name, to analyze data from the whole cluster.\n- `CLICKHOUSE_SECURE`: Optional - see [clickhouse-driver docs](https://clickhouse-driver.readthedocs.io/en/latest/index.html) for more information\n- `CLICKHOUSE_VERIFY`: Optional - see [clickhouse-driver docs](https://clickhouse-driver.readthedocs.io/en/latest/index.html) for more information\n- `CLICKHOUSE_CA`: Optional - see [clickhouse-driver docs](https://clickhouse-driver.readthedocs.io/en/latest/index.html) for more information\n- `OPENAI_API_KEY`: Optional - enables the experimental \"AI Tools\" page, which currently features a natural language query editor\n- `OPENAI_MODEL`: Optional - a valid OpenAI model (e.g. `gpt-3.5-turbo`, `gpt-4`) that you have access to with the key above to be used for the AI features\n\n
\n\n## 🏡 Running locally\n\nTo run HouseWatch locally along with a local ClickHouse instance, execute: \n\n```bash\ndocker compose -f docker-compose.dev.yml up -d\n```\n\nthen go to http://localhost:8080\n\n## 💡 Motivation\n\nAt PostHog we manage a few large ClickHouse clusters and found ourselves in need of a tool to monitor and manage these more easily.\n\nClickHouse is fantastic at introspection, providing a lot of metadata about the system in its system tables so that it can be easily queried. However, knowing exactly how to query and parse the available information can be a difficult task. Over the years at PostHog, we've developed great intuition for how to debug ClickHouse issues using ClickHouse, and HouseWatch is the compilation of this knowledge into a tool.\n\nBeyond monitoring, we also built internal systems and processes for managing the clusters that spanned various platforms. We would use Grafana to look at metrics, SSH into nodes for running operations and using specialized tooling, query via Metabase to dig deeper into the data in the system tables and create dashboards, and then a combination of tools baked into the PostHog product for further debugging and streamlined operations such as our [async migrations](https://posthog.com/blog/async-migrations) tool, and internal views for listing queries and analyzing their performance.\n\nAs a result, we felt it was appropriate to have these tools live in one place. Ultimately, our vision for HouseWatch is that it can both serve the purpose of a pganalyze for the ClickHouse ecosystem, while also including tooling for taking action on insights derived from the analysis.\n\n## 🏗️ Status of the project\n\nHouseWatch is in its early days and we have a lot more features in mind that we'd like to build into it going forward. The code could also use some cleaning up :) As of right now, it is considered Beta software and you should exercise caution when using it in production.\n\nOne potential approach is to connect HouseWatch to ClickHouse using a read-only user. In this case, the cluster management features will not work (e.g. operations, query editor), but the analysis toolset will function normally.\n\nHouseWatch was created and is maintained by [PostHog](https://posthog.com) and [yakkomajuri](https://github.com/yakkomajuri).\n\n## ℹ️ Contributing\n\nContributions are certainly welcome! However, if you'd like to build a new feature, please open up an issue first.\n\n## ⭐ Features\n\n

Query performance

\n\n
\n \n \n
\n\n
\n \n \n
\n\n
\n

Schema stats

\n\n
\n \n \n
\n\n
\n

Query benchmarking

\n\n
\n \n \n
\n\n
\n

Logs

\n\n

\n\n

\n\n
\n

Query editor

\n\n

\n\n

\n\n
\n

Disk usage

\n\n

\n\n

\n\n
\n

Errors

\n\n

\n\n

\n\n
\n

Operations

\n\n

\n\n

\n\n\n\n## 🗒️ To-do list\n\nA public list of things we intend to do with HouseWatch in the near future.\n\n
\n\nSee list\n\n
\n\nFeatures\n\n- [ ] System issues tab\n- [ ] EXPLAIN visualizer\n- [ ] Multiple instance support\n- [ ] Stats on page cache hit percentage\n- [ ] Make operations resilient to Celery going down (as we do in PostHog with async migrations)\n- [ ] Read-only mode\n- [ ] Button to force refresh running queries list\n- [ ] Logs pagination\n- [ ] Allow copying example queries\n- [ ] Configurable time ranges\n- [ ] Whole cluster schema stats\n- [ ] More operation controls: view, delete, edit, re-run, display errors\n\nDeveloper experience\n\n- [ ] Configure instance from UI\n- [ ] Publish a Docker image\n- [ ] Development docker-compose.yml with baked in ClickHouse\n\nCleanup\n\n- [ ] Extract README images out of repo\n- [ ] Make banner subtitle work on dark mode\n- [ ] Fetch data independently on the query analyzer\n- [ ] Breakpoint for logs search\n- [ ] Run Django \"production server\"\n- [ ] Write tests :)\n- [ ] Query editor pipe all errors to client\n- [ ] Abstraction to load data from API as JSON\n\n
\n" }, { "path": "bin/celery", "content": "#!/bin/bash\nset -e\n\ncelery -A housewatch worker -B\n" }, { "path": "bin/docker", "content": "#!/bin/bash\nset -e\n\n./bin/migrate\n./bin/serve\n" }, { "path": "bin/migrate", "content": "#!/bin/bash\nset -e\n\npython manage.py migrate\n" }, { "path": "bin/serve", "content": "#!/bin/bash\nexec gunicorn housewatch.wsgi -c housewatch/gunicorn.conf.py \\\n --worker-tmp-dir /dev/shm\n" }, { "path": "bin/start", "content": "#!/bin/bash\n\nset -e\n\nexport DEBUG=1\n\n./bin/celery & python manage.py runserver\n" }, { "path": "charts/housewatch/.helmignore", "content": "# Patterns to ignore when building packages.\n# This supports shell glob matching, relative path matching, and\n# negation (prefixed with !). Only one pattern per line.\n.DS_Store\n# Common VCS dirs\n.git/\n.gitignore\n.bzr/\n.bzrignore\n.hg/\n.hgignore\n.svn/\n# Common backup files\n*.swp\n*.bak\n*.tmp\n*.orig\n*~\n# Various IDEs\n.project\n.idea/\n*.tmproj\n.vscode/\n" }, { "path": "charts/housewatch/Chart.yaml", "content": "apiVersion: v2\nname: housewatch\ndescription: Open source tool for monitoring and managing ClickHouse clusters\ntype: application\nversion: 0.1.9\nappVersion: \"0.1.2\"\ndependencies:\n - name: postgresql\n version: \"12.10.0\"\n repository: \"oci://registry-1.docker.io/bitnamicharts\"\n - name: rabbitmq\n version: \"12.1.3\"\n repository: \"oci://registry-1.docker.io/bitnamicharts\"\n" }, { "path": "charts/housewatch/templates/_helpers.tpl", "content": "{{/*\nExpand the name of the chart.\n*/}}\n{{- define \"housewatch.name\" -}}\n{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix \"-\" }}\n{{- end }}\n\n{{/*\nCreate a default fully qualified app name.\nWe truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).\nIf release name contains chart name it will be used as a full name.\n*/}}\n{{- define \"housewatch.fullname\" -}}\n{{- if .Values.fullnameOverride }}\n{{- .Values.fullnameOverride | trunc 63 | trimSuffix \"-\" }}\n{{- else }}\n{{- $name := default .Chart.Name .Values.nameOverride }}\n{{- if contains $name .Release.Name }}\n{{- .Release.Name | trunc 63 | trimSuffix \"-\" }}\n{{- else }}\n{{- printf \"%s-%s\" .Release.Name $name | trunc 63 | trimSuffix \"-\" }}\n{{- end }}\n{{- end }}\n{{- end }}\n\n{{/*\nCreate chart name and version as used by the chart label.\n*/}}\n{{- define \"housewatch.chart\" -}}\n{{- printf \"%s-%s\" .Chart.Name .Chart.Version | replace \"+\" \"_\" | trunc 63 | trimSuffix \"-\" }}\n{{- end }}\n\n{{/*\nCommon labels\n*/}}\n{{- define \"housewatch.labels\" -}}\nhelm.sh/chart: {{ include \"housewatch.chart\" . }}\n{{ include \"housewatch.selectorLabels\" . }}\n{{- if .Chart.AppVersion }}\napp.kubernetes.io/version: {{ .Chart.AppVersion | quote }}\n{{- end }}\napp.kubernetes.io/managed-by: {{ .Release.Service }}\n{{- end }}\n\n{{/*\nSelector labels\n*/}}\n{{- define \"housewatch.selectorLabels\" -}}\napp.kubernetes.io/name: {{ include \"housewatch.name\" . }}\napp.kubernetes.io/instance: {{ .Release.Name }}\n{{- end }}\n\n{{/*\nCreate the name of the service account to use\n*/}}\n{{- define \"housewatch.serviceAccountName\" -}}\n{{- if .Values.serviceAccount.create }}\n{{- default (include \"housewatch.fullname\" .) .Values.serviceAccount.name }}\n{{- else }}\n{{- default \"default\" .Values.serviceAccount.name }}\n{{- end }}\n{{- end }}\n" }, { "path": "charts/housewatch/templates/deployment-nginx.yaml", "content": "apiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: {{ include \"housewatch.fullname\" . }}-nginx\n labels:\n {{- include \"housewatch.labels\" . | nindent 4 }}\nspec:\n selector:\n matchLabels:\n {{- include \"housewatch.selectorLabels\" . | nindent 6 }}\n app.kubernetes.io/service: nginx\n template:\n metadata:\n {{- with .Values.podAnnotations }}\n annotations:\n {{- toYaml . | nindent 8 }}\n {{- end }}\n labels:\n {{- include \"housewatch.selectorLabels\" . | nindent 8 }}\n app.kubernetes.io/service: nginx\n spec:\n {{- with .Values.imagePullSecrets }}\n imagePullSecrets:\n {{- toYaml . | nindent 8 }}\n {{- end }}\n volumes:\n - name: frontend\n emptyDir: {}\n - name: nginx-config\n configMap:\n name: {{ include \"housewatch.fullname\" . }}-nginx\n initContainers:\n - name: frontend-copy\n image: \"{{ .Values.image.frontendRepository }}:{{ .Values.image.tag }}\"\n command: [sh, -cex]\n args:\n - cp -r /frontend/build/* /http/\n volumeMounts:\n - mountPath: /http\n name: frontend\n containers:\n - name: nginx\n image: \"{{ .Values.nginx.image.repository }}:{{ .Values.nginx.image.tag }}\"\n ports:\n - name: http\n containerPort: 80\n protocol: TCP\n volumeMounts:\n - mountPath: /http\n name: frontend\n - mountPath: /etc/nginx/nginx.conf\n name: nginx-config\n subPath: nginx.conf\n resources:\n {{- toYaml .Values.nginx.resources | nindent 12 }}\n" }, { "path": "charts/housewatch/templates/deployment-web.yaml", "content": "apiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: {{ include \"housewatch.fullname\" . }}\n labels:\n {{- include \"housewatch.labels\" . | nindent 4 }}\nspec:\n selector:\n matchLabels:\n {{- include \"housewatch.selectorLabels\" . | nindent 6 }}\n app.kubernetes.io/service: web\n template:\n metadata:\n {{- with .Values.podAnnotations }}\n annotations:\n {{- toYaml . | nindent 8 }}\n {{- end }}\n labels:\n {{- include \"housewatch.selectorLabels\" . | nindent 8 }}\n app.kubernetes.io/service: web\n spec:\n {{- with .Values.imagePullSecrets }}\n imagePullSecrets:\n {{- toYaml . | nindent 8 }}\n {{- end }}\n containers:\n - name: web\n image: \"{{ .Values.image.repository }}:{{ .Values.image.tag }}\"\n command: [\"bash\", \"-c\"]\n args:\n - |\n python manage.py migrate\n python manage.py runserver 0.0.0.0:8000\n ports:\n - name: api\n containerPort: 8000\n protocol: TCP\n env:\n - name: REDIS_URL\n value: redis://{{ include \"housewatch.fullname\" . }}-redis:6379\n - name: CLICKHOUSE_HOST\n value: \"{{ .Values.clickhouse.host }}\"\n - name: CLICKHOUSE_DATABASE\n value: \"{{ .Values.clickhouse.database }}\"\n - name: CLICKHOUSE_USER\n value: \"{{ .Values.clickhouse.user }}\"\n - name: CLICKHOUSE_PASSWORD\n valueFrom:\n secretKeyRef:\n name: \"{{ .Values.clickhouse.secretName }}\"\n key: \"{{ .Values.clickhouse.secretPasswordKey }}\"\n - name: CLICKHOUSE_CLUSTER\n value: {{ .Values.clickhouse.cluster }}\n - name: CLICKHOUSE_SECURE\n value: \"{{ .Values.clickhouse.secure }}\"\n - name: CLICKHOUSE_VERIFY\n value: \"{{ .Values.clickhouse.verify }}\"\n - name: CLICKHOUSE_CA\n value: \"{{ .Values.clickhouse.ca }}\"\n - name: DATABASE_URL\n value: \"{{ . | tpl .Values.database_url }}\"\n - name: RABBITMQ_URL\n value: \"amqp://{{ .Values.rabbitmq.auth.username }}:{{ .Values.rabbitmq.auth.password }}@{{ .Release.Name }}-rabbitmq:5672/\" \n livenessProbe:\n httpGet:\n path: /\n port: api\n readinessProbe:\n httpGet:\n path: /\n port: api\n resources:\n {{- toYaml .Values.web.resources | nindent 12 }}\n" }, { "path": "charts/housewatch/templates/deployment-worker.yaml", "content": "apiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: {{ include \"housewatch.fullname\" . }}-worker\n labels:\n {{- include \"housewatch.labels\" . | nindent 4 }}\nspec:\n selector:\n matchLabels:\n {{- include \"housewatch.selectorLabels\" . | nindent 6 }}\n app.kubernetes.io/service: worker\n template:\n metadata:\n {{- with .Values.podAnnotations }}\n annotations:\n {{- toYaml . | nindent 8 }}\n {{- end }}\n labels:\n {{- include \"housewatch.selectorLabels\" . | nindent 8 }}\n app.kubernetes.io/service: worker\n spec:\n {{- with .Values.imagePullSecrets }}\n imagePullSecrets:\n {{- toYaml . | nindent 8 }}\n {{- end }}\n containers:\n - name: worker\n image: \"{{ .Values.image.repository }}:{{ .Values.image.tag }}\"\n command: [\"./bin/celery\"]\n env:\n - name: REDIS_URL\n value: redis://{{ include \"housewatch.fullname\" . }}-redis:6379\n - name: CLICKHOUSE_HOST\n value: \"{{ .Values.clickhouse.host }}\"\n - name: CLICKHOUSE_DATABASE\n value: \"{{ .Values.clickhouse.database }}\"\n - name: CLICKHOUSE_USER\n value: \"{{ .Values.clickhouse.user }}\"\n - name: CLICKHOUSE_PASSWORD\n valueFrom:\n secretKeyRef:\n name: \"{{ .Values.clickhouse.secretName }}\"\n key: \"{{ .Values.clickhouse.secretPasswordKey }}\"\n - name: CLICKHOUSE_CLUSTER\n value: \"{{ .Values.clickhouse.cluster }}\"\n - name: CLICKHOUSE_SECURE\n value: \"{{ .Values.clickhouse.secure }}\"\n - name: CLICKHOUSE_VERIFY\n value: \"{{ .Values.clickhouse.verify }}\"\n - name: CLICKHOUSE_CA\n value: \"{{ .Values.clickhouse.ca }}\"\n - name: DATABASE_URL\n value: \"{{ . | tpl .Values.database_url }}\"\n - name: RABBITMQ_URL\n value: \"amqp://{{ .Values.rabbitmq.auth.username }}:{{ .Values.rabbitmq.auth.password }}@{{ .Release.Name }}-rabbitmq:5672/\" \n resources:\n {{- toYaml .Values.worker.resources | nindent 12 }}\n" }, { "path": "charts/housewatch/templates/nginx-configmap.yaml", "content": "apiVersion: v1\nkind: ConfigMap\nmetadata:\n name: {{ include \"housewatch.fullname\" . }}-nginx\ndata:\n nginx.conf: |\n events {\n worker_connections 1024;\n }\n http {\n include /etc/nginx/mime.types;\n default_type application/octet-stream;\n\n sendfile on;\n keepalive_timeout 65;\n\n server {\n listen 80;\n\n location / {\n root /http;\n try_files $uri $uri/ /index.html =404;\n }\n\n location /api {\n proxy_pass http://{{ include \"housewatch.fullname\" . }}-api:8000;\n proxy_http_version 1.1;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection 'upgrade';\n proxy_set_header Host $host;\n }\n\n location /admin {\n proxy_pass http://{{ include \"housewatch.fullname\" . }}-api:8000;\n proxy_http_version 1.1;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection 'upgrade';\n proxy_set_header Host $host;\n }\n\n location /healthz {\n proxy_pass http://{{ include \"housewatch.fullname\" . }}-api:8000;\n proxy_http_version 1.1;\n proxy_set_header Upgrade $http_upgrade;\n proxy_set_header Connection 'upgrade';\n proxy_set_header Host $host;\n }\n }\n }\n" }, { "path": "charts/housewatch/templates/redis.yaml", "content": "apiVersion: apps/v1\nkind: Deployment\nmetadata:\n name: {{ include \"housewatch.fullname\" . }}-redis\n labels:\n {{- include \"housewatch.labels\" . | nindent 4 }}\nspec:\n replicas: 1\n selector:\n matchLabels:\n {{- include \"housewatch.selectorLabels\" . | nindent 6 }}\n app.kubernetes.io/service: redis\n template:\n metadata:\n {{- with .Values.podAnnotations }}\n annotations:\n {{- toYaml . | nindent 8 }}\n {{- end }}\n labels:\n {{- include \"housewatch.selectorLabels\" . | nindent 8 }}\n app.kubernetes.io/service: redis\n spec:\n containers:\n - name: redis\n image: \"{{ .Values.redis.image.repository }}:{{ .Values.redis.image.tag }}\"\n imagePullPolicy: {{ .Values.image.pullPolicy }}\n ports:\n - name: redis\n containerPort: 6379\n protocol: TCP\n resources:\n {{- toYaml .Values.redis.resources | nindent 12 }}\n" }, { "path": "charts/housewatch/templates/service.yaml", "content": "apiVersion: v1\nkind: Service\nmetadata:\n name: {{ include \"housewatch.fullname\" . }}\n annotations:\n {{- toYaml .Values.service.annotations | nindent 4 }}\n labels:\n {{- include \"housewatch.labels\" . | nindent 4 }}\nspec:\n type: ClusterIP\n ports:\n - port: 80\n targetPort: http\n protocol: TCP\n name: http\n selector:\n {{- include \"housewatch.selectorLabels\" . | nindent 4 }}\n app.kubernetes.io/service: nginx\n---\napiVersion: v1\nkind: Service\nmetadata:\n name: {{ include \"housewatch.fullname\" . }}-api\n labels:\n {{- include \"housewatch.labels\" . | nindent 4 }}\nspec:\n type: ClusterIP\n ports:\n - port: 8000\n targetPort: api\n protocol: TCP\n name: api\n selector:\n {{- include \"housewatch.selectorLabels\" . | nindent 4 }}\n app.kubernetes.io/service: web\n---\napiVersion: v1\nkind: Service\nmetadata:\n name: {{ include \"housewatch.fullname\" . }}-redis\n labels:\n {{- include \"housewatch.labels\" . | nindent 4 }}\nspec:\n type: ClusterIP\n ports:\n - port: 6379\n targetPort: 6379\n protocol: TCP\n name: redis\n selector:\n {{- include \"housewatch.selectorLabels\" . | nindent 4 }}\n app.kubernetes.io/service: redis\n" }, { "path": "charts/housewatch/values.yaml", "content": "image:\n repository: ghcr.io/posthog/housewatch/api\n frontendRepository: ghcr.io/posthog/housewatch/frontend\n tag: main\n\nnginx:\n image:\n repository: nginx\n tag: stable\n\nclickhouse:\n user: default\n host: clickhouse\n database: default\n secure: \"false\"\n verify: \"false\"\n ca: \"\"\n\nservice:\n annotations: {}\n\nweb:\n resources:\n requests:\n cpu: 100m\n memory: 500Mi\n limits:\n memory: 500Mi\n\nfrontend:\n resources:\n requests:\n cpu: 500m\n memory: 2Gi\n limits:\n memory: 2Gi\n\nworker:\n resources:\n requests:\n cpu: 100m\n memory: 1500Mi\n limits:\n memory: 1500Mi\n\ndatabase_url: postgres://housewatch:housewatch@{{ include \"postgresql.primary.fullname\" .Subcharts.postgresql }}:5432/housewatch\npostgresql:\n auth:\n database: housewatch\n username: housewatch\n password: housewatch\n\nrabbitmq:\n auth:\n username: housewatch\n password: housewatch\n erlangCookie: housewatch\n\nredis:\n image:\n repository: redis\n tag: 6.2.7-alpine\n\n resources:\n requests:\n cpu: 100m\n memory: 1Gi\n limits:\n memory: 1Gi\n" }, { "path": "docker/Caddyfile", "content": "{\n debug\n}\n\n{$SITE_ADDRESS} {\n reverse_proxy web:3000\n reverse_proxy /api/* app:8000\n reverse_proxy /logout app:8000\n reverse_proxy /admin/ app:8000\n}\n" }, { "path": "docker/clickhouse-server/config.d/config.xml", "content": "\n \n ::\n 0.0.0.0\n 1\n\n \n \n \n \n \n clickhouse\n 9000\n \n \n \n \n" }, { "path": "docker-compose.dev.yml", "content": "version: \"3\"\n\nservices:\n app:\n build: .\n environment: &django_env\n DEBUG: 1\n REDIS_URL: redis://redis:6379\n RABBITMQ_URL: amqp://posthog:posthog@rabbitmq:5672\n DATABASE_URL: postgres://housewatch:housewatch@db:5432/housewatch\n CLICKHOUSE_HOST: clickhouse\n CLICKHOUSE_DATABASE: default\n CLICKHOUSE_USER: default\n CLICKHOUSE_PASSWORD: \"\"\n CLICKHOUSE_CLUSTER: housewatch\n CLICKHOUSE_SECURE: false\n CLICKHOUSE_VERIFY: false\n CLICKHOUSE_CA: \"\"\n AWS_ACCESS_KEY_ID: $AWS_ACCESS_KEY_ID\n AWS_SECRET_ACCESS_KEY: $AWS_SECRET_ACCESS_KEY\n AWS_DEFAULT_REGION: $AWS_DEFAULT_REGION\n command:\n - bash\n - -c\n - |\n python manage.py runserver 0.0.0.0:8000\n ports:\n - \"8000:8000\"\n volumes:\n - .:/code\n depends_on:\n migrations:\n condition: service_completed_successfully\n clickhouse:\n condition: service_started\n db:\n condition: service_healthy\n redis:\n condition: service_started\n rabbitmq:\n condition: service_started\n\n migrations:\n build: .\n environment: *django_env\n command: python manage.py migrate\n depends_on:\n db:\n condition: service_healthy\n volumes:\n - .:/code\n\n web:\n build:\n context: ./frontend\n dockerfile: Dockerfile.dev\n\n caddy:\n image: caddy:2.6.1\n restart: unless-stopped\n ports:\n - \"8080:8080\"\n - \"443:443\"\n environment:\n SITE_ADDRESS: \":8080\"\n volumes:\n - ./docker/Caddyfile:/etc/caddy/Caddyfile\n depends_on:\n - web\n - app\n\n db:\n image: postgres:16-alpine\n restart: on-failure\n environment:\n POSTGRES_USER: housewatch\n POSTGRES_DB: housewatch\n POSTGRES_PASSWORD: housewatch\n\n healthcheck:\n test: [\"CMD-SHELL\", \"pg_isready -U housewatch\"]\n interval: 5s\n timeout: 5s\n ports:\n - \"5432:5432\"\n\n redis:\n image: redis:6.2.7-alpine\n restart: on-failure\n command: redis-server --maxmemory-policy allkeys-lru --maxmemory 200mb\n\n worker:\n build: .\n environment:\n <<: *django_env\n command:\n - ./bin/celery\n volumes:\n - .:/code\n depends_on:\n - clickhouse\n - db\n - redis\n - rabbitmq\n\n clickhouse:\n image: ${CLICKHOUSE_SERVER_IMAGE:-clickhouse/clickhouse-server:23.12.5}\n restart: on-failure\n depends_on:\n - zookeeper\n volumes:\n - ./docker/clickhouse-server/config.d:/etc/clickhouse-server/config.d\n ports:\n - \"8123:8123\"\n\n zookeeper:\n image: zookeeper:3.7.0\n restart: on-failure\n\n rabbitmq:\n image: rabbitmq:3.12.2-management-alpine\n ports:\n - \"15672:15672\" # Web management UI\n - \"5672:5672\" # Default RabbitMQ broker port\n environment:\n RABBITMQ_DEFAULT_USER: posthog\n RABBITMQ_DEFAULT_PASS: posthog\n" }, { "path": "docker-compose.yml", "content": "version: \"3\"\n\nservices:\n app:\n build: .\n environment: &django_env\n DATABASE_URL: postgres://housewatch:housewatch@db:5432/housewatch\n RABBITMQ_URL: amqp://posthog:posthog@rabbitmq:5672\n REDIS_URL: redis://redis:6379\n CLICKHOUSE_HOST: $CLICKHOUSE_HOST\n CLICKHOUSE_DATABASE: $CLICKHOUSE_DATABASE\n CLICKHOUSE_USER: $CLICKHOUSE_USER\n CLICKHOUSE_PASSWORD: $CLICKHOUSE_PASSWORD\n CLICKHOUSE_CLUSTER: $CLICKHOUSE_CLUSTER\n CLICKHOUSE_SECURE: $CLICKHOUSE_SECURE\n CLICKHOUSE_VERIFY: $CLICKHOUSE_VERIFY\n CLICKHOUSE_CA: $CLICKHOUSE_CA\n AWS_ACCESS_KEY_ID: $AWS_ACCESS_KEY_ID\n AWS_SECRET_ACCESS_KEY: $AWS_SECRET_ACCESS_KEY\n AWS_DEFAULT_REGION: $AWS_DEFAULT_REGION\n\n command:\n - bash\n - -c\n - |\n python manage.py migrate\n python manage.py runserver 0.0.0.0:8000\n volumes:\n - .:/code\n ports:\n - \"8000:8000\"\n depends_on:\n - db\n - redis\n - rabbitmq\n - clickhouse\n\n web:\n build: ./frontend\n ports:\n - \"3000:3000\"\n\n worker:\n build: .\n environment:\n <<: *django_env\n command:\n - ./bin/celery\n volumes:\n - .:/code\n depends_on:\n - db\n - redis\n - rabbitmq\n - clickhouse\n\n redis:\n image: redis:6.2.7-alpine\n restart: on-failure\n ports:\n - \"6388:6379\"\n command: redis-server --maxmemory-policy allkeys-lru --maxmemory 200mb\n\n db:\n image: postgres:14-alpine\n restart: on-failure\n environment:\n POSTGRES_USER: housewatch\n POSTGRES_DB: housewatch\n POSTGRES_PASSWORD: housewatch\n\n caddy:\n image: caddy:2.6.1\n restart: unless-stopped\n ports:\n - \"80:80\"\n - \"443:443\"\n environment:\n SITE_ADDRESS: $SITE_ADDRESS\n volumes:\n - ./docker/Caddyfile:/etc/caddy/Caddyfile\n depends_on:\n - web\n - app\n\n rabbitmq:\n image: rabbitmq:3.12.2-management-alpine\n ports:\n - \"15672:15672\" # Web management UI\n - \"5672:5672\" # Default RabbitMQ broker port\n environment:\n RABBITMQ_DEFAULT_USER: posthog\n RABBITMQ_DEFAULT_PASS: posthog\n" }, { "path": "frontend/.gitignore", "content": "# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.\n\n# dependencies\n/node_modules\n/.pnp\n.pnp.js\n\n# testing\n/coverage\n\n# production\n/build\n\n# misc\n.DS_Store\n.env.local\n.env.development.local\n.env.test.local\n.env.production.local\n\nnpm-debug.log*\nyarn-debug.log*\nyarn-error.log*\n" }, { "path": "frontend/.node-version", "content": "20.4.0\n" }, { "path": "frontend/.prettierrc", "content": "{\n \"trailingComma\": \"es5\",\n \"tabWidth\": 4,\n \"semi\": false,\n \"singleQuote\": true,\n \"printWidth\": 120\n}\n" }, { "path": "frontend/Dockerfile", "content": "FROM alpine:latest\n\nWORKDIR /frontend\n\nCOPY build/ build/\n\nCMD [\"echo\", \"Serve the files from /frontend/build, don't run this container directly\"]" }, { "path": "frontend/Dockerfile.dev", "content": "FROM node:20.4.0-alpine\n\nENV PNPM_HOME=\"/pnpm\"\nENV PATH=\"$PNPM_HOME:$PATH\"\n\nRUN corepack enable\n\nWORKDIR /frontend\n\nCOPY . .\n\nRUN pnpm i\n\nCMD [\"pnpm\", \"vite\", \"--port\", \"3000\", \"--host\"]\n" }, { "path": "frontend/README.md", "content": "# Getting Started with Create React App\n\nThis project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).\n\n## Available Scripts\n\nIn the project directory, you can run:\n\n### `npm start`\n\nRuns the app in the development mode.\\\nOpen [http://localhost:3000](http://localhost:3000) to view it in the browser.\n\nThe page will reload if you make edits.\\\nYou will also see any lint errors in the console.\n\n### `npm test`\n\nLaunches the test runner in the interactive watch mode.\\\nSee the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.\n\n### `npm run build`\n\nBuilds the app for production to the `build` folder.\\\nIt correctly bundles React in production mode and optimizes the build for the best performance.\n\nThe build is minified and the filenames include the hashes.\\\nYour app is ready to be deployed!\n\nSee the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.\n\n### `npm run eject`\n\n**Note: this is a one-way operation. Once you `eject`, you can’t go back!**\n\nIf you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.\n\nInstead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.\n\nYou don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.\n\n## Learn More\n\nYou can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).\n\nTo learn React, check out the [React documentation](https://reactjs.org/).\n" }, { "path": "frontend/index.html", "content": "\n\n \n \n \n \n \n \n \n HouseWatch\n \n \n \n
\n \n \n\n" }, { "path": "frontend/package.json", "content": "{\n \"name\": \"housewatch\",\n \"version\": \"1.0.0-beta\",\n \"dependencies\": {\n \"@ant-design/charts\": \"^1.4.2\",\n \"@ant-design/icons\": \"^5.2.0\",\n \"@ant-design/plots\": \"^2.1.12\",\n \"antd\": \"^5.13.2\",\n \"prismjs\": \"^1.29.0\",\n \"react\": \"^18.2.0\",\n \"react-dom\": \"^18.2.0\",\n \"react-router-dom\": \"5.2.0\",\n \"react-scripts\": \"^2.1.3\",\n \"react-simple-code-editor\": \"^0.13.1\",\n \"sql-formatter-plus\": \"^1.3.6\",\n \"swr\": \"^2.2.4\",\n \"typescript\": \"^4.9.5\",\n \"uuid\": \"^9.0.0\"\n },\n \"devDependencies\": {\n \"@types/jest\": \"^27.5.2\",\n \"@types/lodash\": \"^4.14.192\",\n \"@types/node\": \"^16.18.22\",\n \"@types/react\": \"^18.2.21\",\n \"@types/react-dom\": \"^18.2.7\",\n \"@types/react-router-dom\": \"5.3.3\",\n \"@types/uuid\": \"^9.0.1\",\n \"@vitejs/plugin-react\": \"^4.2.1\",\n \"vite\": \"^5.0.12\"\n },\n \"pnpm\": {\n \"overrides\": {\n \"node-forge\": \"1.3.2\"\n }\n },\n \"scripts\": {\n \"dev\": \"vite\",\n \"build\": \"tsc && vite build\",\n \"lint\": \"eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0\",\n \"preview\": \"vite preview\"\n },\n \"eslintConfig\": {\n \"extends\": [\n \"react-app\",\n \"react-app/jest\"\n ]\n },\n \"proxy\": \"http://localhost:8000\",\n \"browserslist\": {\n \"production\": [\n \">0.2%\",\n \"not dead\",\n \"not op_mini all\"\n ],\n \"development\": [\n \"last 1 chrome version\",\n \"last 1 firefox version\",\n \"last 1 safari version\"\n ]\n },\n \"packageManager\": \"pnpm@9.15.9+sha512.68046141893c66fad01c079231128e9afb89ef87e2691d69e4d40eee228988295fd4682181bae55b58418c3a253bde65a505ec7c5f9403ece5cc3cd37dcf2531\"\n}\n" }, { "path": "frontend/public/fonts/OFL.txt", "content": "Copyright (c) 2015 Indian Type Foundry (info@indiantypefoundry.com)\r\n\r\nThis Font Software is licensed under the SIL Open Font License, Version 1.1.\r\nThis license is copied below, and is also available with a FAQ at:\r\nhttp://scripts.sil.org/OFL\r\n\r\n\r\n-----------------------------------------------------------\r\nSIL OPEN FONT LICENSE Version 1.1 - 26 February 2007\r\n-----------------------------------------------------------\r\n\r\nPREAMBLE\r\nThe goals of the Open Font License (OFL) are to stimulate worldwide\r\ndevelopment of collaborative font projects, to support the font creation\r\nefforts of academic and linguistic communities, and to provide a free and\r\nopen framework in which fonts may be shared and improved in partnership\r\nwith others.\r\n\r\nThe OFL allows the licensed fonts to be used, studied, modified and\r\nredistributed freely as long as they are not sold by themselves. The\r\nfonts, including any derivative works, can be bundled, embedded,\r\nredistributed and/or sold with any software provided that any reserved\r\nnames are not used by derivative works. The fonts and derivatives,\r\nhowever, cannot be released under any other type of license. The\r\nrequirement for fonts to remain under this license does not apply\r\nto any document created using the fonts or their derivatives.\r\n\r\nDEFINITIONS\r\n\"Font Software\" refers to the set of files released by the Copyright\r\nHolder(s) under this license and clearly marked as such. This may\r\ninclude source files, build scripts and documentation.\r\n\r\n\"Reserved Font Name\" refers to any names specified as such after the\r\ncopyright statement(s).\r\n\r\n\"Original Version\" refers to the collection of Font Software components as\r\ndistributed by the Copyright Holder(s).\r\n\r\n\"Modified Version\" refers to any derivative made by adding to, deleting,\r\nor substituting -- in part or in whole -- any of the components of the\r\nOriginal Version, by changing formats or by porting the Font Software to a\r\nnew environment.\r\n\r\n\"Author\" refers to any designer, engineer, programmer, technical\r\nwriter or other person who contributed to the Font Software.\r\n\r\nPERMISSION & CONDITIONS\r\nPermission is hereby granted, free of charge, to any person obtaining\r\na copy of the Font Software, to use, study, copy, merge, embed, modify,\r\nredistribute, and sell modified and unmodified copies of the Font\r\nSoftware, subject to the following conditions:\r\n\r\n1) Neither the Font Software nor any of its individual components,\r\nin Original or Modified Versions, may be sold by itself.\r\n\r\n2) Original or Modified Versions of the Font Software may be bundled,\r\nredistributed and/or sold with any software, provided that each copy\r\ncontains the above copyright notice and this license. These can be\r\nincluded either as stand-alone text files, human-readable headers or\r\nin the appropriate machine-readable metadata fields within text or\r\nbinary files as long as those fields can be easily viewed by the user.\r\n\r\n3) No Modified Version of the Font Software may use the Reserved Font\r\nName(s) unless explicit written permission is granted by the corresponding\r\nCopyright Holder. This restriction only applies to the primary font name as\r\npresented to the users.\r\n\r\n4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font\r\nSoftware shall not be used to promote, endorse or advertise any\r\nModified Version, except to acknowledge the contribution(s) of the\r\nCopyright Holder(s) and the Author(s) or with their explicit written\r\npermission.\r\n\r\n5) The Font Software, modified or unmodified, in part or in whole,\r\nmust be distributed entirely under this license, and must not be\r\ndistributed under any other license. The requirement for fonts to\r\nremain under this license does not apply to any document created\r\nusing the Font Software.\r\n\r\nTERMINATION\r\nThis license becomes null and void if any of the above conditions are\r\nnot met.\r\n\r\nDISCLAIMER\r\nTHE FONT SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\r\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF\r\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT\r\nOF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE\r\nCOPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\r\nINCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL\r\nDAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\r\nFROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM\r\nOTHER DEALINGS IN THE FONT SOFTWARE.\r\n" }, { "path": "frontend/public/index.html", "content": "\n\n \n \n \n \n \n \n \n \n \n HouseWatch\n \n \n \n
\n \n\n" }, { "path": "frontend/public/manifest.json", "content": "{\n \"short_name\": \"HouseWatch\",\n \"name\": \"HouseWatch\",\n \"icons\": [],\n \"start_url\": \".\",\n \"display\": \"standalone\",\n \"theme_color\": \"#000000\",\n \"background_color\": \"#ffffff\"\n}\n" }, { "path": "frontend/public/robots.txt", "content": "# https://www.robotstxt.org/robotstxt.html\nUser-agent: *\nDisallow:\n" }, { "path": "frontend/src/App.tsx", "content": "import React from 'react'\nimport { BrowserRouter as Router } from 'react-router-dom'\nimport Layout from './Layout'\n\nfunction App() {\n return (\n
\n \n \n \n
\n )\n}\n\nexport default App\n" }, { "path": "frontend/src/Layout.tsx", "content": "// @ts-nocheck\nimport React, { useEffect, useState } from 'react'\nimport { DiskUsage } from './pages/DiskUsage/DiskUsage'\nimport SlowQueries from './pages/SlowQueries/SlowQueries'\nimport Schema from './pages/SchemaStats/SchemaStats'\nimport QueryDetail from './pages/SlowQueries/QueryDetail'\nimport SchemaTable from './pages/SchemaStats/SchemaTable'\nimport Overview from './pages/Overview/Overview'\nimport Clusters from './pages/Clusters/Clusters'\nimport Backups from './pages/Backups/Backups'\nimport ScheduledBackups from './pages/Backups/ScheduledBackups'\nimport Errors from './pages/Errors/Errors'\nimport { Switch, Route, useHistory } from 'react-router-dom'\n\nimport { Operations } from './pages/Operations/Operations'\nimport RunningQueries from './pages/RunningQueries/RunningQueries'\nimport Logs from './pages/Logs/Logs'\nimport {\n ApartmentOutlined,\n CloudServerOutlined,\n CodeOutlined,\n DashboardOutlined,\n HddOutlined,\n HomeOutlined,\n WarningOutlined,\n ClockCircleOutlined,\n GithubFilled,\n BarsOutlined,\n FormOutlined,\n ToolOutlined,\n SaveOutlined,\n} from '@ant-design/icons'\nimport { ConfigProvider, MenuProps } from 'antd'\nimport { Layout, Menu } from 'antd'\nimport QueryEditorPage from './pages/QueryEditor/QueryEditorPage'\nimport AIToolsPage from './pages/AITools/AIToolsPage'\n\nconst { Header, Content, Footer, Sider } = Layout\n\ntype MenuItem = Required['items'][number]\n\nconst items: MenuItem[] = [\n { key: '', icon: , label: 'Overview' },\n { key: 'clusters', label: 'Clusters', icon: },\n {\n key: 'backup',\n label: 'Backup',\n icon: ,\n children: [\n { key: 'backups', label: 'Adhoc Backups' },\n { key: 'scheduled_backups', label: 'Scheduled Backups' },\n ],\n },\n { key: 'query_performance', label: 'Query performance', icon: },\n { key: 'running_queries', label: 'Running queries', icon: },\n { key: 'schema', label: 'Schema stats', icon: },\n { key: 'disk_usage', label: 'Disk usage', icon: },\n { key: 'logs', label: 'Logs', icon: },\n { key: 'errors', label: 'Errors', icon: },\n { key: 'query_editor', label: 'Query editor', icon: },\n { key: 'operations', label: 'Operations', icon: },\n { key: 'ai_tools', label: 'AI Tools', icon: },\n]\n\nexport default function AppLayout(): JSX.Element {\n const [hostname, setHostname] = useState('')\n\n const fetchHostname = async () => {\n const response = await fetch(`/api/analyze/hostname`)\n const responseJson = await response.json()\n setHostname(responseJson.hostname)\n }\n\n useEffect(() => {\n fetchHostname()\n }, [])\n\n const history = useHistory()\n const openPage = history.location.pathname.split('/')[1]\n\n return (\n \n \n \n
history.push('')}>\n \n HouseWatch\n \n
\n history.push(`/${info.key}`)}\n />\n \n \n \n

\n {hostname}\n

\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n )\n}\n" }, { "path": "frontend/src/index.css", "content": "@font-face {\n font-family: 'Hind Siliguri';\n src: url('fonts/HindSiliguri-Medium.ttf');\n}\n\nhtml {\n overflow: hidden;\n height: 100%;\n}\n\nbody {\n margin: 0;\n font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', 'Cantarell', 'Fira Sans',\n 'Droid Sans', 'Helvetica Neue', sans-serif;\n -webkit-font-smoothing: antialiased;\n -moz-osx-font-smoothing: grayscale;\n color: #262626;\n font-size: 0.875rem;\n line-height: 1.57;\n font-weight: 400;\n overflow: auto;\n height: 100%;\n}\n\n.ant-menu-item-selected {\n color: black !important;\n}\n\nh1 {\n font-size: 24px;\n}\n\nh1,\nh2,\nh3,\nh4,\nh5,\nh6 {\n font-family: sans-serif;\n}\n\nstrong,\nb {\n font-weight: 600;\n}\n\ncode {\n font-family: source-code-pro, Menlo, Monaco, Consolas, 'Courier New', monospace;\n}\n\n.clickable:hover,\n.clickable div:hover,\n.code-editor:hover textarea {\n cursor: pointer !important;\n}\n\n.code-editor textarea {\n line-height: 2 !important;\n font-weight: 100 !important;\n}\n\n.code-editor:hover {\n background-color: #ededed;\n}\n\n.ant-tabs-tab-active .ant-tabs-tab-btn,\n.ant-tabs-tab-btn:hover {\n color: #1677ff !important;\n}\n\n.ant-tabs-ink-bar {\n background: #1677ff !important;\n}\n\n.run-async-migration-btn:hover {\n border-color: #64a0f4 !important;\n background: #13a5ff !important;\n}\n\ninput,\ntextarea,\nbutton,\nselect,\n.ant-select-selector {\n box-shadow: none !important;\n}\n\n.sidebar .ant-layout-sider-children {\n position: fixed;\n}\n\n.ant-select-item-option-selected:not(.ant-select-item-option-disabled) {\n background-color: initial !important;\n}\n" }, { "path": "frontend/src/index.tsx", "content": "import React from 'react'\nimport ReactDOM from 'react-dom/client'\nimport './index.css'\nimport App from './App'\n\nconst root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement)\nroot.render()\n" }, { "path": "frontend/src/pages/AITools/AIToolsPage.tsx", "content": "import React, { useEffect, useState } from 'react'\nimport { Tabs } from 'antd'\nimport { useHistory } from 'react-router-dom'\nimport NaturalLanguageQueryEditor from './NaturalLanguageQueryEditor'\n\nexport default function AIToolsPage() {\n const history = useHistory()\n const [error, setError] = useState(null)\n\n const loadData = async () => {\n const res = await fetch('/api/analyze/ai_tools_available')\n const resJson = await res.json()\n if ('error' in resJson) {\n setError(resJson['error'])\n }\n }\n\n useEffect(() => {\n loadData()\n }, [])\n\n return (\n <>\n

AI Tools (Alpha)

\n {error ? (\n

{error}

\n ) : (\n <>\n ,\n },\n ]}\n defaultActiveKey=\"natural_language\"\n onChange={(tab) => history.push(`/query_editor/${tab}`)}\n />\n \n )}\n \n )\n}\n" }, { "path": "frontend/src/pages/AITools/NaturalLanguageQueryEditor.tsx", "content": "import React, { useEffect, useState } from 'react'\nimport { Select, Checkbox, Button, Table, ConfigProvider } from 'antd'\nimport TextArea from 'antd/es/input/TextArea'\n// @ts-ignore\nimport { highlight, languages } from 'prismjs/components/prism-core' // @ts-ignore\nimport 'prismjs/components/prism-sql'\nimport 'prismjs/themes/prism.css'\nimport Editor from 'react-simple-code-editor'\n// @ts-ignore\nimport { format } from 'sql-formatter-plus'\n\nexport interface TableData {\n table: string\n database: string\n}\n\nexport default function NaturalLanguageQueryEditor() {\n const [query, setQuery] = useState('')\n const [tables, setTables] = useState(null)\n const [tablesToQuery, setTablesToQuery] = useState([])\n const [readonly, setReadonly] = useState(true)\n const [data, setData] = useState([{}])\n const [sql, setSql] = useState(null)\n const [loading, setLoading] = useState(false)\n const [error, setError] = useState('')\n\n const columns = data.length > 0 ? Object.keys(data[0]).map((column) => ({ title: column, dataIndex: column })) : []\n\n const runQuery = async () => {\n setLoading(true)\n setSql(null)\n const res = await fetch('/api/analyze/natural_language_query', {\n method: 'POST',\n headers: {\n 'Content-Type': 'application/json',\n },\n body: JSON.stringify({\n query: query,\n tables_to_query: tablesToQuery,\n readonly: readonly || false,\n }),\n })\n const resJson = await res.json()\n if (resJson.error) {\n setError(resJson.error)\n setData([])\n } else {\n setData(resJson.result)\n }\n setSql(resJson.sql)\n setLoading(false)\n }\n const loadTableData = async () => {\n const res = await fetch('/api/analyze/tables')\n const resJson = await res.json()\n setTables(resJson)\n }\n\n useEffect(() => {\n loadTableData()\n }, [])\n\n const selectOptions = (tables || []).map((t) => ({\n value: [t.database, t.table].join('>>>>>'),\n label: [t.database, t.table].join('.'),\n }))\n\n return (\n <>\n
\n
\n

Select the tables you'd like to query:

\n {\n setTablesToQuery(value)\n }}\n mode=\"multiple\"\n showSearch={false}\n />\n
\n
\n
\n setReadonly(e.target.value)}>\n Read-only\n \n
\n
\n
\n

Describe what you'd like to query (the more specific the better):

\n