API Reference@grafana/runtimeGrafanaBootConfig

GrafanaBootConfig class

Signature

export declare class GrafanaBootConfig implements GrafanaConfig 

Import

import { GrafanaBootConfig } from '@grafana/runtime';

Constructors

ConstructorModifiersDescription
constructor(options)Constructs a new instance of the GrafanaBootConfig class

Properties

PropertyModifiersTypeDescription
alertingEnabledboolean
alertingErrorOrTimeoutstring
alertingMinIntervalnumber
alertingNoDataOrNullValuesstring
allowOrgCreateboolean
angularSupportEnabledboolean
applicationInsightsConnectionStringstring
applicationInsightsEndpointUrlstring
appSubUrlstring
appUrlstring
authAuthSettings
authProxyEnabledboolean
autoAssignOrgboolean
awsAllowedAuthProvidersstring[]
awsAssumeRoleEnabledboolean
azureAzureSettings
azureAuthEnabledboolean
bootDataBootData
buildInfoBuildInfo
caching{
enabled: boolean;
}
customThemeundefined
dashboardPreviews{
systemRequirements: {
met: boolean;
requiredImageRendererPluginVersion: string;
};
thumbnailsExist: boolean;
}
datasources{
[str: string]: DataSourceInstanceSettings;
}
dateFormatsSystemDateFormatSettings
defaultDatasourcestring
disableLoginFormboolean
disableSanitizeHtmlboolean
disableUserSignUpboolean
editorsCanAdminboolean
exploreEnabledboolean
expressionsEnabledboolean
externalUserMngInfostring
externalUserMngLinkNamestring
externalUserMngLinkUrlstring
featureHighlights{
enabled: boolean;
}
featureTogglesFeatureToggles
feedbackLinksEnabledboolean
geomapDefaultBaseLayerConfigMapLayerOptions
geomapDisableCustomBaseLayerboolean
googleAnalyticsIdundefined
grafanaJavascriptAgent{
enabled: boolean;
customEndpoint: string;
apiKey: string;
errorInstrumentalizationEnabled: boolean;
consoleInstrumentalizationEnabled: boolean;
webVitalsInstrumentalizationEnabled: boolean;
}
helpEnabledboolean
http2Enabledboolean
isPublicDashboardViewboolean
jwtHeaderNamestring
jwtUrlLoginboolean
ldapEnabledboolean
licenseInfoLicenseInfo
liveEnabledboolean
loginErrorundefined
loginHintstring
minRefreshIntervalstring
navTreeundefined
newPanelTitlestring
oauthOAuthSettings
panels{
[key: string]: PanelPluginMeta;
}
passwordHintstring
pluginAdminEnabledboolean
pluginAdminExternalManageEnabledboolean
pluginCatalogHiddenPluginsstring[]
pluginCatalogURLstring
pluginsToPreloadPreloadPlugin[]
profileEnabledboolean
queryHistoryEnabledboolean
rbacBuiltInRoleAssignmentEnabledboolean
rbacEnabledboolean
recordedQueries{
enabled: boolean;
}
rendererAvailableboolean
rendererVersionstring
reporting{
enabled: boolean;
}
rudderstackConfigUrlundefined
rudderstackDataPlaneUrlundefined
rudderstackSdkUrlundefined
rudderstackWriteKeyundefined
samlEnabledboolean
samlNamestring
secretsManagerPluginEnabledboolean
sentry{
enabled: boolean;
dsn: string;
customEndpoint: string;
sampleRate: number;
}
sigV4AuthEnabledboolean
themeGrafanaTheme
theme2GrafanaTheme2
unifiedAlerting{
minInterval: string;
}
unifiedAlertingEnabledboolean
verifyEmailEnabledboolean
viewersCanEditboolean
windowTitlePrefixstring

constructor(options)

Constructs a new instance of the GrafanaBootConfig class

Signature

constructor(options: GrafanaBootConfig);

Parameters

ParameterTypeDescription
optionsGrafanaBootConfig

alertingEnabled property

Signature

alertingEnabled: boolean;

alertingErrorOrTimeout property

Signature

alertingErrorOrTimeout: string;

alertingMinInterval property

Signature

alertingMinInterval: number;

alertingNoDataOrNullValues property

Signature

alertingNoDataOrNullValues: string;

allowOrgCreate property

Signature

allowOrgCreate: boolean;

angularSupportEnabled property

Signature

angularSupportEnabled: boolean;

applicationInsightsConnectionString property

Signature

applicationInsightsConnectionString?: string;

applicationInsightsEndpointUrl property

Signature

applicationInsightsEndpointUrl?: string;

appSubUrl property

Signature

appSubUrl: string;

appUrl property

Signature

appUrl: string;

auth property

Signature

auth: AuthSettings;

authProxyEnabled property

Signature

authProxyEnabled: boolean;

autoAssignOrg property

Signature

autoAssignOrg: boolean;

awsAllowedAuthProviders property

Signature

awsAllowedAuthProviders: string[];

awsAssumeRoleEnabled property

Signature

awsAssumeRoleEnabled: boolean;

azure property

Signature

azure: AzureSettings;

azureAuthEnabled property

Signature

azureAuthEnabled: boolean;

bootData property

Signature

bootData: BootData;

buildInfo property

Signature

buildInfo: BuildInfo;

caching property

Signature

caching: {
        enabled: boolean;
    };

