A multitenant, horizontally scalable Prometheus as a Service
tomwilkie Merge pull request #1134 from aditya-konarde/patch-1
Fix typo in push-images script
Latest commit 1f75367 Dec 5, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Switch imports (#1038) Oct 2, 2018
build-image update golint path (#1073) Oct 16, 2018
cmd Merge pull request #1127 from grafana/yaml Dec 4, 2018
docs Merge pull request #1101 from gouthamve/reload-limits Nov 19, 2018
imgs Note Cortex is a CNCF project; make commercial references more balanc… Sep 20, 2018
k8s querier.frontend-address fix Dec 1, 2018
pkg Merge pull request #1127 from grafana/yaml Dec 4, 2018
tools Switch imports (#1038) Oct 2, 2018
vendor Update tsdb to prometheus/tsdb#bstream-pointer, to reduce allocs. Nov 29, 2018
.gitignore Switch imports (#1038) Oct 2, 2018
.lintignore Add .lintignore to speed up lint Mar 20, 2017
CONTRIBUTING.md Add contributing guidelines and link in README Oct 9, 2018
COPYING.LGPL-3 license: document vendored code which is under LGPL3 and MPL-2.0 Aug 16, 2018
GOVERNANCE.md Create GOVERNANCE.md and MAINTAINERS (#823) Jun 5, 2018
Gopkg.lock Update tsdb to prometheus/tsdb#bstream-pointer, to reduce allocs. Nov 29, 2018
Gopkg.toml Remove constaint on weaveworks/common. Sep 29, 2018
LICENSE Bump license copyright year to 2017 (#571) Oct 6, 2017
MAINTAINERS Use personal emails for FreshTracks maintainers (#1107) Nov 5, 2018
Makefile Convert APIResponse and QueryRangeResponse to protos. Nov 12, 2018
README.md Add contributing guidelines and link in README Oct 9, 2018
VENDORED_CODE.md license: document vendored code which is under LGPL3 and MPL-2.0 Aug 16, 2018
code-of-conduct.md Add a Code of Conduct referencing the CNCF Code of Conduct (#1016) Sep 21, 2018
push-images Fix typo in push-images script Dec 4, 2018

README.md

Cortex Logo

Open source, horizontally scalable, multi-tenant Prometheus as a service

Circle CI GoDoc

Cortex is a CNCF sandbox project used in several production systems including Weave Cloud, GrafanaCloud and FreshTracks.io.

Cortex provides horizontally scalable, multi-tenant, long term storage for Prometheus metrics when used as a remote write destination, and a horizontally scalable, Prometheus-compatible query API.

Multi-tenant means it handles metrics from multiple independent Prometheus sources, keeping them separate.

Instrumenting Your App: Best Practises

Hosted Cortex (Prometheus as a service)

There are several commercial services where you can use Cortex on-demand:

Weave Cloud

Weave Cloud from Weaveworks lets you deploy, manage, and monitor container-based applications. Sign up at https://cloud.weave.works and follow the instructions there. Additional help can also be found in the Weave Cloud documentation.

GrafanaCloud

To use Cortex as part of Grafana Cloud, sign up for GrafanaCloud by clicking "Log In" in the top right and then "Sign Up Now". Cortex is included as part of the Starter and Basic Hosted Grafana plans.

Contributing

For a guide to contributing to Cortex, see the contributor guidelines.

For Developers

To build:

make

(By default the build runs in a Docker container, using an image built with all the tools required. The source code is mounted from where you run make into the build container as a Docker volume.)

To run the test suite:

make test

To checkout Cortex in minikube:

kubectl create -f ./k8s

(these manifests use latest tags, i.e. this will work if you have just built the images and they are available on the node(s) in your Kubernetes cluster)

Cortex will sit behind an nginx instance exposed on port 30080. A job is deployed to scrape it itself. Try it:

http://192.168.99.100:30080/api/prom/api/v1/query?query=up

Vendoring

We use dep to vendor dependencies. To fetch a new dependency, run:

dep ensure

To update dependencies, run

dep ensure --update

Further reading

To learn more about Cortex, consult the following documents / talks:

Getting Help

If you have any questions regarding Cortex:

Your feedback is always welcome.