Merge pull request #24 from Eppo-exp/emiel/add-type-property-to-metrics

Emiel/add type property to metrics

Author: emielver

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Eppo
+Copyright (c) 2023-2024 Eppo
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

eppo_metrics_sync/schema/eppo_metric_schema.json

@@ -71,7 +71,7 @@
                                     "description": "User-friendly description of the fact",
                                     "type": "string"
                                 },
-                                "desired_change" : {
+                                "desired_change": {
                                     "description": "Specify whether or not increases in the fact are desired",
                                     "enum": ["increase", "decrease"]
                                 }
@@ -124,6 +124,10 @@
                         "description": "A user-friendly description of the fact",
                         "type": "string"
                     },
+                    "type": {
+                        "description": "The kind of metric to be calculated",
+                        "enum": ["simple", "ratio", "funnel", "percentile"]
+                    },
                     "entity": {
                         "description": "Must exactly match entity's name in Eppo UI",
                         "type": "string"
@@ -146,7 +150,7 @@
                     },
                     "guardrail_cutoff": {
                         "description": "If a metric is expected to increase, this value should be negative, to warn when the metric is decreasing by more than this value.",
-                        "type": "number"
+                        "type": ["number", "null"]
                     },
                     "numerator": {
                         "description": "Specify how the numerator of this metric should be aggregated",

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name='eppo_metrics_sync',
-    version='0.1.0',
+    version='0.1.1',
     packages=find_packages(),
     install_requires=[
         'PyYAML', 'jsonschema', 'requests'

tests/test_validation.py

@@ -54,7 +54,7 @@ def test_valid_guardrail_cutoff_signs():
     eppo_metrics_sync = EppoMetricsSync(directory = None)
     eppo_metrics_sync.load_yaml(
         path = test_yaml_dir + "/duplicated_fact_property_names.yaml")
-    
+
     with pytest.raises(ValueError, match = "Fact property names are not unique: device"):
         eppo_metrics_sync.validate()"""
 
@@ -151,4 +151,4 @@ def test_first_value():
 def test_valid_yaml():
     eppo_metrics_sync = EppoMetricsSync(directory=None)
     eppo_metrics_sync.load_eppo_yaml(path='tests/yaml/valid/purchases.yaml')
-    eppo_metrics_sync.validate()
+    eppo_metrics_sync.validate()

tests/yaml/invalid/invalid_metric_type.yaml

@@ -0,0 +1,16 @@
+fact_sources:
+  - name: upgrades_table
+    sql: select * from upgrades
+    timestamp_column: ts
+    entities:
+      - entity_name: user
+        column: user_id
+    facts:
+      - name: upgrades
+metrics:
+  - name: Total Upgrades to Paid Plan
+    entity: User
+    type: Nonexistent
+    numerator:
+      fact_name: upgrades
+      operation: sum

tests/yaml/valid/purchases.yaml

@@ -1,7 +1,7 @@
 fact_sources:
 - name: Purchase
   sql: |
-    SELECT 
+    SELECT
       events.*
     FROM customer_db.onboarding.events as events
     WHERE event_type = 'Revenue'
@@ -30,6 +30,7 @@ metrics:
     operation: distinct_entity
 - name: AOV
   entity: User
+  type: ratio
   numerator:
     fact_name: Purchase
     operation: sum