Skip to content

/ cortex

A horizontally scalable, highly available, multi-tenant, long term Prometheus.
prometheus kubernetes monitoring cncf
Go Jsonnet Shell HTML Makefile Dockerfile Other
  1. Go 98.5%
  2. Jsonnet 0.4%
  3. Shell 0.3%
  4. HTML 0.3%
  5. Makefile 0.3%
  6. Dockerfile 0.1%
  7. Other 0.1%
Branch: master
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Latest commit

@pstibrany
pstibrany Mention that -distributor.shard-by-all-labels is used by querier too. (… 
…#2750)

Some people assume querier has its own version of this flag.

Signed-off-by: Peter Štibraný <peter.stibrany@grafana.com>
Latest commit a40db4c Jun 18, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Update golang to 1.14.4 and other build deps (#2480) Jun 17, 2020
.github Fixed stale bot comment (#2072) Feb 3, 2020
build-image Update golang to 1.14.4 and other build deps (#2480) Jun 17, 2020
cmd test exporter changes for testing delete series (#2595) Jun 18, 2020
development Changes in docker-compose (multiservices) setup (#2678) Jun 2, 2020
docs Mention that -distributor.shard-by-all-labels is used by querier too. (… Jun 18, 2020
images Hugo website using docsy theme (#1851) Dec 11, 2019
integration Separate HTTP Instrumentation for Querier (#2708) Jun 17, 2020
k8s [1145] Replacing fake s3 with minio in s3-dep (#2671) Jun 3, 2020
pkg more metrics in purger for monitoring delete requests processing prog… Jun 18, 2020
production/dashboards Hugo website using docsy theme (#1851) Dec 11, 2019
tools Update golang to 1.14.4 and other build deps (#2480) Jun 17, 2020
vendor Update golang to 1.14.4 and other build deps (#2480) Jun 17, 2020
website Add config to make website work with hugo latest (#2739) Jun 17, 2020
.errcheck-exclude Update code to fix almost all pre-existing lint errors (#2008) Feb 24, 2020
.gitattributes Exclude vendor/ from PR size (#2229) Mar 9, 2020
.gitignore add dist/ repo to gitignore (#2696) Jun 8, 2020
.gitmodules Hugo website using docsy theme (#1851) Dec 11, 2019
.golangci.yml Cleanup and fix golangci-lint config (#2488) Apr 20, 2020
.lintignore Hugo website using docsy theme (#1851) Dec 11, 2019
ADOPTERS.md Add SysEleven to list of adopters (#2142) Feb 17, 2020
CHANGELOG.md more metrics in purger for monitoring delete requests processing prog… Jun 18, 2020
CONTRIBUTING.md Documented design patterns and code conventions (#2305) Mar 20, 2020
GOVERNANCE.md Change governance to cap voting at 2 per company (#1968) Jan 10, 2020
LICENSE Update LICENSE Jul 29, 2019
MAINTAINERS Add Peter as maintainer (#2198) Mar 3, 2020
Makefile Update golang to 1.14.4 and other build deps (#2480) Jun 17, 2020
README.md Add TODOs badge to README (#2533) Apr 28, 2020
RELEASE.md Prepare release 1.1 (#2613) May 21, 2020
SECURITY.md Update SECURITY.md (#2434) Apr 14, 2020
VENDORED_CODE.md Cleanup white noise in Markdown files (#2447) Apr 14, 2020
VERSION Prepare release 1.1 (#2613) May 21, 2020
code-of-conduct.md Add a Code of Conduct referencing the CNCF Code of Conduct (#1016) Sep 21, 2018
go.mod Update golang to 1.14.4 and other build deps (#2480) Jun 17, 2020
go.sum Update golang to 1.14.4 and other build deps (#2480) Jun 17, 2020
netlify.toml Hugo website using docsy theme (#1851) Dec 11, 2019
push-images Provide instructions and ci job for releases Jul 31, 2019

README.md

Cortex Logo

Circle CI GoDoc Go Report Card Slack TODOs

Cortex: horizontally scalable, highly available, multi-tenant, long term storage for Prometheus.

Cortex provides horizontally scalable, highly available, multi-tenant, long term storage for Prometheus.

  • Horizontally scalable: Cortex can run across multiple machines in a cluster, exceeding the throughput and storage of a single machine. This enables you to send the metrics from multiple Prometheus servers to a single Cortex cluster and run "globally aggregated" queries across all data in a single place.
  • Highly available: When run in a cluster, Cortex can replicate data between machines. This allows you to survive machine failure without gaps in your graphs.
  • Multi-tenant: Cortex can isolate data and queries from multiple different independent Prometheus sources in a single cluster, allowing untrusted parties to share the same cluster.
  • Long term storage: Cortex supports Amazon DynamoDB, Google Bigtable, Cassandra, S3, GCS and Microsoft Azure for long term storage of metric data. This allows you to durably store data for longer than the lifetime of any single machine, and use this data for long term capacity planning.

Cortex is a CNCF sandbox project used in several production systems including Weave Cloud and Grafana Cloud. Cortex is primarily used as a remote write destination for Prometheus, with a Prometheus-compatible query API.

Documentation

Read the getting started guide if you're new to the project. Before deploying Cortex with a permanent storage backend you should read:

  1. An overview of Cortex's architecture
  2. A guide to running Cortex
  3. Information regarding configuring Cortex
  4. Steps to run Cortex with Cassandra

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

Further reading

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

Getting Help

If you have any questions about Cortex:

Your feedback is always welcome.

For security issues see https://github.com/cortexproject/cortex/security/policy

Community Meetings

The Cortex community call happens every three weeks on Thursday at 03:30pm – 04:15pm UTC to get calendar invite join the google groups.

Meeting notes are held here.

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.

Instrumenting Your App: Best Practices

Grafana Cloud

To use Cortex as part of Grafana Cloud, sign up for Grafana Cloud 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.

You can’t perform that action at this time.