[DOC-366] Add Dagster Plus audit log guide #23931
Conversation
graphite-app
bot
requested review from
PedramNavid,
erinkcochran87 and
cmpadden
|
This stack of pull requests is managed by Graphite. Learn more about stacking. Join @benpankow and the rest of your teammates on |
Graphite Automations"docs-beta - Assign Reviewers" took an action on this PR • (08/26/24)3 reviewers were added to this PR based on Pedram Navid's automation. |
|
Deploy preview for dagster-docs ready! Preview available at https://dagster-docs-muof7k6a9-elementl.vercel.app Direct link to changed pages: |
|
Deploy preview for dagster-docs-beta ready! Preview available at https://dagster-docs-beta-6clgbybzd-elementl.vercel.app Direct link to changed pages: |
There was a problem hiding this comment.
Will let @erinkcochran87 review as well, but can you export the Audit Log at all? That's what i imagine i would want to do with this.
Good call - you can over GQL, per #22361. Added a brief section covering this. Do we have a new page about the GQL API or Python client? might be good to link to that if so, but couldn't find one |
| @@ -0,0 +1,17 @@ | |||
| query AuditLogQuery( | |||
There was a problem hiding this comment.
In the interest of a "complete" example, I think it would be helpful to link or describe either how you would access the /graphql endpoint, or like how you would do it in python.
There was a problem hiding this comment.
Good idea. Added a brief sentence, can link out to the graphql page once that's ready.
@benpankow We will, likely in the References section in the top nav. Location is tbd, but it'll be in there somewhere. |
Co-authored-by: Erin Cochran <[email protected]>
Co-authored-by: Erin Cochran <[email protected]>
Co-authored-by: Erin Cochran <[email protected]>
Co-authored-by: Erin Cochran <[email protected]>
| ## Audit log entry types | ||
|
|
||
| | Event type | Description | Additional details | |
There was a problem hiding this comment.
I love this table -- how often do we add audit log events and is there a risk it will become stale?
There was a problem hiding this comment.
@OwenKephart's auto-generating alert doc makes me want to give similar treatment to everything like this. Could look into adapting it.
There was a problem hiding this comment.
That's a great question. I would expect we would add new events somewhat often (every few months). Took a stab at making a parity unit test here which would give us some notification if the tables got out of sync: https://github.com/dagster-io/internal/pull/11224
Not sure if in practice this is more annoying than it's worth
Summary & Motivation
Introduces a basic docs guide for the Plus audit log, including a list of auditable actions.
https://dagster-docs-beta-j3dho3hl2-elementl.vercel.app/dagster-plus/access/rbac/audit-logs
Changelog [Docs]
NOCHANGELOG