Skip to content

The Business Text panel plugin allows you to construct a text visualization template from the values of a dataset returned by a data source query.

License

Notifications You must be signed in to change notification settings

VolkovLabs/business-text

Repository files navigation

Business Text for Grafana

Text

Grafana CI E2E codecov CodeQL

Introduction

The Business Text panel plugin allows you to construct a text visualization template from the values of a dataset returned by a data source query.

Business Text plugin for Grafana | Use HTML, Markdown, JavaScript and CSS | Community use cases

Requirements

  • Business Text panel 5.X requires Grafana 10 or Grafana 11.
  • Dynamic Text panel 4.X requires Grafana 9.2 or Grafana 10.
  • Dynamic Text panel 2.X and 3.X require Grafana 8.5 or Grafana 9.
  • Dynamic Text panel 1.X requires Grafana 7.

Getting Started

You can install the Business Text panel from the Grafana Plugins catalog or use the Grafana command line tool.

For the latter, please use the following command:

grafana-cli plugins install marcusolsson-dynamictext-panel

Highlights

  • Uses Monaco Code Editor with automatic JavaScript code formatting.
  • Supports Markdown and Handlebars.
  • Renders markdown-it into HTML elements.
    • Supports the highlighting of code syntax using A11Y styles.
  • Provides code sanitization:
    • HTML inside templates is sanitized using XSS.
    • Can be disabled in the Grafana configuration through the disable_sanitize_html parameter.
  • Supports display of nested objects using the {{json object}} Handlebars helper.
  • Supports display of time global variables (__to and __from) as seconds, ISO timestamps, or formatted using the dayjs library.
  • Supports adding the Handlebars helpers and event handlers.
  • Supports adding CSS styles with dashboard variables.
  • Supports internationalization using custom helpers.

Documentation

Section Description
Rendering Explains how to create a visualization template for your data
Recipes Useful snippets that you can use in your templates
Features Demonstrates panel features.templates
Tutorials Easy to follow tutorials
Release Notes Stay up to date with the latest features and updates

Business Suite for Grafana

The Business Suite is a collection of open source plugins created and actively maintained by Volkov Labs.

The collection aims to solve the most frequent business tasks by providing an intuitive interface with detailed written documentation, examples, and video tutorials.

Business Suite for Grafana

Enterprise Support

With the Business Suite Enterprise, you're not just getting a product, you're getting a complete support system. You'll have a designated support team ready to tackle any issues.

You can contact us via Zendesk, receive priority in feature requests and bug fixes, meet with us for in-person consultation, and get access to the Business Intelligence. It's a package that's designed to make your life easier.

Always happy to hear from you

License

Apache License Version 2.0, see LICENSE.