Plugins 〉RSS/Atom
RSS/Atom
RSS/Atom Data Source for Grafana
Introduction
The RSS/Atom data source is a plugin for Grafana that retrieves RSS/Atom feeds and allows to visualize them using Dynamic Text and other panels.
Requirements
- Grafana 8.5+, Grafana 9.0+ is required for version 2.X.
- Grafana 8.0+ is required for version 1.X.
Getting Started
RSS/Atom data source can be installed from the Grafana Catalog or use the grafana-cli
tool to install from the command line:
grafana-cli plugins install volkovlabs-rss-datasource
Features
- Supports RSS 2.0, RSS 1.0 and Atom.
- Works great with Dynamic Text panel by Marcus Olsson (marcusolsson-dynamictext-panel).
- Returns Channel (Feed) data, Items (Entries) or both as separate data frames.
- Extract and parse as additional fields:
- Image from Meta.
- H4 and Image from the Encoded content.
- Media:Group for YouTube.
- Filter items/entries based on the selected Time Range.
Provisioning
Grafana supports managing data sources by adding one or more YAML config files in the provisioning/datasources
folder.
Example of provisioning the RSS/Atom Data Source for Bitcoin news feed.
datasources:
- name: Bitcoin
type: volkovlabs-rss-datasource
access: proxy
orgId: 1
uid: rZAdZdf7k
version: 1
editable: true
jsonData:
feed: https://news.bitcoin.com/feed/
Disable Sanitize HTML
To display HTML returned from feeds please disable sanitize HTML parameter. For Docker:
GF_PANELS_DISABLE_SANITIZE_HTML=true
Feedback
We love to hear from users, developers, and the whole community interested in this plugin. These are various ways to get in touch with us:
- Ask a question, request a new feature, and file a bug with GitHub issues.
- Sponsor our open-source plugins for Grafana with GitHub Sponsor.
- Star the repository to show your support.
License
- Apache License Version 2.0, see LICENSE.
Grafana Cloud Pro
- $25 / user / month and includes a free trial for new users
- Available with a Grafana Cloud Pro plan
- Access to 1 Enterprise plugin
- Fully managed service (not available to self-manage)
Grafana Cloud Advanced / Grafana Enterprise
- Available with a Grafana Cloud Advanced plan or Grafana Enterprise license
- Access to all Enterprise plugins
- Run fully managed or self-manage on your own infrastructure
Installing RSS/Atom 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.
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 Data Source
Use the grafana-cli tool to install RSS/Atom 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. Configure the Data Source
Accessed from the Grafana main menu, newly installed data sources can be added immediately within the Data Sources section.
Next, click the Add data source button in the upper right. The data source will be available for selection in the Type select box.
To see a list of installed data sources, click the Plugins item in the main menu. Both core data sources and installed data sources will appear.
Change Log
2.3.0 (2022-11-16)
Features / Enhancements
- Update to Grafana 9.1.4 (#36)
- Add Compatibility Check Workflow (#37)
- Update CI to Node 16 and Synchronize with Release workflow (#39)
- Update to Grafana 9.2.2 (#40)
- Update CI to upload signed artifacts (#41)
2.2.0 (2022-08-25)
Features / Enhancements
- Add YouTube video in README (#32)
- Rebuild based on 9.1.1 (#35)
2.1.0 (2022-06-23)
Features / Enhancements
- Add YouTube fields parsing and refactoring (#31)
2.0.0 (2022-06-17)
Breaking changes
- Requires Grafana 8.5+ and 9.0+
Features / Enhancements
- Rebuild based on 9.0.0 (#30)
1.7.0 (2022-05-21)
Features / Enhancements
- Support Feed URL with query parameters (#28)
1.6.2 (2022-05-13)
Breaking changes
- Requires Grafana 8.3.0 or newer.
1.6.1 (2022-05-13)
Features / Enhancements
- Clarify Breaking change introduced in 1.6.0 (#24)
- Refactor API tests and set parsing
rss.channel.item
as array always (#25) - Improve test coverage (#26)
1.6.0 (2022-05-12)
Breaking changes
- Automatic parsing of
author.name
andmedia:thumbnail.url
fields break templates who uses them. To fix it, just replace it withauthor
andmedia:thumbnail
. Thanks to @vfauth for testing.
Features / Enhancements
- Rebuild based on 8.5.2 (#23)
Bug fixes
- Can't parse GitHub releases feed (#21)
1.5.0 (2022-04-25)
Features / Enhancements
- Add Provisioning instructions to README (#16)
- Rebuild using 8.4.3 (#17)
- Adding RSS 1.0 support (#19)
- Rebuild based on 8.5.0 (#20)
1.4.0 (2022-02-18)
Features / Enhancements
- Rebuild using 8.3.6 (#13)
- Rebuild using 8.4.0 and use PluginCheck v2 (#14)
- Select items/entries based on the selected Time Range (#3)
1.3.1 (2022-02-02)
Bug fixes
- Google Workspace Atom feed failed #11
1.3.0 (2022-01-24)
Features / Enhancements
- Update README with link to the Grafana Marketplace (#8)
- Rebuild using 8.3.4 (#6)
1.2.0 (2022-01-11)
Features / Enhancements
- Signed as Community datasource plugin (#7).
1.1.0 (2021-12-27)
Features / Enhancements
- Extract <img src="X"> from the <figure> (#5)
- Extract Guid's text from the <guid> (#5)
- Update dashboards layout
1.0.0 (2021-12-26)
Features / Enhancements
- Supports RSS 2.0 and Atom.
- Works great with Dynamic Text panel by Marcus Olsson (marcusolsson-dynamictext-panel).
- Initial release based on the Volkov Labs Abc Data source template.