Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Auto-update documentation for master (#73191)

github-automation-metabase24491d51eb3f
diff --git a/docs/api.json b/docs/api.json
index cca32536eff..6b08dab8605 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -15172,6 +15172,78 @@
"tags" : [ "/api/analytics" ]
}
},
+ "/api/analytics/internal" : {
+ "post" : {
+ "operationId" : "post-api-analytics-internal",
+ "summary" : "POST /api/analytics/internal",
+ "description" : "Receive a batch of internal analytics events from the frontend and record them as Prometheus metrics.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "events" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "amount" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "labels" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "string"
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "metric" : {
+ "type" : "string"
+ },
+ "op" : {
+ "type" : "string",
+ "enum" : [ "inc", "dec", "set", "observe", "clear" ]
+ }
+ },
+ "required" : [ "op", "metric" ]
+ }
+ }
+ },
+ "required" : [ "events" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/analytics" ]
+ }
+ },
"/api/api-key" : {
"post" : {
"operationId" : "post-api-api-key",
diff --git a/docs/configuring-metabase/config-template.md b/docs/configuring-metabase/config-template.md
index 83eca4ecd78..164ac25e2fd 100644
--- a/docs/configuring-metabase/config-template.md
+++ b/docs/configuring-metabase/config-template.md
@@ -229,9 +229,13 @@ config:
redirect-all-requests-to-https: false
remote-sync-auto-import: false
remote-sync-auto-import-rate: 5
+ remote-sync-branch: null
remote-sync-check-changes-cache-ttl-seconds: 60
remote-sync-task-time-limit-ms: 300000
+ remote-sync-token: null
remote-sync-transforms: false
+ remote-sync-type: read-only
+ remote-sync-url: null
report-timezone: null
reset-token-ttl-hours: 48
retry-initial-interval: 500
diff --git a/docs/configuring-metabase/environment-variables.md b/docs/configuring-metabase/environment-variables.md
index 7c214d8a4b5..c6f5d68268a 100644
--- a/docs/configuring-metabase/environment-variables.md
+++ b/docs/configuring-metabase/environment-variables.md
@@ -1438,6 +1438,14 @@ Whether to automatically import from the remote git repository. Only applies if
If remote-sync-type is :read-only and remote-sync-auto-import is true, the rate (in minutes) at which to check for updates to import. Defaults to 5.
+### `MB_REMOTE_SYNC_BRANCH`
+
+- Type: string
+- Default: `null`
+- [Configuration file name](./config-file.md): `remote-sync-branch`
+
+The remote branch to sync with, e.g. `main`.
+
### `MB_REMOTE_SYNC_CHECK_CHANGES_CACHE_TTL_SECONDS`
- Type: integer
@@ -1454,6 +1462,14 @@ Time-to-live in seconds for the remote changes check cache. Default is 60 second
The maximum amount of time a remote sync task will be given to complete.
+### `MB_REMOTE_SYNC_TOKEN`
+
+- Type: string
+- Default: `null`
+- [Configuration file name](./config-file.md): `remote-sync-token`
+
+An Authorization Bearer token allowing access to the git repo over HTTP.
+
### `MB_REMOTE_SYNC_TRANSFORMS`
- Type: boolean
@@ -1462,6 +1478,22 @@ The maximum amount of time a remote sync task will be given to complete.
Whether to sync transforms via remote-sync. When enabled, all transforms, transform tags, and transform jobs are synced as a single unit (all-or-nothing).
+### `MB_REMOTE_SYNC_TYPE`
+
+- Type: keyword
+- Default: `read-only`
+- [Configuration file name](./config-file.md): `remote-sync-type`
+
+Git synchronization type - :read-write or :read-only.
+
+### `MB_REMOTE_SYNC_URL`
+
+- Type: string
+- Default: `null`
+- [Configuration file name](./config-file.md): `remote-sync-url`
+
+The location of your git repository, e.g. https://github.com/acme-inco/metabase.git.
+
### `MB_REPORT_TIMEZONE`
- Type: string