Merge pull request #2 from rsmith013/config

Config

.pre-commit-config.yaml

@@ -13,7 +13,7 @@ repos:
     rev: 22.12.0
     hooks:
     - id: black
-  - repo: https://gitlab.com/pycqa/flake8
+  - repo: https://github.com/PyCQA/flake8
     rev: 3.8.2
     hooks:
       - id: flake8

README.md

@@ -1,3 +1,5 @@
+[![PyPI version](https://badge.fury.io/py/metaflow-sentry-logger.svg)](https://badge.fury.io/py/metaflow-sentry-logger)
+
 # Sentry Logging Plugin for Metaflow
 
 Enabling the use of [Sentry](https://sentry.io/) with [Metaflow](https://metaflow.org/)
@@ -33,10 +35,10 @@ The sentry plugin can be called using either the `--with sentry` command line ar
 
 Only basic configuration is currently supported using environment variables.
 
-| Envrionment Variable | Description                                       | Required |
-| -------------------- | ------------------------------------------------- | -------- |
-| `SENTRY_DSN`         | The DSN for the target sentry project             | `True`   |
-| `METAFLOW_PROFILE`   | Used by this plugin to determine the environment. | `False`  |
+| Name                  | Description                                       | Required | Location                                 |
+| --------------------- | ------------------------------------------------- | -------- | ---------------------------------------- |
+| `METAFLOW_SENTRY_DSN` | The DSN for the target sentry project             | `True`   | `Environment Variable` `Metaflow Config` |
+| `METAFLOW_PROFILE`    | Used by this plugin to determine the environment. | `False`  | `Environment Variable`                   |
 
 ## Examples
 

metaflow_extensions/sentry/config/metaflow_config.py

@@ -0,0 +1,11 @@
+"""
+Metaflow configuration over-rides.
+
+Use `metaflow.from_conf` to set values with the following prioritisation
+order: 1) System environment variable 2) Your Metaflow profile (JSON
+config) 3) The value passed to `from_conf`
+"""
+from metaflow.metaflow_config import from_conf
+
+# Path to the client cache
+SENTRY_DSN = from_conf("SENTRY_DSN", None)

metaflow_extensions/sentry/plugins/sentry_logging_step_decorator.py

@@ -3,6 +3,7 @@
 
 import sentry_sdk
 from metaflow import decorators
+from metaflow_extensions.sentry.config.metaflow_config import SENTRY_DSN
 
 logger = logging.getLogger(__name__)
 
@@ -11,6 +12,16 @@ class SentryLoggingStepDecorator(decorators.StepDecorator):
 
     name = "sentry"
 
+    def step_init(
+        self, flow, graph, step_name, decorators, environment, flow_datastore, logger
+    ):
+        if not SENTRY_DSN:
+            msg = (
+                "You have requested the sentry logging decorator "
+                "without setting the METAFLOW_SENTRY_DSN configuration value."
+            )
+            raise ValueError(msg)
+
     def task_pre_step(
         self,
         step_name,
@@ -25,15 +36,9 @@ def task_pre_step(
         ubf_context,
         inputs,
     ):
-        if not (sentry_dsn := os.environ.get("SENTRY_DSN")):
-            msg = (
-                "You have requested the sentry logging decorator "
-                "without setting SENTRY_DSN environment variable"
-            )
-            raise ValueError(msg)
 
         sentry_sdk.init(
-            dsn=sentry_dsn,
+            dsn=SENTRY_DSN,
             environment=os.environ.get("METAFLOW_PROFILE"),
         )
 

metaflow_extensions/sentry/toplevel/sentry_toplevel.py

@@ -1,3 +1,3 @@
 __mf_extensions__ = "sentry"
 
-__version__ = None
+__version__ = "0.2.0"

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "metaflow-sentry-logger"
-version= "0.1.0"
+version = "0.2.0"
 description="Sentry logging plugins for Metaflow (metaflow.org)"
 readme="README.md"
 authors=[{name = "Richard Smith"}]
@@ -30,7 +30,7 @@ metaflow_extensions = "metaflow_extensions"
 Homepage = "https://github.com/rsmith013/metaflow-sentry-logger"
 
 [tool.bumpver]
-current_version = "0.1.0"
+current_version = "0.2.0"
 version_pattern = "MAJOR.MINOR.PATCH"
 commit_message  = "Bump version {old_version} -> {new_version}"
 commit          = true