Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

1.6 KB
Raw Blame

Dashboards development guide

This product owns dashboards, dashboard tiles, templates, and widget tiles. Do not treat every dashboard change as a widget change.

Choose the change type

  • For dashboard metadata, layouts, insight tiles, text cards, button tiles, or templates, use the product models and API in this directory.
  • For dashboard performance work, read PERFORMANCE.md before changing loading, scrolling, edit-mode transitions, tile movement, resize, or chart rendering. It covers work across tiles, browser layout, chart drawing, and measurement.
  • For a tile with widget_id, read CONTRIBUTING.md. It defines widget architecture, registry parity, generated files, and validation commands.
  • For dashboard creation or updates through PostHog tools, read building-a-dashboard.
  • For scheduled dashboard delivery, read managing-subscriptions.

Widget tiles only

  • Apply these rules only when you add or change a tile with widget_id.
  • Treat DashboardTile as layout and DashboardWidget as team-scoped widget state.
  • Register every widget type in the backend and frontend registries.
  • Define each widget config in backend/widget_specs/configs.py before you change generated frontend config types.
  • Run hogli build:openapi after you change widget_specs/.
  • Use dashboard insight tiles for charts and trends. Do not create a widget type for them.
  • Read manage-dashboard-widgets when you add a widget type or change a shipped widget.