{"id":15178695,"url":"https://github.com/grafana/k6-timescaledb-stack","last_synced_at":"2025-10-01T19:31:01.272Z","repository":{"id":47498753,"uuid":"220655676","full_name":"grafana/k6-timescaledb-stack","owner":"grafana","description":"Load testing stack - k6, TimescaleDB and Grafana","archived":true,"fork":false,"pushed_at":"2022-02-04T17:15:31.000Z","size":1118,"stargazers_count":30,"open_issues_count":0,"forks_count":3,"subscribers_count":135,"default_branch":"master","last_synced_at":"2024-10-28T03:14:41.849Z","etag":null,"topics":["grafana","k6","load-testing","performance-monitoring","performance-testing","timescaledb"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/grafana.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-11-09T14:40:08.000Z","updated_at":"2023-01-28T03:22:49.000Z","dependencies_parsed_at":"2022-08-28T16:02:07.954Z","dependency_job_id":null,"html_url":"https://github.com/grafana/k6-timescaledb-stack","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grafana%2Fk6-timescaledb-stack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grafana%2Fk6-timescaledb-stack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grafana%2Fk6-timescaledb-stack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grafana%2Fk6-timescaledb-stack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/grafana","download_url":"https://codeload.github.com/grafana/k6-timescaledb-stack/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234892715,"owners_count":18902907,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["grafana","k6","load-testing","performance-monitoring","performance-testing","timescaledb"],"created_at":"2024-09-27T15:21:40.444Z","updated_at":"2025-10-01T19:31:00.896Z","avatar_url":"https://github.com/grafana.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003e ### ⚠ ️ This project is no longer maintained in this repository. \n\u003e \n\u003e Development and maintenance have been stopped in this repository. \n\u003e \n\u003e This project is active and maintained at [grafana/xk6-output-timescaledb](https://github.com/grafana/xk6-output-timescaledb).\n\n\nThis project is a stack of open source software that works well together for the purpose of running load tests, storing results and visualizing those results in dashboards. The stack is made up of [k6](https://k6.io/), [TimescaleDB](https://www.timescale.com/) and [Grafana](https://grafana.com/).\n\n# Installation\n\nNote: You must have [Docker](https://docker.com/) installed for running this stack.\n\nTo get started with the stack, clone the repo, and run this command in the root of the repo: \n```shell\ndocker-compose up -d\n```\n\nThis will spin up a TimescaleDB container and a Grafana container that is provisioned with a data source for connecting to the TimescaleDB database, as well as the pre-built dashboards. Grafana will be available at http://localhost:3000/.\n\n# Usage\n\nTo get your first load test running you currently must [build a custom version of k6](https://github.com/loadimpact/k6#build-from-source) from a [PR](https://github.com/loadimpact/k6/pull/1233) that includes the collector for outputting metrics to TimescaleDB.\n\nWhen you have your custom built k6 ready you'll need to specify that you want the result data output to TimescaleDB like so:\n\n```shell\nk6 run -o timescaledb=postgresql://k6:k6@localhost:5432/k6 ...\n```\n\nYou'll also need to tag your test runs with a `testid` (the value can be whatever you want to use as a unique identifier for test runs like a date string, numeric ID etc.). This tag is what enables the pre-built Grafana dashboards to segment the result data into discrete test runs.\n\n```shell\nk6 run -o timescaledb=postgresql://k6:k6@localhost:5432/k6 --tag testid=191114-113000 samples/test.loadimpact.com.js\n```\n\n# Dashboards\n\nThe stack comes with two pre-built dashboards. One for listing the discrete test runs as a list, and the other for visualizing the results of a specific test run.\n\n## Test list dashboard\n\n![Dashboard of test runs](dashboard-test-runs.png)\n\n## Test result dashboard\n\n![Dashboard of test result](dashboard-test-result.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrafana%2Fk6-timescaledb-stack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrafana%2Fk6-timescaledb-stack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrafana%2Fk6-timescaledb-stack/lists"}