The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
grafana/contribute/backend/upgrade-dependencies.md

1.1 KiB

Upgrade dependencies

We recommend the practices in this documentation when upgrading the various backend dependencies of Grafana.

Protocol buffers (protobufs)

Use the most recent stable version of the protobuf library in Grafana and the plugin SDK.

Additionally, you typically want to upgrade your protobuf compiler toolchain and re-compile the protobuf files.

Note: You need Buf CLI installed and available in your path. For instructions, refer to the Buf Docs documentation.

After you've installed Buf CLI, re-compile the protobuf files in Grafana and the plugin SDK. Use this code:

cd $GRAFANA
make protobuf
cd $GRAFANA_PLUGIN_SDK_GO
mage protobuf

After upgrading the protobuf dependency in Grafana and the plugin SDK, it is a best practice to test that your code still works before creating your PR. Specifically:

  • Test a plugin built with upgraded SDK on upgraded Grafana
  • Test a plugin built with non-upgraded SDK on upgraded Grafana
  • Test a plugin built with upgraded SDK on non-upgraded Grafana