better example

Author: aaxelb

README.md

@@ -47,7 +47,7 @@ from elasticsearch_metrics.imps import elastic8
 
 
 class PageView(elastic8.EventLog):
-    user_id = metrics.Integer(index=True, doc_values=True)
+    page_id: int
 ```
 
 Use the `sync_metrics` management command to ensure that the [index template](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html)
@@ -63,12 +63,10 @@ Now add some data:
 ```python
 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"
-PageView.record(user_id=user.id)
+# to an index named for the record type and date
+PageView.record(page_id='my.page.id')
 ```
 
 Go forth and search!
@@ -102,7 +100,7 @@ You can configure the index template settings by setting
 
 ```python
 class PageView(metrics.Metric):
-    user_id = metrics.Integer()
+    page_id = metrics.Integer()
 
     class Index:
         settings = {"number_of_shards": 2, "refresh_interval": "5s"}
@@ -130,7 +128,7 @@ Alternatively, you can set `template_name` and/or `template` explicitly.
 
 ```python
 class PageView(metrics.Metric):
-    user_id = metrics.Integer()
+    page_id = metrics.Integer()
 
     class Meta:
         template_name = "myapp_pviews"
@@ -144,7 +142,7 @@ from elasticsearch_metrics import metrics
 
 
 class MyBaseMetric(metrics.Metric):
-    user_id = metrics.Integer()
+    page_id = metrics.Integer()
 
     class Meta:
         abstract = True

elasticsearch_metrics/imps/elastic6.py

@@ -133,7 +133,7 @@ class BaseMetric(metaclass=MetricMeta):
 
 
         class PageView(metrics.Metric):
-            user_id = metrics.Integer(index=True, doc_values=True)
+            page_id = metrics.Integer(index=True, doc_values=True)
 
             class Index:
                 settings = {

elasticsearch_metrics/tests/test_imps_elastic6.py

@@ -34,7 +34,7 @@
 
 class PreprintView(elastic6.Metric):
     provider_id = elastic6.fields.Keyword(index=True)
-    user_id = elastic6.fields.Keyword(index=True)
+    page_id = elastic6.fields.Keyword(index=True)
     preprint_id = elastic6.fields.Keyword(index=True)
     route_name = elastic6.fields.Text(analyzer=route_prefix_analyzer)
 
@@ -105,7 +105,7 @@ def test_get_index_template_creates_template_with_mapping(self):
         assert "timestamp" in properties
         assert properties["timestamp"] == {"doc_values": True, "type": "date"}
         assert properties["provider_id"] == {"type": "keyword", "index": True}
-        assert properties["user_id"] == {"type": "keyword", "index": True}
+        assert properties["page_id"] == {"type": "keyword", "index": True}
         assert properties["preprint_id"] == {"type": "keyword", "index": True}
 
     # regression test
@@ -157,7 +157,7 @@ def test_template_name_defined_with_no_template_falls_back_to_default_template(
 
     def test_inheritance(self):
         class MyBaseMetric(elastic6.Metric):
-            user_id = elastic6.fields.Keyword(index=True)
+            page_id = elastic6.fields.Keyword(index=True)
 
             class Index:
                 settings = {"number_of_shards": 2}
@@ -230,10 +230,10 @@ def test_save_sends_signals(self):
         signals.post_save.connect(mock_post_save_listener, sender=PreprintView)
 
         provider_id = "12345"
-        user_id = "abcde"
+        page_id = "abcde"
         preprint_id = "zyxwv"
         doc = PreprintView(
-            provider_id=provider_id, user_id=user_id, preprint_id=preprint_id
+            provider_id=provider_id, page_id=page_id, preprint_id=preprint_id
         )
         doc.save()
 
@@ -259,10 +259,10 @@ def es6_client(self):
 
     def test_create_document(self):
         provider_id = "12345"
-        user_id = "abcde"
+        page_id = "abcde"
         preprint_id = "zyxwv"
         doc = PreprintView(
-            provider_id=provider_id, user_id=user_id, preprint_id=preprint_id
+            provider_id=provider_id, page_id=page_id, preprint_id=preprint_id
         )
         doc.save()
         document = PreprintView.get(id=doc.meta.id, index=PreprintView.get_index_name())
@@ -274,7 +274,7 @@ def test_create_document(self):
         properties = mapping[name]["mappings"]["doc"]["properties"]
         assert properties["timestamp"] == {"type": "date"}
         assert properties["provider_id"] == {"type": "keyword"}
-        assert properties["user_id"] == {"type": "keyword"}
+        assert properties["page_id"] == {"type": "keyword"}
         assert properties["preprint_id"] == {"type": "keyword"}
 
 
@@ -290,7 +290,7 @@ def test_init(self):
         properties = mapping[name]["mappings"]["doc"]["properties"]
         assert properties["timestamp"] == {"type": "date"}
         assert properties["provider_id"] == {"type": "keyword"}
-        assert properties["user_id"] == {"type": "keyword"}
+        assert properties["page_id"] == {"type": "keyword"}
         assert properties["preprint_id"] == {"type": "keyword"}
 
     def test_check_index_template(self):