Plugins 〉Grafana Enterprise Metrics

Application
grafana
Enterprise

Grafana Enterprise Metrics

  • Overview
  • Installation
  • Change log
  • Related content

Grafana Enterprise Metrics

Grafana Enterprise Metrics (GEM) is a commercial offering based on the open-source project Cortex. The commercial offering allows you to deploy a higly-scalable, simple, and reliable Metrics cluster in your own data center. The plugin gives you an easy way to manage your metrics cluster.

Features

  • Tenant Management Easily scale up to hundreds of metrics tenants on a single Metrics Enterprise cluster.
  • Access Policies and Tokens Fully control and visualize who has access to what.
  • Ingester statuses Give an overview on the current status of the ingesters in the cluster.

Configuration

After the plugin has been installed into your Grafana instance, enable and initialize it:

  1. Navigate to Configuration > Plugins within your Grafana instance, then select the "Grafana Metrics Enterprise" app from the list.

  2. Click the Enable plugin button on the plugin page to enable the plugin.

  3. Fill out the API Settings section using the bootstrap token for your enterprise Cortex and a URL where it can be accessed.

  4. Navigate to Configuration > Plugins within your Grafana instance.

  5. Select the Grafana Enterprise Metrics app from the list.

  6. Click the Enable plugin button on the plugin page to enable the plugin.

  7. Fill out the API settings section with the GEM bootstrap token and a URL where the cluster can be accessed.

  8. Start using the GEM plugin.

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.

v3.3.0 -- November 16 2021

  • [FEATURE] - Cardinality management dashboards
  • [FIX] - Change of terminology to "Tenants" (previously was "Instances")
  • [FIX] - Only customizable limits are shown when editing limits settings for tenants
  • [FIX] - Deleting a tenant's custom limits can be done be removing all custom limit entries before saving changes
  • [FIX] - Fixed issue related to saving and updating instance limits (If-Match, ETag stability)
  • [FIX] - Dashboard initialization routines refresh logic

v3.2.1 -- August 23 2021

  • [FIX] - Self-monitoring dashboards: sort a few charts in descending order

v3.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"

v3.1.0 -- August 09 2021

  • [FEATURE] - Add a button for exporting debug information about the gateway / admin API target
  • [FEATURE] - Make it possible to create wildcard access-policies that are applied to all instances in a cluster
  • [FIX] - GEM Self-Monitoring datasource: handle redundant slash in backendUrl during initialization
  • [FIX] - GEM Self-Monitoring datasource: make existence detection work in proxied environments
  • [FIX] - Ring health table: use natural sort order when sorting by member ids (interpret numbers inside strings)
  • [FIX] - In Access Policy form, stop showing the __system__ instance in the instance-selector
  • [FIX] - When creating a token for an access policy which applies to multiple instances, there is now a button available to create a single data source to encompass all of them; Users can now create a datasource for doing cross-tenant queries in a single click

v3.0.4 -- June 28 2021

  • [FIX] - Prevent enter key from triggering label delete in "create / update access policy"

v3.0.3 -- June 17 2021

  • [FIX] - Updated scope names: rules:read and rules:write for compatibility with recent backend changes
  • [FIX] - Updated text content of GEM Self-Monitoring dashboards (introduced in v2.1.0)

v3.0.2 -- June 15 2021

  • [FIX] - Moved self-monitoring dashboards into separate folder (introduced in v2.1.0)
  • [FIX] - Improved flexibility of GEM Self-Monitoring dashboard initialization (introduced in v2.1.0)

v3.0.1 -- June 15 2021

  • [FIX] - Make the modals scrollable when creating a new instance, access-policy or token (introduced in v3.0.0)
  • [FIX] - Make updates work again by passing the correct If-Match headers (introduced in v3.0.0)

v3.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)

v2.1.1 - June 17 2021

  • [FIX] - Updated scope names: rules:read and rules:write for compatibility with recent backend changes
  • [FIX] - Updated text content of GEM Self-Monitoring dashboards (introduced in v2.1.0)

v2.1.0 - June 14 2021

  • [FEATURE] - Make access policies editable
  • [FEATURE] - Update the look of the access policies list items
  • [FEATURE] - Include GEM Self-Monitoring dashboards

v2.0.1 - April 29 2021

  • [FIX] - Make array-type instance limits editable
  • [FIX] - Make data source links respect the base URL after creating a data source for a token
  • [FIX] - Make "admin", "alerts:read" and "alerts:write" scopes available for new access policies
  • [FIX] - Remove the cluster selector for now under the "Ring health" page

v2.0.0 - April 20 2021

  • [FIX] - Make instance statistics show up consistently
  • [FEATURE] - Make instances editable
  • [FEATURE] - Visualise instance limits in the instances list
  • [FEATURE] - Add a way to set instance-specific limits when creating a new instance
  • [FEATURE] - A generic Ring Health page replaced the Ingester Ring page
    • Now all five rings can be monitored and repaired
    • The user can specify the refresh interval

