Skip to main content

Migrate plugins from Grafana version 9.x to 10.x

Follow these instructions to migrate plugins from Grafana version 9.x to 10.x.

Verify plugin behavior with React 18

Grafana 10 includes our upgrade to React 18 and use of the new React client-side rendering API. These changes were delivered to the core grafana repo with PR 64428.

Although these updates bring many significant benefits, there's a potential for them to impact the way that your plugin works. In particular, there could be unintended side effects caused by the changes around improving consistency with useEffect timings and automatic batching of state updates.

Recommended actions:

Data frame field values are now just arrays

In Grafana 10, the values in data frames are now managed as simple JavaScript arrays (see PR #66480). It is no longer necessary to wrap values in a Vector<T> implementation.c

Most code targeting 9.x will continue to work without any issues. An exception is the rare case in which existing code directly implements Vector<T> rather than extending or using base classes. In this case, the code should either return an array or extend FunctionalVector<T>. All Vector implementations have been deprecated and will be removed in the future.

When writing plugins that should run on 9.x, continue to use the Vector interfaces. In this case, when targeting versions 10+, you can now use simple arrays rather than wrapper classes.

To make this transition seamless, we employed the Original JavaScript Sin™. That is, we extended the native Array prototype with several Vector methods. We will atone and undo this in v11, when Vector interfaces and classes are removed.