Grafana Enterprise Traces

Overview
Installation
Change log
Related content

Grafana Enterprise Traces

Grafana Enterprise Traces (GET) is a commercial offering based on the open-source project Tempo. The commercial offering allows you to deploy a highly-scalable, simple, and reliable traces cluster in your own data center. The app plugin gives you an easy way to manage your traces cluster.

Features

Tenant management: Easily scale up to hundreds of GET 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 Traces 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 GET, and the corresponding URL where the cluster can be accessed by the Grafana instance.
Start using the Grafana Enterprise Traces app plugin.

Installing Grafana Enterprise Traces on Grafana Cloud:

For more information, visit the docs on plugin installation.

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
[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

GET plugin changes (pre-synchronization)

The following versions and changes represent those of the GET plugin, prior to synchronizing all plugins to v5.0.0.

v2.3.1 -- June 25, 2024

[FIX] - Updated dependencies to resolve security concerns

v2.3.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

v2.2.2 -- 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

v2.2.1 -- November 28, 2023

[FIX] - Updated dependencies to resolve security concerns

v2.2.0 -- November 07, 2023

[FIX] - Updated dependencies to resolve security concerns
[ENHANCEMENT] - Include compactor, distributor and metrics-generator rings on the GET ring health page

v2.1.1 -- September 22, 2023

[FIX] - Updated dependencies to resolve security concerns

v2.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

v2.0.0 -- March 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
[ENHANCEMENT] Use cluster feature detection for better backward and forward compatibility with backend
[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
[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
[FIX] - The editing of access policies now uses a edit button
[FIX] - Enabled 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

v1.1.0 -- May 2 2022

[ENHANCEMENT] - Improved flow of access policy creation, including automatically selecting appropriate scopes based on user's intention to create a datasource
[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
[FEATURE] - Added ring health page
[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
[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] - Fixed the ring health page "forget" button behavior: ring members will now only be removed from the list when the request has succeeded