Skip to main content

Django app for storing time-series metrics in Elasticsearch.

Project description


pypi Build Status Code style: black

Django app for storing time-series metrics in Elasticsearch.


  • Python 2.7 or >=3.6
  • Django 1.11 or 2.0
  • Elasticsearch 6


pip install django-elasticsearch-metrics


Add "elasticseach_metrics" to INSTALLED_APPS.

INSTALLED_APPS += ["elasticsearch_metrics"]

Define the ELASTICSEARCH_DSL setting.

ELASTICSEARCH_DSL = {"default": {"hosts": "localhost:9200"}}

This setting is passed to elasticsearch_dsl.connections.configure so it takes the same parameters.

In one of your apps, define a new metric in

A Metric is a subclass of elasticsearch_dsl.Document.

# myapp/

from elasticsearch_metrics import metrics

class PageView(metrics.Metric):
    user_id = metrics.Integer(index=True, doc_values=True)

Use the sync_metrics management command to ensure that the index template for your metric is created in Elasticsearch.

# This will create an index template called myapp_pageview
python sync_metrics

Now add some data:

from myapp.metrics import PageView

user = User.objects.latest()

# By default we create an index for each day.
# Therefore, this will persist the document
# to an index called, e.g. "myapp_pageview_2020.02.04"

Go forth and search!

# perform a search across all page views

Per-month or per-year indices

By default, an index is created for every day that a metric is saved. You can change this to create an index per month or per year by changing the ELASTICSEARCH_METRICS_DATE_FORMAT setting.


# Monthly:

# Yearly:

Index settings

You can configure the index template settings by setting Metric.Index.settings.

class PageView(metrics.Metric):
    user_id = metrics.Integer()

    class Index:
        settings = {"number_of_shards": 2, "refresh_interval": "5s"}

Index templates

Each Metric will have its own index template. The index template name and glob pattern are computed from the app label for the containing app and the class's name. For example, a PageView class defined in myapp/ will have an index template with the name myapp_pageview and a template glob pattern of myapp_pageview_*.

If you declare a Metric outside of an app, you will need to set app_label.

class PageView(metrics.Metric):
    class Meta:
        app_label = "myapp"

Alternatively, you can set template_name and/or template explicitly.

class PageView(metrics.Metric):
    user_id = metrics.Integer()

    class Meta:
        template_name = "myapp_pviews"
        template = "myapp_pviews_*"

Abstract metrics

from elasticsearch_metrics import metrics

class MyBaseMetric(metrics.Metric):
    user_id = metrics.Integer()

    class Meta:
        abstract = True

class PageView(MyBaseMetric):
    class Meta:
        app_label = "myapp"

Optional factory_boy integration

import factory
from elasticsearch_metrics.factory import MetricFactory

from ..myapp.metrics import MyMetric

class MyMetricFactory(MetricFactory):
    my_int = factory.Faker("pyint")

    class Meta:
        model = MyMetric

def test_something():
    metric = MyMetricFactory()  # index metric in ES
    assert isinstance(metric.my_int, int)


  • ELASTICSEARCH_DSL: Required. Connection settings passed to elasticsearch_dsl.connections.configure.
  • ELASTICSEARCH_METRICS_DATE_FORMAT: Date format to use when creating indexes. Default: %Y.%m.%d (same date format Elasticsearch uses for date math)

Management commands

  • sync_metrics: Ensure that index templates have been created for your metrics.
  • show_metrics: Pretty-print a listing of all registered metrics.
  • check_metrics: Check if index templates are in sync. Exits with an error code if any metrics are out of sync.


Signals are located in the elasticsearch_metrics.signals module.

  • pre_index_template_create(Metric, index_template, using): Sent before PUTting a new index template into Elasticsearch.
  • post_index_template_create(Metric, index_template, using): Sent after PUTting a new index template into Elasticsearch.
  • pre_save(Metric, instance, using, index): Sent at the beginning of a Metric's save() method.
  • post_save(Metric, instance, using, index): Sent at the end of a Metric's save() method.


class MyMetric(metrics.Metric):
    class Meta:
        source = metrics.MetaField(enabled=True)



MIT Licensed.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-elasticsearch-metrics-5.0.0.tar.gz (19.7 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page