Frontend logging: Remove Sentry javascript agent support (grafana#67493)

* remove Sentry

* fix sourcemap resolve

Author: domasx2

.github/renovate.json5

@@ -16,12 +16,6 @@
     "systemjs",
     "ts-loader", // we should remove ts-loader and use babel-loader instead
     "ora", // we should bump this once we move to esm modules
-
-    // Sentry deprecated in favor of Grafana Faro for frontend logging.
-    // Major effort required to upgrade to latest Sentry, not worthwhile
-    "@sentry/browser",
-    "@sentry/types",
-    "@sentry/utils",
   ],
   "includePaths": ["package.json", "packages/**"],
   "ignorePaths": ["packages/grafana-toolkit/package.json", "emails/**", "plugins-bundled/**", "**/mocks/**"],

conf/defaults.ini

@@ -872,21 +872,12 @@ facility =
 tag =
 
 [log.frontend]
-# Should Sentry javascript agent be initialized
+# Should Faro javascript agent be initialized
 enabled = false
 
-# Defines which provider to use sentry or grafana
-provider = sentry
-
-# Sentry DSN if you want to send events to Sentry.
-sentry_dsn =
-
 # Custom HTTP endpoint to send events to. Default will log the events to stdout.
 custom_endpoint =
 
-# Rate of events to be reported to Sentry between 0 (none) and 1 (all), float
-sample_rate = 1.0
-
 # Requests per second limit enforced per an extended period, for Grafana backend log ingestion endpoint (/log).
 log_endpoint_requests_per_second_limit = 3
 

conf/sample.ini

@@ -844,20 +844,11 @@
 ;tag =
 
 [log.frontend]
-# Should Sentry javascript agent be initialized
+# Should Faro javascript agent be initialized
 ;enabled = false
 
-# Defines which provider to use, default is Sentry
-;provider = sentry
-
-# Sentry DSN if you want to send events to Sentry.
-;sentry_dsn =
-
-# Custom HTTP endpoint to send events captured by the Sentry agent to. Default will log the events to stdout.
-;custom_endpoint = /log
-
-# Rate of events to be reported between 0 (none) and 1 (all), float
-;sample_rate = 1.0
+# Custom HTTP endpoint to send events to. Default will 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

docs/sources/setup-grafana/configure-grafana/_index.md

@@ -1284,31 +1284,19 @@ Syslog tag. By default, the process's `argv[0]` is used.
 
 ### enabled
 
-Sentry javascript agent is initialized. Default is `false`.
-
-### provider
-
-Defines which provider to use `sentry` or `grafana`. Default is `sentry`
-
-### sentry_dsn
-
-Sentry DSN if you want to send events to Sentry
+Faro javascript agent is initialized. Default is `false`.
 
 ### custom_endpoint
 
-Custom HTTP endpoint to send events captured by the Sentry agent to. Default, `/log`, will log the events to stdout.
-
-### sample_rate
-
-Rate of events to be reported between `0` (none) and `1` (all, default), float.
+Custom HTTP endpoint to send events captured by the Faro agent to. Default, `/log-grafana-javascript-agent`, will log the events to stdout.
 
 ### log_endpoint_requests_per_second_limit
 
-Requests per second limit enforced per an extended period, for Grafana backend log ingestion endpoint, `/log`. Default is `3`.
+Requests per second limit enforced per an extended period, for Grafana backend log ingestion endpoint, `/log-grafana-javascript-agent`. Default is `3`.
 
 ### log_endpoint_burst_limit
 
-Maximum requests accepted per short interval of time for Grafana backend log ingestion endpoint, `/log`. Default is `15`.
+Maximum requests accepted per short interval of time for Grafana backend log ingestion endpoint, `/log-grafana-javascript-agent`. Default is `15`.
 
 ### instrumentations_errors_enabled
 

go.mod

