Plugins 〉Calendar
Calendar
Calendar panel for Grafana
Introduction
Calendar Panel is a Grafana plugin that displays events from various data sources.
Requirements
- Calendar Panel 2.X requires Grafana 9.2 or Grafana 10.
- Calendar Panel 1.X requires Grafana 8.5 or Grafana 9.
You can install the Calendar Panel plugin from the Grafana Plugins catalog or using the Grafana command line tool.
For the latter, please use the following command:
grafana-cli plugins install marcusolsson-calendar-panel
Highlights
- Displays events in a monthly, weekly, or daily view.
- Query calendar events from any data source.
- Supports the filtration of events by a time range.
- Supports the event coloring based on thresholds.
- Enables the opening of a data link instead of a sidebar when clicking an event.
- Enables the display of annotations across all dashboards for the specified time period.
- Supports Internationalization: Spanish, French, German, and Chinese
Documentation
Section | Description |
---|---|
Events | Explains how to set up a calendar to display events. |
Features | Explains the plugin's features. |
Release Notes | Stay up to date with the latest features and updates. |
Tutorial
This video outlines all the new features we implemented and explains how to configure events.
Feedback
We're looking forward to hearing from you. You can use different ways to get in touch with us.
- Ask a question, request a new feature, or report an issue at GitHub issues.
- Subscribe to our YouTube Channel and leave your comments.
- Sponsor our open-source plugins for Grafana at GitHub Sponsor.
- Support our project by starring the repository.
License
Apache License Version 2.0, see LICENSE.
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
- 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 Calendar 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 Panel
Use the grafana-cli tool to install Calendar 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. Add the Panel to a Dashboard
Installed panels are available immediately in the Dashboards section in your Grafana main menu, and can be added like any other core panel in Grafana.
To see a list of installed panels, click the Plugins item in the main menu. Both core panels and installed panels will appear.
Changelog
2.4.0 (2024-03-07)
Features / Enhancements
- Updated Big Calendar to 1.10.3 (#150)
- Added ability to select date format (#151)
- Updated ESLint configuration and refactoring (#152)
- Updated dependencies and Actions (#154)
- Added hiding end time (#155)
Bugfixes
- Fixed keeping calendar dates if no time range change (#156)
2.3.1 (2023-11-06)
Bugfixes
- Fix import order for default big-calendar styles and their overrides (#143)
2.3.0 (2023-11-01)
Features / Enhancements
- Add yearly view (#134)
- Add internationalization(Spanish, French, German, and Chinese) i18n (#135, #138)
- Add default view option (#137)
- Add scroll to Time option for BigCalendar (#140, #141)
2.2.0 (2023-10-06)
Features / Enhancements
- Add Event Location for Big Calendar (#127)
- Add contrast text color for events (#129)
- Update to Grafana 10.1.4 (#132)
- Update to Plugin Tools 2.0.2 (#132)
- Use Grafana Access Policy to sign plugin (#132)
- Add support of dashboard timezone in Start and End time (#128)
- Add ability to select views: day, week, work week and month (#133)
2.1.0 (2023-08-14)
Features / Enhancements
- Add Annotations type and limit (#121)
- Update to Grafana 10.0.3 (#122)
- Add Big Calendar Language Messages (#123)
2.0.1 (2023-08-03)
Bugfixes
- Fix display annotations options (#119)
2.0.0 (2023-07-28)
Breaking changes
- Requires Grafana 9.2 and Grafana 10
Features / Enhancements
- Increase tests coverage (#105)
- Add Big Calendar component for rendering calendar (#106)
- Update ESLint configuration (#106)
- Remove Grafana 8.5 support (#110)
- Update to Grafana 10.0 (#110)
- Update events overlap when the start date equals the end date in Big Calendar (#112)
- Add quick links for Big Calendar (#113)
- Update back/next button for weekly and daily views in Big Calendar (#114)
- Update button styles for Big Calendar (#115)
- Update calendar resizing for Big Calendar (#116)
1.4.0 (2023-06-10)
Features / Enhancements
- Rebuild using Grafana 9.5.2 (#96, #101)
- Add Text Formatting, Mappings and Overrides (#97)
- Remove unused Standard Options (#97)
- Increase Test Coverage and update testing library (#100, #103)
- Migrate to Plugin Tools 1.5.2 (#101)
- Update to Node 18 (#101)
- Add E2E Cypress testing (#102)
Bug fixes
- Increase event spacing to prevent overflow (#96)
1.3.0 (2023-03-08)
Features / Enhancements
- Rebuild using Grafana 9.4.3 (#87)
- Add labels split to display in the drawer (#88)
- Add annotation tags as labels (#88)
- Refactor multi-day interval (#89)
- Add display colors based on Event or Frame id if the Color field is not specified (#90)
- Add support for Color schemes (#91)
- Add video configuration tutorial (#92)
Bug fixes
- Fix scrollable content in the Day drawer (#93)
1.2.0 (2023-02-23)
Breaking changes
Refactoring and Styles migration may introduce breaking changes. Please test before upgrading in Production.
Features / Enhancements
- Select color for calender entry queries (#67)
- Filtering out undefined events (#69)
- Update CI and Release Workflows (#72)
- Rebuild using Grafana 9.3.6 (#73)
- Refactor Options Editors to use Field pickers (#74)
- Refactor Day and Events Drawer (#75)
- Set No Padding for the Panel (#75)
- Refactor Day and update Styles (#76)
- Migrate Styles to v2 (#79)
- Match Grafana settings for Week Start (#80)
- Skip undefined events in Drawer (#81)
- Add Display Time (#82)
- Update Styles and Screenshot (#83)
1.1.0 (2022-12-12)
Breaking changes
Refactoring may introduce breaking changes. Please test before upgrading in Production.
Features / Enhancements
- Update Panel options in README (#53)
- Add Youtube tutorial for Calendar with JSON API data source (#54)
- Update CI to Node 16 and Synchronize with Release workflow (#56)
- Update to Grafana 9.2.2 (#57)
- Code Refactoring (#58)
- Update to Grafana 9.3.1 (#59)
- Update CI to upload signed artifacts (#60)
- Refactor panel options and increase test coverage (#61)
- Add annotation support (#8)
- Refactoring and Removing legacy code (#62)
- Refactor Panel Options and add Annotations options (#63)
1.0.0 (2022-10-02)
Features / Enhancements
- Maintained by Volkov Labs (#51)
- Updated based on Volkov Labs Panel Template (#51)
- Update to Grafana 9.1.6 (#52)
0.7.1 (2022-08-28)
Features / Enhancements
- Update to Grafana 9
0.7.0 (2022-03-09)
Features / Enhancements
- Quick links: Enable quick links to follow the data link when you click the event rather than opening a modal.
- Update to Grafana 8.4.3
0.6.0 (2022-01-28)
Breaking changes
This release bumps the minimum required Grafana to >=8.0. Grafana 8 introduces a new theming engine for panel plugins.
- If you're running a Grafana version before 8.0, you should stay with v0.5.0.
- If you're running Grafana 8.0 or above, you should update to v0.6.0.
0.5.0 (2021-09-06)
Features / Enhancements
- Data links support (#25)
- New details view: Instead of relying on tooltips, this version uses an inline drawer to display additional details. I like this better, but the built-in drawer component has some limitations. I'm not sure I like that it's a modal for example. I might end up creating a custom sidebar component. Let me know what you think about the new design!
0.4.3 (2021-06-12)
Features / Enhancements
- Change "Apply time interval" to "Apply time range" to match Grafana
- Increase contrast for single-day events
0.4.2 (2021-05-22)
Bug fixes
- classicColors is (still) undefined (#16)
0.4.1 (2021-05-21)
Bug fixes
- classicColors is undefined (#16)
- Improve legibility of event text (#15)
0.4.0 (2021-05-20)
Features / Enhancements
- Show event name if event starts in day out of filter (#13)
- More calendars and colors (#14)
- Line breaks in event description (#11)
0.3.0 (2021-05-18)
Features / Enhancements
- Show more details for individual events (#10)
0.2.0 (2021-05-09)
Features / Enhancements
- Multi-day events (#1)
- Display truncated events (#6)
- Allow string and number fields for time dimensions
0.1.1 (2021-02-10)
No changes.
0.1.0 (2021-02-10)
Initial release. Not fit for production.