diff --git a/docs/hosting/configuration/environment-variables/deployment.md b/docs/hosting/configuration/environment-variables/deployment.md index 62ddccb58..99f089c20 100644 --- a/docs/hosting/configuration/environment-variables/deployment.md +++ b/docs/hosting/configuration/environment-variables/deployment.md @@ -1,7 +1,7 @@ --- #https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 title: Deployment environment variables -description: Configure deployment options and application accessibility with environment variables for your self-hosted n8n intance. +description: Configure deployment options and application accessibility with environment variables for your self-hosted n8n instance. contentType: reference tags: - environment variables diff --git a/docs/hosting/configuration/environment-variables/insights.md b/docs/hosting/configuration/environment-variables/insights.md new file mode 100644 index 000000000..fa5f7f1d2 --- /dev/null +++ b/docs/hosting/configuration/environment-variables/insights.md @@ -0,0 +1,27 @@ +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +title: Insights environment variables +description: Configure insights metrics collection with environment variables for your self-hosted n8n instance. +contentType: reference +tags: + - environment variables +hide: + - toc + - tags +--- + +# Insights environment variables + +--8<-- "_snippets/self-hosting/file-based-configuration.md" + +Insights gives instance owners and admins visibility into how workflows perform over time. Refer to [Insights](/insights.md) for details. + + | Variable | Type | Default | Description | + |:---------------------------------------------------------|:-------|:--------|:----------------------------------------------------------------------------------------| + | `N8N_DISABLED_MODULES` | String | - | Set to `insights` to disable the feature and metrics collection for an instance. | + | `N8N_INSIGHTS_COMPACTION_BATCH_SIZE` | Number | 500 | The number of raw insights data to compact in a single batch. | + | `N8N_INSIGHTS_COMPACTION_DAILY_TO_WEEKLY_THRESHOLD_DAYS` | Number | 180 | The maximum age (in days) of daily insights data to compact. | + | `N8N_INSIGHTS_COMPACTION_HOURLY_TO_DAILY_THRESHOLD_DAYS` | Number | 90 | The maximum age (in days) of hourly insights data to compact. | + | `N8N_INSIGHTS_COMPACTION_INTERVAL_MINUTES` | Number | 60 | Interval (in minutes) at which compaction should run. | + | `N8N_INSIGHTS_FLUSH_BATCH_SIZE` | Number | 1000 | The maximum number of insights data to keep in the buffer before flushing. | + | `N8N_INSIGHTS_FLUSH_INTERVAL_SECONDS` | Number | 30 | The interval (in seconds) at which the insights data should be flushed to the database. | diff --git a/docs/insights.md b/docs/insights.md new file mode 100644 index 000000000..fa89f6215 --- /dev/null +++ b/docs/insights.md @@ -0,0 +1,41 @@ +--- +#https://www.notion.so/n8n/Frontmatter-432c2b8dff1f43d4b1c8d20075510fe4 +description: Insights +contentType: explanation +--- + +# Insights + +Insights gives instance owners and admins visibility into how workflows perform over time. This feature consists of three parts: + +- [**Insights summary banner**](#insights-summary-banner): Shows key metrics about your instance from the last 7 days at the top of the overview space. +- [**Insights dashboard**](#insights-dashboard): A more detailed visual breakdown with per-workflow metrics and historical comparisons. +- **Time saved (Workflow ROI)**: For each workflow, you can set the number of minutes saved for each production execution. + +/// info | Feature availability +The insights summary banner displays activity from the last 7 days for all plans. The insights dashboard is only available on Pro (with limited date ranges) and Enterprise plans. +/// + +## Insights summary banner + +n8n collects several metrics for both the insights summary banner and dashboard. They include: + +- Total production executions (not including sub-workflow executions or manual executions) +- Total failed production executions +- Production execution failure rate +- Time saved (when set on at least one or more active workflows) +- Run time average (including wait time from any wait nodes) + +## Insights dashboard + +Those on the Pro and Enterprise plans can access the **Insights** section from the side navigation. Each metric from the summary banner is also clickable, taking you to the corresponding chart. + +The insights dashboard also has a table showing individual insights from each workflow including total production executions, failed production executions, failure rate, time saved, and run time average. + +## Insights time periods + +The insights summary banner and dashboard always shows a rolling 7 day window with a comparison to the previous period to show increases or decreases for each metric. + +## Disable or configure insights metrics collection + +If you self-host n8n, you can disable or configure insights and metrics collection using [environment variables](/hosting/configuration/environment-variables/insights.md). diff --git a/nav.yml b/nav.yml index f8a8cfa63..7ed2e885e 100644 --- a/nav.yml +++ b/nav.yml @@ -146,6 +146,7 @@ nav: - "Tutorial: Create environments with source control": source-control-environments/create-environments.md - External secrets: external-secrets.md - Log streaming: log-streaming.md + - Insights: insights.md - License key: license-key.md - Releases: - Release notes: @@ -1153,6 +1154,7 @@ nav: - External data storage: hosting/configuration/environment-variables/external-data-storage.md - External hooks: hosting/configuration/environment-variables/external-hooks.md - External secrets: hosting/configuration/environment-variables/external-secrets.md + - Insights: hosting/configuration/environment-variables/insights.md - Logs: hosting/configuration/environment-variables/logs.md - License: hosting/configuration/environment-variables/licenses.md - Nodes: hosting/configuration/environment-variables/nodes.md