Plugins 〉Grafana Enterprise Logs
Grafana Enterprise Logs
Grafana Enterprise Logs
Grafana Enterprise Logs (GEL) is a commercial offering based on the open-source project Loki. The commercial offering allows you to deploy a highly-scalable, simple, and reliable logs cluster in your own data center. This app plugin gives you an easy way to manage your logs cluster.
Features
- Tenant management: Easily scale up to hundreds of GEL tenants on a single cluster.
- Access policies and tokens: Fully control and visualise who has access to what.
- Ring health Give an overview on the current status of the various service rings in the cluster.
Configuration
After the plugin has been installed into your Grafana instance, enable and initialize it:
- Navigate to Administration > Plugins and data > Plugins
- Select the Grafana Enterprise Logs app from the list of plugins.
- If an alert indicates that this app plugin is not enabled, enable the plugin by clicking on the Enable button. The alert text will indicate where it can be found.
- Ensure that the Connection settings section is filled out using the bootstrap token for your GEL, and the corresponding URL where the cluster can be accessed by the Grafana instance.
- Start using the Grafana Enterprise Logs app plugin.
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
.h4 . .mb-0 }
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Grafana Cloud Free
- Free tier: Limited to 3 users
- Paid plans: $55 / user / month above included usage
- Access to all Enterprise Plugins
- Fully managed service (not available to self-manage)
Self-hosted Grafana Enterprise
- Access to all Enterprise plugins
- All Grafana Enterprise features
- Self-manage on your own infrastructure
Installing Grafana Enterprise Logs on Grafana Cloud:
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
Installing plugins on a Grafana Cloud instance is a one-click install; same with updates. Cool, right?
Note that it could take up to 1 minute to see the plugin show up in your Grafana.
For more information, visit the docs on plugin installation.
Installing on a local Grafana:
For local instances, plugins are installed and updated via a simple CLI command. Plugins are not updated automatically, however you will be notified when updates are available right within your Grafana.
1. Install the Application
Use the grafana-cli tool to install Grafana Enterprise Logs from the commandline:
grafana-cli plugins install
The plugin will be installed into your grafana plugins directory; the default is /var/lib/grafana/plugins. More information on the cli tool.
Alternatively, you can manually download the .zip file for your architecture below and unpack it into your grafana plugins directory.
Alternatively, you can manually download the .zip file and unpack it into your grafana plugins directory.
2. Enable it
Next, log into your Grafana instance. Navigate to the Plugins section, found in your Grafana main menu.
Click the Apps tabs in the Plugins section and select the newly installed app.
To enable the app, click the Config tab. Follow the instructions provided with the application and click Enable. The app and any new UI pages are now accessible from within the main menu, as designed by the app creator.
If dashboards have been included with the application, they will attempt to be automatically installed. To view the dashboards, re-import or delete individual dashboards, click the Dashboards tab within the app page.
Changelog
All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.
Shared versioning and change log
The content of this changelog as far back as October 2024 (v5.0.0) is shared by multiple plugins in the common "GEx Plugins" project. Changelog entries will call out whether a change is specific to an individual plugin. The releases for the plugins will be synchronized and share the same version numbers.
v5.0.2 -- October 11, 2024
- [FIX] - Corrected error message handling for unconfigured connection settings
v5.0.0 -- October 10, 2024
- [BREAKING] - Support for Admin API v1 and v2 has been dropped. Only Admin API v3 will be used, which was introduced in April 2022.
- The earliest versions of the Enterprise Databases with the v3 API are as follows:
- GEM v2.0
- GEL v1.4
- GET v1.3
- The earliest versions of the Enterprise Databases with the v3 API are as follows:
- [BREAKING] - The officially supported Grafana version range is now:
>= 10.4.10 < 11 || >= 11.1.0
- Backward compatibility support for Grafana Enterprise v8 and v9 has been removed
- [FIX] - Enterprise license failure detection and reporting has been improved to help identify this problem faster
- [FIX] - Updated dependencies to resolve security concerns
- [FIX] - Remove 5 second delay when saving plugin configuration
End of synchronized changelog
GEL plugin changes (pre-synchronization)
The following versions and changes represent those of the GEL plugin, prior to synchronizing all plugins to v5.0.0.
v3.2.1 -- June 25, 2024
- [FIX] - Updated dependencies to resolve security concerns
v3.2.0 -- March 14, 2024
- [FIX] - Ring health: standardized look of ring selector, and removed hard-to-see alert coloring
- [FIX] - Updated dependencies to resolve security concerns
v3.1.4 -- January 12, 2024
- [FIX] - Detect more license error and backend error states to present root cause information to the user
- [FIX] - Updated dependencies to resolve security concerns
v3.1.3 -- November 28, 2023
- [FIX] - Updated dependencies to resolve security concerns
v3.1.2 -- November 07, 2023
- [FIX] - Updated dependencies to resolve security concerns
v3.1.1 -- September 22, 2023
- [FIX] - Updated dependencies to resolve security concerns
v3.1.0 -- September 19, 2023
- [ENHANCEMENT] Tenant stats will refetch every 30 minutes automatically
- [ENHANCEMENT] Display details of Grafana Enterprise license on Licenses page
- [FIX] Addresses CVE vulnerability reports
- [FIX] Handle tenants and access policies that do not have a display name
v3.0.1 -- March 31, 2023
- [ENHANCEMENT] - Added selectable custom expiration date to token expiry
- [ENHANCEMENT] - Formatted numbers according to local number string
- [ENHANCEMENT] - Added indication on minimum access policy scope requirements for datasource creation after generating a token
- [ENHANCEMENT] - The plugin overview page now displays accurate descriptions
- [FIX] - When creating datasource, we check if backend URL is defined
- [FIX] - When creating token in an access policy with no remaining tenants activated, the user is warned and not able to create datasources
v3.0.0 -- January 31, 2023
- [FEATURE] - Changed supported Grafana version range:
>= 8.5.20 < 9 || >= 9.1.0
; warnings are displayed if the Grafana version is not within the officially supported range - [FEATURE] - Added support for Grafana 9.3, including Grafana's new navigation updates
- [FEATURE] - The backend database version is now displayed on the plugin (and configuration page)
- [ENHACENMENT] - Added descriptions for access policy scopes
- [ENHACENMENT] - Added progress indicators during requests to create/edit tenants, access policies, and tokens; a successful alert notification now appears as on the top-right corner of the screen when the request is completed
- [ENHANCEMENT] - The ring health page allows selection of rings that have no members
- [ENHANCEMENT] - The plugin configuration page has been moved to exist alongside the other plugin pages (e.g., tenants, access policies, etc.); this manifests as a tab when "topnav" is disabled, or within the same navigation menu tree structure when "topnav" is enabled;
- [ENHACNEMENT] - The plugin configuration page no longer duplicates the functionality of disabling or enabling the plugin
- [ENHACNEMENT] - The plugin configuration page has a cancel button which reverts back to the saved state
- [FIX] - The ring health page handles backend errors more gracefully (e.g., when the request from using the forget button fails)
- [FIX] - The ring health page is able to handle the newer implementation for expressing "unhealthy" ringe member status
- [FIX] - Access policies with very long names are better supported: it is now possible to create more than one token for them; their long names are now displayed without breaking the layout
- [FIX] - The tenants page no longer makes multiple redundant requests (per number of tenants)
- [FIX] - Admin resource display names are now converting all non-alphanumeric characters correctly into dashes when generating their identifier
- [FIX] - Added restrictions to tenant limit overrides on input fields, such as preventing invalid negative limits
v2.6.0 -- July 28 2022
- [FEATURE] - Single-click creation of datasources with multiple tenants is enabled for GEL clusters with federated query support (expected in GEL 1.5)
- [ENHANCEMENT] - Use cluster feature detection for better backward and forward compatibility with backend
- [FIX] - The editing of access policies now uses a edit button
- [FIX] - Added the ability to edit tenants
- [FIX] - Clarified language on cluster configuration page, to better indicate the the origin of the displayed values
- [FIX] - The cluster configuration page now correctly extracts the top level configuration, and uses alphabetic order for all other sections
- [FIX] - On access policies page, indicate token fetch status instead of always defaulting to a misleading "no tokens."
- [FIX] - Fixed issues preventing the ability to edit access policy scopes
v2.5.1 -- May 2 2022
- [FIX] - When admin api version is not explicitly configured, the latest compatible version will be automatically detected and act as a default
- [FIX] - The access policy creation form provides an informative tooltip for the "Yes" button (regarding scopes for creating a datasource); also ensuring the correct scopes are added by default
- [FIX] - Fixed interpretation of dates in "last heartbeat" column in ring health page; the relative time offset will periodically update now, and a tooltip will display the reported date and time
- [FIX] - Clarify license status, providing warning banners if the license is expired, or near expiry
- [FIX] - Alphabetized ring types on ring health page
- [FIX] - Fixed the ring health page "forget" button behavior: ring members will now only be removed from the list when the request has succeeded
- [FIX] - Removed text on the access policy tenant label selectors that does not apply to GEL
v2.5.0 -- April 22 2022
- [ENHANCEMENT] - Improved flow of access policy creation, including automatically selecting appropriate scopes based on user's intention to create a datasource
- [FIX] - Fixed token deletion for older versions of GEL
- [FIX] - Prevent the plugin from being disabled after modifying the plugin configuration
v2.4.1 -- April 18 2022
- [FIX] - Fixed compatibility with admin API versions 1 and 2 for listing access policies and tokens
- [FIX] - Fixed issue displaying tenant stats when self-monitoring datasource cannot be found
- [FIX] - Fixed plugin configuration validator providing misleading error messages regarding available versions when a url error should have been shown
v2.4.0 -- April 13 2022
- [FEATURE] - Added ring health page
- [ENHANCEMENT] - Added rules:read rules:write scopes for GEL
- [ENHANCEMENT] - Added support for admin API versions 2 and 3; version can be selected in plugin configuration
- [ENHANCEMENT] - Debug export now appears, conditionally on backend support
- [ENHANCEMENT] - Improved form usability for creating and editing tenants, access policies, and tokens
- [ENHANCEMENT] - Restored compatibility with Grafana v7.5
- [ENHANCEMENT] - Token creation dialog now defines expiry in terms of days
- [FIX] - Fixed token creation dialog's copy-to-clipboard functionality for later versions of Grafana
- [FIX] - In the token dialog, the ability to create datasources is appropriately limited to a single tenant (to match actual capability of backend service)
- [FIX] - Interpret initial If-Match ETag when fetching collections of tokens, access policies, and tenants
- [FIX] - Remove extra trailing slashes in plugin settings and remote write URLs
- [FIX] - Token creation dialog will offer to create datasources only when read scopes are present
v2.3.2 -- March 14 2022
- [FIX] - Fixed copy-to-clipboard functionality for Grafana v8.3+
- [FIX] - Add rules:read rules:write for GEL
v2.3.1 -- February 24 2022
- [FIX] - Add compatibility with grafana-enterprise v8.4.2+
v2.3.0 -- November 12 2021
- [FEATURE] - Added ability to edit access policies
- [FIX] - Ensure
__system__
access policy does not appear - [FIX] - Change of terminology to "Tenants" (previously was "Instances")
- [FIX] - Fixed issue related to saving and updating instance limits (If-Match, ETag stability)
v2.2.0 -- August 19 2021
- [ENHANCEMENT] - Show more detailed error messages for not correctly formatted access-tokens on the plugin config page
- [ENHANCEMENT] - Update self-monitoring dashboards, introduce a new "Overview Dashboard"
v2.1.0 -- August 13 2021
- [FEATURE] - Add a simple way to automatically generate datasources when creating a new logs:read token
- [FEATURE] - Make it possible to create wildcard access-policies that are applied to all instances in a cluster
- [FIX] - Hide the
__system__
instance when self-monitoring is not available
v2.0.1 -- June 15 2021
- [FIX] - Make the modals scrollable when creating a new instance, access-policy or token (introduced in v2.0.0)
v2.0.0 -- June 14 2021
- [FEATURE] - Make the plugin compatible with Grafana 8 (Breaking change! - this version doesn't work with earlier versions of Grafana anymore)
v1.1.0 -- June 14 2021
- [FIX] - Make "admin", "alerts:read" and "alerts:write" scopes available for new access policies
- [FEATURE] - Update the look of the access policies list items
- [FEATURE] - Enable LBAC (Label Based Access Control) in the plugin
v1.0.1 -- March 17 2021
- [FIX] - Show hints (and disable the submit) for incorrectly formatted tokens on the app config page
- [FIX] - Make backspaces work in the token input field
v1.0.0
Initial release with supporting the basic features of Grafana Enterprise Logs (GEL).