Skip to content

Commit b072f73

Browse files
fix remarks
1 parent a08aee3 commit b072f73

1 file changed

Lines changed: 18 additions & 7 deletions

File tree

docs/docs/integrations/libraries/openlineage.md

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,16 +53,19 @@ event_log_storage:
5353
postgres_url:
5454
env: DAGSTER_PG_URL
5555
namespace: my-company
56-
# Optional:
57-
# namespace_template: "{namespace}" # {tag:KEY} is not available in Mechanism A
56+
# Optional — namespace_template overrides the static namespace field.
57+
# Note: the {tag:KEY} token always resolves to an empty string in
58+
# Mechanism A because EventLogStorage has no access to run tags at
59+
# store_event time. Use Mechanism B if you need per-run tag resolution.
60+
# namespace_template: "{namespace}"
5861
# timeout: 2.0
5962
```
6063

6164
Set `OPENLINEAGE_URL` (and optionally `OPENLINEAGE_API_KEY`) in the environment of any process that writes Dagster events — typically the run worker and the daemon.
6265

6366
## Mechanism B — sensor
6467

65-
Add `openlineage_sensor(include_asset_events=True)` to your `Definitions`:
68+
Add `openlineage_sensor(include_asset_events=True)` to your `Definitions`. The sensor runs in the Dagster daemon and has full access to run tags, making it the right choice for `{tag:KEY}` namespace resolution and Dagster+ deployments.
6669

6770
```python
6871
from dagster import Definitions
@@ -92,15 +95,23 @@ Set these environment variables on the process that runs the Dagster daemon:
9295

9396
## Namespace templates
9497

95-
Use `namespace_template` to route assets to per-tenant namespaces:
98+
Use `namespace_template` to route assets to per-tenant namespaces. The `{tag:KEY}` token resolves to the run tag named `KEY`, and is only available in **Mechanism B** (the sensor has access to run tags). In Mechanism A it always resolves to an empty string.
9699

97-
```python
100+
```
98101
# Template: "{namespace}/{tag:tenant}"
99102
# (Mechanism B, OPENLINEAGE_NAMESPACE=dagster)
100103
# Run tags {"tenant": "acme"} → resolved namespace "dagster/acme"
101-
# Run tags {} → resolved namespace "dagster" (tag unset, slash stripped)
104+
# Run tags {} → resolved namespace "dagster" (tag unset, trailing slash stripped)
105+
```
106+
107+
## Migration from v0.1
108+
109+
If you are upgrading from `dagster-openlineage` v0.1 to v0.2, note the following breaking changes:
102110

103-
The `{tag:KEY}` token is available in Mechanism B (the sensor has access to run tags). In Mechanism A the token always resolves to an empty string because `EventLogStorage` has no access to run tags at `store_event` time.
111+
- **Dagster version:** The minimum supported Dagster version is now `1.11.6`.
112+
- **Default namespace:** The default namespace is now flat (`dagster`). In v0.1, the integration attempted to use the repository name as the namespace. If you wish to preserve the old behavior, configure the `namespace` or `namespace_template` option accordingly.
113+
- **Removed class:** The legacy `OpenLineageEventListener` has been removed.
114+
- **Emission mechanics:** v0.1 emitted pipeline and step events automatically with no extra configuration. In v0.2, you must explicitly configure exactly one mechanism (A or B). Both now include full asset-centric support.
104115

105116
## About OpenLineage
106117

0 commit comments

Comments
 (0)