Menu
Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
Enterprise
Open source
GrafanaBootConfig class
Signature
export declare class GrafanaBootConfig implements GrafanaConfig Import
import { GrafanaBootConfig } from '@grafana/runtime';Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| constructor(options) | Constructs a new instance of the GrafanaBootConfig class |
Properties
constructor(options)
Constructs a new instance of the GrafanaBootConfig class
Signature
constructor(options: GrafanaBootConfig);Parameters
| Parameter | Type | Description |
|---|---|---|
| options | GrafanaBootConfig |
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;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;bootData property
Signature
bootData: BootData;buildInfo property
Signature
buildInfo: BuildInfo;caching property
Signature
caching: {
enabled: boolean;
};customTheme property
Signature
customTheme?: any;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;helpEnabled property
Signature
helpEnabled: boolean;http2Enabled property
Signature
http2Enabled: 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;navTree property
Signature
navTree: any;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;recordedQueries property
Signature
recordedQueries: {
enabled: boolean;
};rendererAvailable property
Signature
rendererAvailable: boolean;rendererVersion property
Signature
rendererVersion: string;reporting property
Signature
reporting: {
enabled: boolean;
};samlEnabled property
Signature
samlEnabled: boolean;samlName property
Signature
samlName: string;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;unifiedAlertingEnabled property
Signature
unifiedAlertingEnabled: boolean;verifyEmailEnabled property
Signature
verifyEmailEnabled: boolean;viewersCanEdit property
Signature
viewersCanEdit: boolean;windowTitlePrefix property
Signature
windowTitlePrefix: string;Was this page helpful?
Related resources from Grafana Labs
60 min
Getting started with managing your metrics, logs, and traces using Grafana
In this webinar, we’ll demo how to get started using the LGTM Stack: Loki for logs, Grafana for visualization, Tempo for traces, and Mimir for metrics.
15 Jan
Getting started with Grafana dashboard design
In this webinar, you'll learn how to design stylish and easily accessible Grafana dashboards that tell a story.
29 Jan
Building advanced Grafana dashboards
In this webinar, we’ll demo how to build and format Grafana dashboards.