public/grafana
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Faro: Update configuration with best practices (#112108)

Browse Source 
* Clean up faro configuration to align with best practices

* Update grafana docs

* remove fixme comment

* fix tests

* don't spread config in
This commit is contained in:
Josh Hunt
2025-10-13 13:46:29 +01:00
committed by GitHub
parent 32f1912311
commit ea25b75966
9 changed files with 223 additions and 201 deletions
Download Patch File Download Diff File Expand all files Collapse all files
conf/sample.ini
+23 -19
View File
@@ -1172,35 +1172,39 @@
;tag =
[log.frontend]
# Should Faro javascript agent be initialized
# Enables the Grafana Faro javascript agent integration for capturing frontend performance and error events.
;enabled = false
# Custom HTTP endpoint to send events to. Default will log the events to stdout.
# Custom HTTP endpoint to send Grafana Faro events to. Default will send events to /log-grafana-javascript-agent and log the events to stdout.
;custom_endpoint = /log-grafana-javascript-agent
# Requests per second limit enforced an extended period, for Grafana backend log ingestion endpoint (/log).
;log_endpoint_requests_per_second_limit = 3
# API Key for Grafana Faro custom endpoint
;api_key =
# Max requests accepted per short interval of time for Grafana backend log ingestion endpoint (/log).
;log_endpoint_burst_limit = 15
# level of internal logging for debugging Grafana Javascript Agent.
# possible values are: 0 = OFF, 1 = ERROR, 2 = WARN, 3 = INFO, 4 = VERBOSE
# more details: https://github.com/grafana/faro-web-sdk/blob/v1.3.7/docs/sources/tutorials/quick-start-browser.md#how-to-activate-debugging
;internal_logger_level =
# Enables all Faro default instrumentation by using `getWebInstrumentations`. Overrides other instrumentation flags.
;instrumentations_all_enabled = false
# Enables the Console instrumentation for Grafana Faro
# See https://grafana.com/docs/grafana-cloud/monitor-applications/frontend-observability/instrument/console-instrumentation/
;instrumentations_console_enabled = true
# Should error instrumentation be enabled, only affects Grafana Javascript Agent
;instrumentations_errors_enabled = true
# Enables the Performance instrumentation for Grafana Faro.
# See https://grafana.com/docs/grafana-cloud/monitor-applications/frontend-observability/instrument/performance-instrumentation/
;instrumentations_performance_enabled = true
# Should console instrumentation be enabled, only affects Grafana Javascript Agent
;instrumentations_console_enabled = false
# Enables the Content Security Policy Violations instrumentation for Grafana Faro.
# See https://grafana.com/docs/grafana-cloud/monitor-applications/frontend-observability/instrument/csp-violation-tracking/
; instrumentations_csp_enabled = true
# Should webvitals instrumentation be enabled, only affects Grafana Javascript Agent
;instrumentations_webvitals_enabled = false
# Enables the Tracing instrumentation for Grafana Faro.
# See https://grafana.com/docs/grafana-cloud/monitor-applications/frontend-observability/instrument/tracing-instrumentation/
;instrumentations_tracing_enabled = true
# Should tracing instrumentation be enabled, only affects Grafana Javascript Agent
;instrumentations_tracing_enabled = false
# Api Key, only applies to Grafana Javascript Agent provider
;api_key = testApiKey
# Enables sending attribution data for web vitals with the Performance instrumentation.
# See https://grafana.com/docs/grafana-cloud/monitor-applications/frontend-observability/instrument/web-vitals/#web-vitals-attribution-data
;web_vitals_attribution_enabled = true
#################################### Usage Quotas ########################
[quota]