customTheme property

Signature

customTheme?: undefined;

dashboardPreviews property

Signature

dashboardPreviews: {
        systemRequirements: {
            met: boolean;
            requiredImageRendererPluginVersion: string;
        };
        thumbnailsExist: boolean;
    };

datasources property

Signature

datasources: {
        [str: string]: DataSourceInstanceSettings;
    };

dateFormats property

Signature

dateFormats?: SystemDateFormatSettings;

defaultDatasource property

Signature

defaultDatasource: string;

disableLoginForm property

Signature

disableLoginForm: boolean;

disableSanitizeHtml property

Signature

disableSanitizeHtml: boolean;

disableUserSignUp property

Signature

disableUserSignUp: boolean;

editorsCanAdmin property

Signature

editorsCanAdmin: boolean;

exploreEnabled property

Signature

exploreEnabled: boolean;

expressionsEnabled property

Signature

expressionsEnabled: boolean;

externalUserMngInfo property

Signature

externalUserMngInfo: string;

externalUserMngLinkName property

Signature

externalUserMngLinkName: string;

externalUserMngLinkUrl property

Signature

externalUserMngLinkUrl: string;

featureHighlights property

Signature

featureHighlights: {
        enabled: boolean;
    };

featureToggles property

Signature

featureToggles: FeatureToggles;

feedbackLinksEnabled property

Signature

feedbackLinksEnabled: boolean;

geomapDefaultBaseLayerConfig property

Signature

geomapDefaultBaseLayerConfig?: MapLayerOptions;

geomapDisableCustomBaseLayer property

Signature

geomapDisableCustomBaseLayer?: boolean;

googleAnalyticsId property

Signature

googleAnalyticsId: undefined;

grafanaJavascriptAgent property

Signature

grafanaJavascriptAgent: {
        enabled: boolean;
        customEndpoint: string;
        apiKey: string;
        errorInstrumentalizationEnabled: boolean;
        consoleInstrumentalizationEnabled: boolean;
        webVitalsInstrumentalizationEnabled: boolean;
    };

helpEnabled property

Signature

helpEnabled: boolean;

http2Enabled property

Signature

http2Enabled: boolean;

isPublicDashboardView property

Signature

isPublicDashboardView: boolean;

jwtHeaderName property

Signature

jwtHeaderName: string;

jwtUrlLogin property

Signature

jwtUrlLogin: boolean;

ldapEnabled property

Signature

ldapEnabled: boolean;

licenseInfo property

Signature

licenseInfo: LicenseInfo;

liveEnabled property

Signature

liveEnabled: boolean;

loginError property

Signature

loginError: undefined;

loginHint property

Signature

loginHint: string;

minRefreshInterval property

Signature

minRefreshInterval: string;

Signature

navTree: undefined;

newPanelTitle property

Signature

newPanelTitle: string;

oauth property

Signature

oauth: OAuthSettings;

panels property

Signature

panels: {
        [key: string]: PanelPluginMeta;
    };

passwordHint property

Signature

passwordHint: string;

pluginAdminEnabled property

Signature

pluginAdminEnabled: boolean;

pluginAdminExternalManageEnabled property

Signature

pluginAdminExternalManageEnabled: boolean;

pluginCatalogHiddenPlugins property

Signature

pluginCatalogHiddenPlugins: string[];

pluginCatalogURL property

Signature

pluginCatalogURL: string;

pluginsToPreload property

Signature

pluginsToPreload: PreloadPlugin[];

profileEnabled property

Signature

profileEnabled: boolean;

queryHistoryEnabled property

Signature

queryHistoryEnabled: boolean;

rbacBuiltInRoleAssignmentEnabled property

Signature

rbacBuiltInRoleAssignmentEnabled: boolean;

rbacEnabled property

Signature

rbacEnabled: boolean;

recordedQueries property

Signature

recordedQueries: {
        enabled: boolean;
    };

rendererAvailable property

Signature

rendererAvailable: boolean;

rendererVersion property

Signature

rendererVersion: string;

reporting property

Signature

reporting: {
        enabled: boolean;
    };

rudderstackConfigUrl property

Signature

rudderstackConfigUrl: undefined;

rudderstackDataPlaneUrl property

Signature

rudderstackDataPlaneUrl: undefined;

rudderstackSdkUrl property

Signature

rudderstackSdkUrl: undefined;

rudderstackWriteKey property

Signature

rudderstackWriteKey: undefined;

samlEnabled property

Signature

samlEnabled: boolean;

samlName property

Signature

samlName: string;

secretsManagerPluginEnabled property

Signature

secretsManagerPluginEnabled: boolean;

sentry property

Signature

sentry: {
        enabled: boolean;
        dsn: string;
        customEndpoint: string;
        sampleRate: number;
    };

sigV4AuthEnabled property

Signature

sigV4AuthEnabled: boolean;

theme property

Signature

theme: GrafanaTheme;

theme2 property

Signature

theme2: GrafanaTheme2;

unifiedAlerting property

Signature

unifiedAlerting: {
        minInterval: string;
    };

unifiedAlertingEnabled property

Signature

unifiedAlertingEnabled: boolean;

verifyEmailEnabled property

Signature

verifyEmailEnabled: boolean;

viewersCanEdit property

Signature

viewersCanEdit: boolean;

windowTitlePrefix property

Signature

windowTitlePrefix: string;