v1.9.3 -- 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.9.2 -- February 18 2021

  • [FIX] - Update the README

v1.9.1 -- February 03 2021

  • [FIX] - Add the backend plugin to the build

v1.9.0 -- February 01 2021

  • [FEATURE] - Update the design for no instances / access policies
  • [FEATURE] - Display the current UTC time above the instances / access-policies lists
  • [FEATURE] - Add a simple way to automatically generate datasources when creating a new metrics:read token

v1.8.0 -- January 22 2021

  • [FEATURE] - Make it possible to set the expiration date for a new token
  • [FEATURE] - Update the lookout of the successful token creation modal
  • [FIX] - Only show the label selectors when they make sense while creating an access policy

v1.7.0 -- January 22 2021

  • [FEATURE] - Introduce all scopes supported by the backend when creating a new access policy
  • [FIX] - Fix flakiness of the auto-generated name when creating a new access policy
  • [FIX] - Don't touch hyphens "-" when auto-generating the name for instances and access policies

v1.6.0 -- January 20 2021

  • [FEATURE] - Show copyable remote-write config snippets when creating a new token for an access policy with write permissions

v1.5.0 -- January 12 2021

  • [FEATURE] - Make it possible to set the "name" manually for a new instance

v1.4.2 -- January 07 2021

  • [FIX] - Fix the sidebar navigation

v1.4.1 -- December 16 2020

  • [FIX] - Don't show the placeholder for label selectors if they are not defined for an instance
  • [FIX] - Fix the width of the instance names on the detailed access policy page

v1.4.0 -- December 16 2020

  • [FEATURE] - Make it possible to define label selectors for the instances when creating an access policy
  • [FEATURE] - Add a detailed page for access policies with syntax highlighted label policies

v1.3.0 -- November 19 2020

  • [FEATURE] - Show collapsable sections under the cortex config and make it searchable
  • [FEATURE] - Mark the default access policy and remove the delete button from it. Also add a hint on how to delete it.

v1.2.0 -- November 2 2020

  • [FEATURE] - Add a tab for showing license information
  • [FEATURE] - Add a new design for Access Policies
  • [FEATURE] - Show instance statistics if they are available

v1.1.1 -- September 24 2020

  • [FIX] - Make plugin navigation links work even if Grafana is installed under a base URL
  • [FIX] - Make error messages coming from the API visible for the user

v1.1.0 -- September 16 2020

  • [FEATURE] - Update the logo

v1.0.0 -- September 16 2020

  • [FEATURE] - Introduce Access Policies
  • [FEATURE] - Switch out Keys with Access Policies & Tokens
  • [FEATURE] - Restrict the plugin and the admin API to only be accessible by Admin users
  • [FEATURE] - Remove the datasource plugin and move all configuration under the app plugin
  • [FEATURE] - Move the tokens under the Access Policies tab for an easier user flow
  • [CHORE] - Add an optional mock server for easier development

v0.9.1 -- August 13 2020

  • [FIX] Enable the Ingester Ring tab by default

v0.9.0 -- August 13 2020

  • [FEATURE] Add an Ingester Rings tab showing a basic table with the available ingesters
  • [FEATURE] Update the plugin logo
  • [CHORE] Add plugin description to the plugin config page

v0.8.0 -- July 31 2020

  • [FEATURE] Add error handling to the New Instance and New Key forms

v0.7.0 -- July 24 2020

  • [CHORE] Rename the plugin to "Grafana Metrics Enterprise".
  • [FEATURE] Display the available clusters in a select when creating a new instance.

v0.6.0 -- July 23 2020

  • [FEATURE] Hide certain tabs from the UI by default.

v0.5.5 -- July 22 2020

  • [FEATURE] Make it possible to set / read feature flags.

v0.5.4 -- July 21 2020

  • [FEATURE] Display the token once after a new key has been created.

v0.5.2 -- July 14 2020

  • [FIX] Add missing cluster field when creating a new instance

v0.5.1 -- July 13 2020

  • [FIX] Fix switching between tabs by clicking (introduced by v0.5.0)

v0.5.0 -- July 9 2020

  • [FEATURE] Generate the name automatically for Keys and Instances

v0.4.0 -- July 8 2020

  • [FEATURE] Displaying cluster and created time for the Instances
  • [FEATURE] Displaying expiration time, connected instance and scopes for the Keys

v0.3.0 -- July 6 2020

  • [FEATURE] Updated the UI for the Instances tab
  • [FEATURE] Updated the UI for the Keys tab
  • [FEATURE] Can delete Instances & Keys
  • [FEATURE] Open create-key & create-instance forms in modals

v0.2.0 -- June 26 2020

  • [FEATURE] Added support for key "Realms"

v0.1.0 -- June 3 2020

  • [FEATURE] Added rough support for admin info endpoints

v0.0.1 -- May 20 2020

  • [FEATURE] Existence. #90
  • [FEATURE] Add support for Admin Instance Mgmt Auth. #94