@@ -40,7 +40,6 @@ require (
 	github.com/crewjam/saml v0.4.12
 	github.com/fatih/color v1.15.0
 	github.com/gchaincl/sqlhooks v1.3.0
-	github.com/getsentry/sentry-go v0.13.0
 	github.com/go-git/go-git/v5 v5.4.2
 	github.com/go-ldap/ldap/v3 v3.4.4
 	github.com/go-openapi/strfmt v0.21.7

go.sum

@@ -801,8 +801,6 @@ github.com/gdamore/tcell v1.3.0/go.mod h1:Hjvr+Ofd+gLglo7RYKxxnzCBmev3BzsS67MebK
 github.com/getkin/kin-openapi v0.76.0/go.mod h1:660oXbgy5JFMKreazJaQTw7o+X00qeSyhcnluiMv+Xg=
 github.com/getkin/kin-openapi v0.115.0 h1:c8WHRLVY3G8m9jQTy0/DnIuljgRwTCB5twZytQS4JyU=
 github.com/getkin/kin-openapi v0.115.0/go.mod h1:l5e9PaFUo9fyLJCPGQeXI2ML8c3P8BHOEV2VaAVf/pc=
-github.com/getsentry/sentry-go v0.13.0 h1:20dgTiUSfxRB/EhMPtxcL9ZEbM1ZdR+W/7f7NWD+xWo=
-github.com/getsentry/sentry-go v0.13.0/go.mod h1:EOsfu5ZdvKPfeHYV6pTVQnsjfp30+XA7//UooKNumH0=
 github.com/ghodss/yaml v0.0.0-20150909031657-73d445a93680/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04=
 github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04=
 github.com/ghodss/yaml v1.0.1-0.20190212211648-25d852aebe32 h1:Mn26/9ZMNWSw9C9ERFA1PUxfmGpolnw2v0bKOREu5ew=
@@ -822,7 +820,6 @@ github.com/go-asn1-ber/asn1-ber v1.5.4 h1:vXT6d/FNDiELJnLb6hGNa309LMsrCoYFvpwHDF
 github.com/go-asn1-ber/asn1-ber v1.5.4/go.mod h1:hEBeB/ic+5LoWskz+yKT7vGhhPYkProFKoKdwZRWMe0=
 github.com/go-chi/chi v4.1.0+incompatible/go.mod h1:eB3wogJHnLi3x/kFX2A+IbTBlXxmMeXJVKy9tTv1XzQ=
 github.com/go-chi/chi/v5 v5.0.8/go.mod h1:DslCQbL2OYiznFReuXYUmQ2hGd1aDpCnlMNITLSKoi8=
-github.com/go-errors/errors v1.0.1 h1:LUHzmkK3GUKUrL/1gfBUxAHzcev3apQlezX/+O7ma6w=
 github.com/go-fonts/dejavu v0.1.0/go.mod h1:4Wt4I4OU2Nq9asgDCteaAaWZOV24E+0/Pwo0gppep4g=
 github.com/go-fonts/latin-modern v0.2.0/go.mod h1:rQVLdDMK+mK1xscDwsqM5J8U2jrRa3T0ecnM9pNujks=
 github.com/go-fonts/liberation v0.1.1/go.mod h1:K6qoJYypsmfVjWg8KOVDQhLc8UDgIK2HYqyqAO9z7GY=
@@ -1962,7 +1959,6 @@ github.com/pierrec/lz4 v2.6.0+incompatible/go.mod h1:pdkljMzZIN41W+lC3N2tnIh5sFi
 github.com/pierrec/lz4/v4 v4.1.8/go.mod h1:gZWDp/Ze/IJXGXf23ltt2EXimqmTUXEy0GFuRQyBid4=
 github.com/pierrec/lz4/v4 v4.1.15 h1:MO0/ucJhngq7299dKLwIMtgTfbkoSPF6AoMYDd8Q4q0=
 github.com/pierrec/lz4/v4 v4.1.15/go.mod h1:gZWDp/Ze/IJXGXf23ltt2EXimqmTUXEy0GFuRQyBid4=
-github.com/pingcap/errors v0.11.4 h1:lFuQV/oaUMGcD2tqt+01ROSmJs75VG1ToEOkZIZ4nE4=
 github.com/pkg/browser v0.0.0-20180916011732-0a3d74bf9ce4/go.mod h1:4OwLy04Bl9Ef3GJJCoec+30X3LQs/0/m4HFRt/2LUSA=
 github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8 h1:KoWmjvw+nsYOo29YJK9vDA65RGE3NrOnUtO7a+RF9HU=
 github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8/go.mod h1:HKlIX3XHQyzLZPlr7++PzdhaXEj94dEiJgZDTsxEqUI=

package.json

@@ -287,9 +287,6 @@
     "@react-stately/tree": "3.3.1",
     "@reduxjs/toolkit": "1.9.3",
     "@remix-run/router": "^1.5.0",
-    "@sentry/browser": "6.19.7",
-    "@sentry/types": "6.19.7",
-    "@sentry/utils": "6.19.7",
     "@testing-library/react-hooks": "^8.0.1",
     "@types/react-resizable": "3.0.3",
     "@types/trusted-types": "2.0.3",

packages/grafana-data/src/types/config.ts

@@ -46,18 +46,6 @@ export interface LicenseInfo {
   trialExpiry?: number;
 }
 
-/**
- * Describes Sentry integration config
- *
- * @public
- */
-export interface SentryConfig {
-  enabled: boolean;
-  dsn: string;
-  customEndpoint: string;
-  sampleRate: number;
-}
-
 /**
  * Describes GrafanaJavascriptAgentConfig integration config
  *
@@ -209,7 +197,6 @@ export interface GrafanaConfig {
   licenseInfo: LicenseInfo;
   http2Enabled: boolean;
   dateFormats?: SystemDateFormatSettings;
-  sentry: SentryConfig;
   grafanaJavascriptAgent: GrafanaJavascriptAgentConfig;
   customTheme?: any;
   geomapDefaultBaseLayer?: MapLayerOptions;

packages/grafana-runtime/package.json

@@ -41,7 +41,6 @@
     "@grafana/e2e-selectors": "10.1.0-pre",
     "@grafana/faro-web-sdk": "1.0.2",
     "@grafana/ui": "10.1.0-pre",
-    "@sentry/browser": "6.19.7",
     "history": "4.10.1",
     "lodash": "4.17.21",
     "rxjs": "7.8.0",

packages/grafana-runtime/src/config.ts

@@ -103,12 +103,6 @@ export class GrafanaBootConfig implements GrafanaConfig {
   supportBundlesEnabled = false;
   http2Enabled = false;
   dateFormats?: SystemDateFormatSettings;
-  sentry = {
-    enabled: false,
-    dsn: '',
-    customEndpoint: '',
-    sampleRate: 1,
-  };
   grafanaJavascriptAgent = {
     enabled: false,
     customEndpoint: '',

packages/grafana-runtime/src/services/EchoSrv.ts

@@ -78,7 +78,6 @@ export interface EchoEvent<T extends EchoEventType = any, P = any> {
 export enum EchoEventType {
   Performance = 'performance',
   MetaAnalytics = 'meta-analytics',
-  Sentry = 'sentry',
   Pageview = 'pageview',
   Interaction = 'interaction',
   ExperimentView = 'experimentview',

packages/grafana-runtime/src/utils/logging.ts

@@ -1,84 +1,59 @@
-import { captureMessage, captureException, Severity as LogLevel } from '@sentry/browser';
-
-import { faro, LogLevel as GrafanaLogLevel } from '@grafana/faro-web-sdk';
+import { faro, LogLevel } from '@grafana/faro-web-sdk';
 
 import { config } from '../config';
 
 export { LogLevel };
 
-// a bit stricter than what Sentry allows
 type Contexts = Record<string, Record<string, number | string | Record<string, string | number>>>;
 
 /**
- * Log a message at INFO level. Depending on configuration might be forwarded to backend and logged to stdout or sent to Sentry
- *
+ * Log a message at INFO level
  * @public
  */
 export function logInfo(message: string, contexts?: Contexts) {
   if (config.grafanaJavascriptAgent.enabled) {
     faro.api.pushLog([message], {
-      level: GrafanaLogLevel.INFO,
+      level: LogLevel.INFO,
       context: contexts,
     });
   }
-  if (config.sentry.enabled) {
-    captureMessage(message, {
-      level: LogLevel.Info,
-      contexts,
-    });
-  }
 }
 
 /**
- * Log a message at WARNING level. Depending on configuration might be forwarded to backend and logged to stdout or sent to Sentry
+ * Log a message at WARNING level
  *
  * @public
  */
 export function logWarning(message: string, contexts?: Contexts) {
   if (config.grafanaJavascriptAgent.enabled) {
     faro.api.pushLog([message], {
-      level: GrafanaLogLevel.WARN,
+      level: LogLevel.WARN,
       context: contexts,
     });
   }
-  if (config.sentry.enabled) {
-    captureMessage(message, {
-      level: LogLevel.Warning,
-      contexts,
-    });
-  }
 }
 
 /**
- * Log a message at DEBUG level. Depending on configuration might be forwarded to backend and logged to stdout or sent to Sentry
+ * Log a message at DEBUG level
  *
  * @public
  */
 export function logDebug(message: string, contexts?: Contexts) {
   if (config.grafanaJavascriptAgent.enabled) {
     faro.api.pushLog([message], {
-      level: GrafanaLogLevel.DEBUG,
+      level: LogLevel.DEBUG,
       context: contexts,
     });
   }
-  if (config.sentry.enabled) {
-    captureMessage(message, {
-      level: LogLevel.Debug,
-      contexts,
-    });
-  }
 }
 
 /**
- * Log an error. Depending on configuration might be forwarded to backend and logged to stdout or sent to Sentry
+ * Log an error
  *
  * @public
  */
 export function logError(err: Error, contexts?: Contexts) {
   if (config.grafanaJavascriptAgent.enabled) {
     faro.api.pushError(err);
   }
-  if (config.sentry.enabled) {
-    captureException(err, { contexts });
-  }
 }

packages/grafana-ui/package.json

@@ -63,7 +63,6 @@
     "@react-aria/overlays": "3.10.1",
     "@react-aria/utils": "3.13.1",
     "@react-stately/menu": "3.4.1",
-    "@sentry/browser": "6.19.7",
     "ansicolor": "1.1.100",
     "calculate-size": "1.1.1",
     "classnames": "2.3.2",

packages/grafana-ui/src/components/ErrorBoundary/ErrorBoundary.test.tsx

@@ -1,12 +1,10 @@
-import { captureException } from '@sentry/browser';
 import { render, screen } from '@testing-library/react';
 import React, { FC } from 'react';
 
 import { faro } from '@grafana/faro-web-sdk';
 
 import { ErrorBoundary } from './ErrorBoundary';
 
-jest.mock('@sentry/browser');
 jest.mock('@grafana/faro-web-sdk', () => ({
   faro: {
     api: {
@@ -31,7 +29,7 @@ describe('ErrorBoundary', () => {
     consoleSpy.mockRestore();
   });
 
-  it('should catch error and report it to sentry, including react component stack in context', async () => {
+  it('should catch error and report it to Faro', async () => {
     const problem = new Error('things went terribly wrong');
     render(
       <ErrorBoundary>
@@ -46,13 +44,6 @@ describe('ErrorBoundary', () => {
     );
 
     await screen.findByText(problem.message);
-    expect(captureException).toHaveBeenCalledTimes(1);
-    const [error, context] = (captureException as jest.Mock).mock.calls[0];
-    expect(error).toBe(problem);
-    expect(context).toHaveProperty('contexts');
-    expect(context.contexts).toHaveProperty('react');
-    expect(context.contexts.react).toHaveProperty('componentStack');
-    expect(context.contexts.react.componentStack).toMatch(/^\s+at ErrorThrower (.*)\s+at ErrorBoundary (.*)\s*$/);
     expect(faro.api.pushError).toHaveBeenCalledTimes(1);
     expect((faro.api.pushError as jest.Mock).mock.calls[0][0]).toBe(problem);
   });

packages/grafana-ui/src/components/ErrorBoundary/ErrorBoundary.tsx

@@ -1,4 +1,3 @@
-import { captureException } from '@sentry/browser';
 import React, { PureComponent, ReactNode, ComponentType } from 'react';
 
 import { faro } from '@grafana/faro-web-sdk';
@@ -38,7 +37,6 @@ export class ErrorBoundary extends PureComponent<Props, State> {
   };
 
   componentDidCatch(error: Error, errorInfo: ErrorInfo) {
-    captureException(error, { contexts: { react: { componentStack: errorInfo.componentStack } } });
     faro?.api?.pushError(error);
     this.setState({ error, errorInfo });
 

pkg/api/dtos/frontend_settings.go

@@ -185,7 +185,6 @@ type FrontendSettingsDTO struct {
 	RendererVersion                  string                         `json:"rendererVersion"`
 	SecretsManagerPluginEnabled      bool                           `json:"secretsManagerPluginEnabled"`
 	Http2Enabled                     bool                           `json:"http2Enabled"`
-	Sentry                           setting.Sentry                 `json:"sentry"`
 	GrafanaJavascriptAgent           setting.GrafanaJavascriptAgent `json:"grafanaJavascriptAgent"`
 	PluginCatalogURL                 string                         `json:"pluginCatalogURL"`
 	PluginAdminEnabled               bool                           `json:"pluginAdminEnabled"`

pkg/api/dtos/index.go

@@ -4,7 +4,6 @@ import (
 	"html/template"
 
 	"github.com/grafana/grafana/pkg/services/navtree"
-	"github.com/grafana/grafana/pkg/setting"
 )
 
 type IndexViewData struct {
@@ -27,7 +26,6 @@ type IndexViewData struct {
 	FavIcon                             template.URL
 	AppleTouchIcon                      template.URL
 	AppTitle                            string
-	Sentry                              *setting.Sentry
 	ContentDeliveryURL                  string
 	LoadingLogo                         template.URL
 	CSPContent                          string