Require alert.notifications:write permissions to test receivers and templates (#865)
(cherry picked from commit 3c21ab70075256d4ba8e4fbfdcb15f5a394161fa)
CI: Run `trigger-test-release` only on PRs against main (#68794)
Run trigger-test-release only on PRs against main
(cherry picked from commit 623c014cda)
# Conflicts:
# .drone.yml
Auth: Remove the session cookie only if it's invalid or revoked (#65984)
Remove the cookie if it's invalid or revoked
(cherry picked from commit 4cac95d1c2)
Docker images: Don't fail if a PR comes from a fork (#68765)
* Update grabpl
* Allow publish images to fail for PRs
(cherry picked from commit 04e2d9055d)
# Conflicts:
# .drone.yml
Clarify Graphite version and type to set if using Grafana Cloud (#68239)
* Clarify Graphite version and type to set if using Grafana Cloud
* Update _index.md
(cherry picked from commit 9f7f82c3cc)
Co-authored-by: Fiona Liao <fiona.y.liao@gmail.com>
CI: Add `.drone.yml` in pathschanged trigger for `lint_backend` pipeline (#68348)
Add .drone.yml in pathschanged for lint_backend
(cherry picked from commit b7b13067a5)
# Conflicts:
# .drone.yml
Remove windows backend tests from release pipelines
These are run in other places so there is no benefit to also include
them here.
(cherry picked from commit 1e8cad625b)
Backport of https://github.com/grafana/grafana/pull/68166
* CI: Add Windows backend tests in more places
* CI: Add promotion pipeline for publishing new windows-test-images
* CI: Ignore windows backend-test failures for now
* CI: Fix linting issue in ci_images.star file
(cherry picked from commit b2fc285a5d)
Backport of https://github.com/grafana/grafana/pull/66438
docs: Updates installation instruction for Debian/Ubuntu (#64232)
* draft changes
* Apply suggestions from code review
Co-authored-by: Dan Cech <dcech@grafana.com>
* reworks debian/ubuntu instructions, updates start server topic
* Apply suggestions from code review
Co-authored-by: Dan Cech <dcech@grafana.com>
* incorporates feedback; restructures to align with writers toolkit guidelines
* Apply suggestions from code review
Co-authored-by: Dan Cech <dcech@grafana.com>
* tweaks structure of server topic; renames directory, corrects relrefs
* corrects spelling
* Apply suggestions from code review
Co-authored-by: Dan Cech <dcech@grafana.com>
* removed web parameter
* removes unnecessary word
* incorporates feedback from internal reviewer
* updates alias
* updates alias
* adjust alias
---------
Co-authored-by: Dan Cech <dcech@grafana.com>
(cherry picked from commit 13af5afaf3)
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
docs: add semi relative time ranges (#67559)
* add semi-relative time range section
* added second example and reworded
* formatting fixes
* added alerting note and fixed formatting
* wording fix
(cherry picked from commit 0271a1d094)
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
Update index.md (#67172)
Clarified some of the intro text and added JSON outer element to make the samples clearer
(cherry picked from commit 66ad704292)
Co-authored-by: Nabeel Saad <saadnabs@hotmail.com>
docs: move misplaced Configure legend page (#67597)
* move configure legend page and add alias
* updated page weight and tried fixing alias
* fixed alias
* add preemptive alias for current page location
* apply suggestion from review
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* apply suggestions from review
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* apply suggestions from review
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
---------
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
(cherry picked from commit 688459f25c)
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
docs: move misplaced Configure legend page (#67597)
* move configure legend page and add alias
* updated page weight and tried fixing alias
* fixed alias
* add preemptive alias for current page location
* apply suggestion from review
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* apply suggestions from review
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* apply suggestions from review
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
---------
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
(cherry picked from commit 688459f25c)
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
Grafana Cloud: Put cloud artifacts to `*/release` dir (#66168)
Put cloud artifacts to */release dir
(cherry picked from commit a2634495e5)
Co-authored-by: Dimitris Sotirakis <dimitrios.sotirakis@grafana.com>
Influxdb: Handle legacy Influxdb influxql annotations with target in migration (#63225)
* handle legacy influxdb annotations with target in migration
* add types
* don't check tags that are empty strings and give annotation a type
(cherry picked from commit 7a3f7e26ce)
Co-authored-by: Brendan O'Handley <brendan.ohandley@grafana.com>
Docs: Fix broken links to section on Variable syntax page (#67340)
These links have a trailing slash which don't work when linking to a
specific element.
(cherry picked from commit 278a8fccc9)
Co-authored-by: Eric Wang <2069450+ericdwang@users.noreply.github.com>
* Alerting: Update migration to put alerts to the default folder if dashboard folder is missing (#65577)
* extract function
* use context logger
* put alert to general folder if folder is missing
* move folderHelper init
* add test
* Update pkg/services/sqlstore/migrations/ualert/ualert.go
Co-authored-by: Matthew Jacobson <matthew.jacobson@grafana.com>
---------
Co-authored-by: Matthew Jacobson <matthew.jacobson@grafana.com>
(cherry picked from commit 7b2f44762e)
* rename ID to Id and dashboards.Dashboard to models.Dashboard
---------
Co-authored-by: Yuri Tseretyan <yuriy.tseretyan@grafana.com>
* CI: Split subcommand (#66005)
* Update e2e package
- Ensure health request is monitored for addDatasource flow
- Add custom timeout to configurePanel flow
(cherry picked from commit 155fcae4aa)
* Make health check optional
(cherry picked from commit 91f66d61e1)
---------
Co-authored-by: Andreas Christou <andreas.christou@grafana.com>
* Fix reference to Grafana CLI
- Make relref for relative permalink
- Use relative path for unambiguous resolution
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
(cherry picked from commit 58edeeaba6)
* Remove reference to non-existent shared page
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
(cherry picked from commit 89af5b60f2)
* Fix reference to Grafana Cloud
- Make relref for relative permalink
- Use absolute resolution
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Fix reference to Alertmanager page
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Docs: Added note to contact Support (#65235)
* Added note to contact Support
* Update docs/sources/setup-grafana/configure-security/configure-authentication/enhanced-ldap/index.md
* Update docs/sources/setup-grafana/configure-security/configure-authentication/enhanced-ldap/index.md
* makes prettier
* Apply suggestions from code review
---------
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
(cherry picked from commit 445734888b)
Co-authored-by: melGL <81323402+melgl@users.noreply.github.com>
Build: Add CloudMode to build versions (#65651)
* Add CloudMode to build versions
* Use linux-amd64 variant without musl for cloud mode
* Add cloud mode to version folder on package upload
* Use musl variant for CloudMode
* Only sign rpm packages if there's any to sign
* Remove trailing whitespace
(cherry picked from commit 8f282b8a6e)
Co-authored-by: Guilherme Caulada <guilherme.caulada@grafana.com>
update enhanced-ldap (#65687)
* update enhanced-ldap
documenting a potential issue with ldap active sync, when search filter and username attributes do not match.
* Update docs/sources/setup-grafana/configure-security/configure-authentication/enhanced-ldap/index.md
* formats example
* Update docs/sources/setup-grafana/configure-security/configure-authentication/enhanced-ldap/index.md
---------
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
(cherry picked from commit 99ac39f0d2)
Co-authored-by: annelaurefroment <49911675+annelaurefroment@users.noreply.github.com>
Alerting: Fix integration test for creating silences (#65722)
* fix integration test for creating silences
to create correct silence with endsAt in the future
* Update api_alertmanager_test.go
(cherry picked from commit ed8628e39d)
Co-authored-by: Yuri Tseretyan <yuriy.tseretyan@grafana.com>
Remove redundant content or delete this page entirely (#65446)
* Remove redundant content or delete this page entirely
The top of the page has redundant content pitching Grafana Cloud.
"You can also configure the MS SQL Server data source on a Grafana Cloud instance without having to host Grafana yourself." Which is directly under the highlighted area explaining the same thing. The same content is floating in the right side of all the pages as well.
Removed "> **Note:** You must install Grafana 5.1+ in order to use the integrated MS SQL data source."
Wait, why does this page exist if the data source page has the relevant updated content? https://grafana.com/docs/grafana/latest/datasources/mssql/
* makes prettier
---------
Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
(cherry picked from commit 2b73f8cfd5)
Co-authored-by: mallettjared <110853992+mallettjared@users.noreply.github.com>
CI: Allow overwriting of existing GitHub release assets (#65127)
* CI: Allow overwriting of existing GitHub release assets
This closes#63698
* Use c for *cli.Context in publishgithub.go
(cherry picked from commit 4ab3bd6f7e)
Co-authored-by: Horst Gutmann <horst.gutmann@grafana.com>
* Improve showing nextEvaluationDate for rules
Co-Authored-By: Konrad Lalik <konradlalik@gmail.com>
* Improve imports and comments
---------
Co-authored-by: Konrad Lalik <konradlalik@gmail.com>
(cherry picked from commit b90aed4fd7)
Docs/updates amazon cloudwatch (#64987)
* updated AWS to Amazon in the index file
* edited query editor index file -AWS with Amazon
(cherry picked from commit 0975e53fc0)
Co-authored-by: lwandz13 <126723338+lwandz13@users.noreply.github.com>
Table Panel: Fix image of image cell overflowing table cell when a data link is added. (#59392)
* TablePanel: fix image of image cell overflowing table cell when a data link is added
* Fix image cell and gauge panel in respective places instead
(cherry picked from commit 004705a10b)
Co-authored-by: Oscar Kilhed <oscar.kilhed@grafana.com>
Alerting: Fix queries not being previewed in detail view (#64198)
(cherry picked from commit 4e81aab60a)
Co-authored-by: Gilles De Mey <gilles.de.mey@gmail.com>
Alerting: QoL improvements to the unified alerting multi-replica devenv (#64907)
(cherry picked from commit 406431df4e)
Co-authored-by: gotjosh <josue.abreu@gmail.com>
Alerting: Update scheduler to get updates only from database (#64635)
* stop using the scheduler's Update and Delete methods all communication must be via the database
* update scheduler's registry to calculate diff before re-setting the cache
* update fetcher to return the diff generated by registry
* update processTick to update rule eval routine if the rule was updated and it is not going to be evaluated at this tick.
* remove references to the scheduler from api package
* remove unused methods in the scheduler
(cherry picked from commit 85a954cd81)
# Conflicts:
# pkg/services/ngalert/api/api_ruler.go
# pkg/services/ngalert/ngalert.go
# pkg/services/ngalert/ngalert_test.go
# pkg/services/ngalert/schedule/schedule.go
# pkg/services/ngalert/schedule/schedule_mock.go
# pkg/services/ngalert/schedule/schedule_unit_test.go
* Display last & next rule eval date plus eval duration
* Show next evaluation date in a humanized format
Full date still visible on hover
* Only show next evaluation column is group has an interval
(cherry picked from commit 6b95b3f8aa)
CI: Add `PrereleaseBucket` field in `versions.go` (#64519)
Add PrereleaseBucket in versions.go
(cherry picked from commit 29b3f3fbf4)
Co-authored-by: Dimitris Sotirakis <dimitrios.sotirakis@grafana.com>
* Alerting: Update Prometheus Alertmanager
* Move to TruncateInRunes
* Use updated FromGlobs signature
* Avoid indirection around InhibitRule based on 61810
* Work around new API for nflog
* One more template FromGlobs api change
* One more FromGlobs change in test files. Searched for them all...
* Missing line from cherrypicked change
* Run maintenance on correct state object
---------
Co-authored-by: Alex Weaver <weaver.alex.d@gmail.com>
Docker Build: Use `tonistiigi/binfmt` image for cross compilation (#64108)
* Change docker image used for cross-compilation
* Replace fmt.Println with log.Println
* Add specific tag for docker image
(cherry picked from commit b42fd92fad)
Co-authored-by: Dimitris Sotirakis <dimitrios.sotirakis@grafana.com>
TimeSeries: Fix legend and tooltip colors changing after data refreshes (#63823)
(cherry picked from commit b2c0175777)
Co-authored-by: Leon Sorokin <leeoniya@gmail.com>
NPM: Stop using the folder path before the name path (#63851)
Stop using the folder path before the name path
(cherry picked from commit 177aa254c5)
Co-authored-by: Dimitris Sotirakis <dimitrios.sotirakis@grafana.com>
Docs: Update default value for geomaps enable_custom_baselayers option (#61880)
Docs: Update default value for geomaps disable_custom_baselayers option
The `disable_custom_baselayers` configuration option name and default
value were inverted in commit e604e69d93,
but the update to the description in the documentation was missed.
(cherry picked from commit 22f51602ba)
Co-authored-by: zsrv <95176387+zsrv@users.noreply.github.com>
MSSQL Datasource: Revert functions within macros change (#63592)
* Revert functions within macros change
* Add tests for function and macro for mssql
* Remove macro support tests
---------
Co-authored-by: Oscar Kilhed <oscar.kilhed@grafana.com>
(cherry picked from commit 356e2e1933)
Co-authored-by: Kyle Cunningham <codeincarnate@users.noreply.github.com>
Alerting: Fix incorrect comment in eval.go (#63510)
This commit fixes an incorrect comment in the Result struct in eval.go
that I had written some time ago. The comment now documents the
actual behaviour and content of this field.
(cherry picked from commit f93a9c794d)
Co-authored-by: George Robinson <george.robinson@grafana.com>
Alerting: Fix a bug taking screenshots with Dashboard UID (#63220)
This commit fixes a bug where Grafana would fail to take a screenshot if
the same Dashboard UID was present across two or more different orgs.
(cherry picked from commit 1f984409a2)
Annotations: Fix EpochEnd being zero for Alert-generated annotations (#60931)
* Revert linter suggestion
* Re-add nolint
* Work in terms of pointer rather than copy
* Add tests covering validation
* Add comment
(cherry picked from commit 1381fb6dfc)
Co-authored-by: Alexander Weaver <weaver.alex.d@gmail.com>
* Alerting: Fix template validation in provisioning api (#62530)
* Alerting: Fix template validation in provisioning api
Fix issue where provisioning API accepts a malformed template having extra
text outside of definition block and template name matching definition name.
(cherry picked from commit f9ec16e74f)
---------
Co-authored-by: Matthew Jacobson <matthew.jacobson@grafana.com>
Update publishing workflows to use organization secret (#63001)
The new tokens are managed centrally and have a longer expiry.
Administrators of the grafanabot account will be
notified of the pending expiry and the secret can be rotated centrally
without the need for a repository administrator to update their
secrets.
The existing repository secrets can safely be removed. The tokens for
those secrets will be removed by the end of this week.
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
(cherry picked from commit ba9bdf3455)
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Add canonical URL to all HTTP API docs (#62957)
Facilitates mounting these docs in the Grafana Cloud documentation set
without affecting SEO.
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
(cherry picked from commit 4037e5e325)
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
docs: fix broken annotations link (#62834)
* docs: fix broken annotations link
Link to annotations section is broken because the section was never added. A placeholder for it was removed on this commit, but the link wasn't. This seems like the best place to point to.
* fix relref formatting
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
* removed TODOs from tables
* prettier linting
---------
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
(cherry picked from commit 09943407e4)
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
Fix: Save and test error message does not persist across datasource instance settings anymore
(cherry picked from commit ce50168b70)
Co-authored-by: Timur Olzhabayev <timur.olzhabayev@grafana.com>
* Server: Switch from separate server & cli to a unified grafana binary (#58286)
* avoid the need for a second bulky binary for grafana-cli
* look for grafana-server in $PATH as well as same directory
* implement unified "grafana" command
* update dockerfiles, fix grafana-cli -v
* update packaging to work with single binary
- add wrapper scripts for grafana and grafana-server
- update and sync package files
- implement --sign flag of build package command
- stop packaging scripts folder, they are not useful for end users
- add support for --configOverrides in server command
- remove unused nfpm.yaml config file
* windows support
(cherry picked from commit de99ce139c)
* Build: don't remove grafana-server and grafana-cli binaries from deb and rpm packages (#59890)
* don't remove grafana-server and grafana-cli binaries from /usr/share/grafana/bin in deb and rpm packages
* don't add config overrides in /usr/sbin/grafana-server
---------
Co-authored-by: Dan Cech <dcech@grafana.com>
Expressions: Fixes the issue showing expressions editor (#62510)
* Use suggested value for uid
* update the snapshot
* use __expr__
* replace all -100 with __expr__
* update snapshot
* more changes
* revert redundant change
* Use expr.DatasourceUID where it's possible
* generate files
(cherry picked from commit 91221bc436)
Time Series Panel: Fix legend text selection in Firefox (#60809)
Add user-select property to legend items.
(cherry picked from commit 38d7168921)
Co-authored-by: Kyle Cunningham <codeincarnate@users.noreply.github.com>
Auth: Fix catch both both ErrInvalidAPIKey for context with APIKey (#62193)
* fix: capture both ErrInvalidAPIKey
* rename of variable
(cherry picked from commit c5cb5be3cc)
Co-authored-by: Eric Leijonmarck <eric.leijonmarck@gmail.com>
docs: clarify note re export dashboard as PDF (#62398)
clarify note re export dashboard as PDF
Update note under Export dashboard as PDF to indicate that it's only available on Enterprise and Cloud, as well as which version of Enterprise it's available on.
(cherry picked from commit 290f23a50b)
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
Move Grafana tutorials from grafana/tutorials repository (#62309)
* Add Grafana tutorials originally from tutorials repository
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Replace tutorials/step shortcode with ordinary headings
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Fix typos reported by codespell
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Fix doc-validator linting and run prettier
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Specify version in tutorials lookup as non-rendered pages do not have a relative permalink used to infer the version
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Use latest version
Ensures CI passes and only breaks one website build as the backport to
v9.3.x will solve the missing "latest" pages on publishing.
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
(cherry picked from commit 4563111180)
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
StateTimeline: Show correct legend label when value mappings set (#62282)
* StateTimeline: Show correct legend label when value mappings set
* Add test dashboard for thresholds and value mappings
* run stripnulls.sh
(cherry picked from commit 846acd28ff)
Co-authored-by: Victor Marin <36818606+mdvictor@users.noreply.github.com>
Encryption: Cache new DEKs (only) after a caution period (#60664)
* Encryption: Cache new DEKs (only) after commit
* Fix typo
* Update secrets manager tests with new failing case
* Update secrets manager tests with new clarifications (comments)
* Correct broken method calls
* Unify methods
* Cache data keys only after a caution period
* Caution period for data keys caching only for encrypt ops
(cherry picked from commit c4e067d49d)
Co-authored-by: Joan López de la Franca Beltran <5459617+joanlopez@users.noreply.github.com>
Oauth: Remove extra decoding of redirect url (#60875)
Oauth: remove extra decoding of redirect cookie url
(cherry picked from commit 5b4e1ee6fc)
Co-authored-by: Karl Persson <kalle.persson@grafana.com>
Explore: Be sure time range key bindings are mounted after clear (#61892)
* Add list of bindings for updating on change
* Revert "Add list of bindings for updating on change"
This reverts commit 092707371d.
* Clear keybindings before component render
(cherry picked from commit 6ab79c4fba)
Co-authored-by: Kristina <kristina.durivage@grafana.com>
Datasources: Fix Proxy by UID Failing for UIDs with a Hyphen (#61723)
Fix Proxy by UID Failing for UIDs with a Hyphen
Hyphens are allowed in short IDs but not picked up by the
proxyPathRegexp. This caused the end of the uid to be proxied as part of
the path to the backing datasource which would usually cause a 404.
(cherry picked from commit f85d072c17)
Co-authored-by: Chris Marchbanks <csmarchbanks@gmail.com>
Docs: Update index.md to not escape dollar sign (#61694)
Update index.md to not escape dollar sign
the backslash is useful in json files, but not where most users will see it
(cherry picked from commit 3146740d82)
Co-authored-by: jeremybanzhaf <88380596+jeremybanzhaf@users.noreply.github.com>
Elasticsearch: Fix failing requests when using SigV4 (#61923)
fix setting of `es` servicename
(cherry picked from commit c5610450b2)
Co-authored-by: Sven Grossmann <sven.grossmann@grafana.com>
Query Builder: Fix max width of input component to prevent overflows (#61798)
* fix(auto-size-input): return maxWidth when realWidth exceeds limit
* fix(query-builder): sex madWidth for simple editor component
* fix(auto-size-input): add unit test
(cherry picked from commit 87f8e7e223)
Co-authored-by: Matias Chomicki <matyax@gmail.com>
grafana/e2e: Add ability to customise scenario config (#60646)
* Add ability to retry e2e test scenarios
* Add wait and remove retries
* Revert retry logic and elaborate on 15s wait time
* No need to update datasource name now
(cherry picked from commit c34aa05548)
Co-authored-by: Andreas Christou <andreas.christou@grafana.com>
Docs: rewrite data source intro (#61639)
* Docs: rewrite data source intro
- Include more than just "databases", which was overly narrow
- Try to make doc a "TL;DR" of the essential information
* docs, link data source to build plugin task
* Reduce jargon and sentence length
* Link out to different features
* Data source, docs turn examples into list
And trim language
* Better phrasing to introduce query editor
Old way implied that Grafana provides all query editors,
which isn't true of custom plugins.
* use relref for in-repo anchor
* remove double "in"
Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
* Simplify list
Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
* Restructure intro, clarify plugins and their URLs
* Add and configure
It's sometimes both.
* Apply suggestions from code review
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
* makes prettier
Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
(cherry picked from commit fb6df56464)
Co-authored-by: Matt Dodson <47385188+MattDodsonEnglish@users.noreply.github.com>
Docs: Use the correct name for the feedback_links_enabled option (#61825)
Also updates the description to be more in line with the style conventions.
(cherry picked from commit d0cf7ff8e9)
Co-authored-by: zsrv <95176387+zsrv@users.noreply.github.com>
Update _index.md (#61662)
* Update _index.md
The troubleshooting page was missing how to send dashboard panels for debugging so added it here.
* Update docs/sources/troubleshooting/_index.md
* Update docs/sources/troubleshooting/_index.md
* removed empty lines
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
(cherry picked from commit 6c6c0f5402)
Co-authored-by: Usman Ahmad <69509548+usmangt@users.noreply.github.com>
Plugins: enable the plugin sdk to get the json data for all datasources (#61729)
(cherry picked from commit 3b718a3e8f)
Co-authored-by: Stephanie Hingtgen <stephanie.hingtgen@grafana.com>
Logs: Lines with long words do not break properly (#61707)
really break anywhere
(cherry picked from commit fd70f6034f)
Co-authored-by: Sven Grossmann <sven.grossmann@grafana.com>
Elasticsearch: Fix toggle-settings are not shown correctly (#61751)
* changed `checked` propery to `value`
* revert changing the prop in the event
(cherry picked from commit dd8f95a201)
Co-authored-by: Sven Grossmann <sven.grossmann@grafana.com>
Loki: Use queries `maxLines` if configured, even if it is zero (#61652)
* user `query.maxLines` even if it is zero
* remove unnecessary comment
(cherry picked from commit 6c566a391d)
Dashboard: Making a dashboard editable does not allow resizing of panels (#59255)
* DashboardGrid should rerender ReactGridLayout when mutable dashboard updates
* add missing prop to test
(cherry picked from commit db1e19fe86)
Co-authored-by: Polina Boneva <13227501+polibb@users.noreply.github.com>
Alerting: Fix group select not being filled by selected folder when creating alert from panel (#61577)
Add fetchRulerRulesIfNotFetchedYet fetching when results are an empty object
(cherry picked from commit 04b5e6ed9e)
Co-authored-by: Sonia Aguilar <33540275+soniaAguilarPeiron@users.noreply.github.com>
Add object_matchers example (#61235)
* Add object_matchers example
* Use better terminology
(cherry picked from commit 3db08d4e36)
Co-authored-by: Alex Moreno <alexander.moreno@grafana.com>
Auth: Fix correct error for updateapikey in context handler (#61544)
* fix: correct error for updateapikey
* refactor: send the correct err forward
* update: based on review
(cherry picked from commit 07bbc0716c)
Co-authored-by: Eric Leijonmarck <eric.leijonmarck@gmail.com>
* Alerting: Set error annotation on EvaluationError regardless of underlying error type (#61506)
Set error annotation regardless of underlying error type
(cherry picked from commit b289b8ac6e)
* Also cherrypick the nilcheck that got added prior to 9.4
Live: Fix `Subscription to the channel already exists` live streaming error (#61406)
#60570: Fix `subscription to the channel already exists`
(cherry picked from commit 23dbc916e8)
Co-authored-by: Artur Wierzbicki <artur.wierzbicki@grafana.com>
Levitate: Only run against the main branch (#61401)
chore: only run Levitate against the main branch
(cherry picked from commit b8aaf85fdc)
Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com>
* Explore: Unsync time ranges when a pane is closed (#61369)
* Explore: Unsync time ranges when a pane is closed
* remove unintentional import
(cherry picked from commit 1e33e56dbd)
* remove unneeded property
Bugfix: Prevent previous query editor to set default values when changing data source (#60218)
* Fixed issue where the query editor of the previous ds sets default values on query passed to the query editor of the next ds.
* Fixed issue with changing data source for query in Alerting.
* Will apply default values from DS if available.
* Fix failing tests.
* fixed spell error.
* reverted getDefaultQuery call so it can be added in a separate PR.
(cherry picked from commit b633d5395d)
Co-authored-by: Marcus Andersson <marcus.andersson@grafana.com>
Log volume: Fix functionality if query has multiple comments (#61306)
* Log volume: Fix functionality if query has comments
* Add additional test
(cherry picked from commit 8bda8b8272)
Co-authored-by: Ivana Huckova <30407135+ivanahuckova@users.noreply.github.com>
TimeSeries: Fix y-axis Yes/No and On/Off boolean units (#61207)
(cherry picked from commit a1609230f8)
Co-authored-by: Leon Sorokin <leeoniya@gmail.com>
Alerting: Fix conversion of alert state from db state during manager warmup (#60933)
(cherry picked from commit 4d989860fb)
Co-authored-by: Yuri Tseretyan <yuriy.tseretyan@grafana.com>
Plugins: add option to proxy ds connections through a secure socks proxy (#59254)
* Plugins: add feature to proxy data source connections
(cherry picked from commit 6805c951e9)
Remove packages path from branch filter (#60128)
That directory is no longer used in published docs and causes this
workflow to fail when changes only affect the packages directory.
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
(cherry picked from commit 1516aa2762)
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Prometheus: Code editor - upgrade /series API endpoints to use label/values and /labels for supported prometheus clients (#59576)
* Allow prometheus code editor API to use new prometheus API calls for supported data source clients.
Co-authored-by: Ryan McKinley <ryantxu@gmail.com>
(cherry picked from commit 4ed0cc7d18)
Co-authored-by: Galen Kistler <109082771+gtk-grafana@users.noreply.github.com>
Plugins: Fix plugin query help markdown (#60485)
* refactor(pluginhelp): rewrite as functional component with useAsync
* mimic old behaviour
* feat(pluginhelp): display message if backend returned an empty string
Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com>
(cherry picked from commit 9aed364898)
Co-authored-by: Will Browne <wbrowne@users.noreply.github.com>
fix(cli): correct wire binding for reset-admin-password
The cli methods were updated to use the db.DB interface, but that interface was still wired in as the fake DB - it had only been used for tests previously. This isn't an issue in the main branch now that it's been collapsed into a single binary all using the same wire graph.
Fixes#59915
Alerting: Prevent uid collision in migration when db is case-insensitive (#60494)
* Alerting: Prevent short uid collision in legacy migration when db is case-insensitive
Two factors come into play that cause sporadic uid conflicts during legacy alert migration:
- MySQL and MySQL-compatible backends use case-insensitive collation.
- Our short uid generator is not a uniform RNG and generates uids in such a way that generations in quick succession have a higher probability of creating similar uids.
Normally we would be guaranteed unique short uid generation, however if the source alphabet contains
duplicate characters (for example, if we use case-insensitive comparison) this guarantee is void.
Generating even ~1000 uids in quick succession is nearly guaranteed to create a case-insensitive
duplicate.
(cherry picked from commit 570b62091c)
Co-authored-by: Matthew Jacobson <matthew.jacobson@grafana.com>
Prometheus: Fix Instant query time calculation (#60815)
* Use single point in time instead of doing time range calculation
* Comment update
(cherry picked from commit 15d32546ea)
* Alerting: Improve threshold displays (#60046)
(cherry picked from commit e9fe9baf66)
* TimeSeriesPanel: Allow threshold indicators without change handler (#60575)
(cherry picked from commit 16c6f223ba)
* update jest snapshots
it looks like snapshots are encoded differently on this branch
Elasticsearch: Fix adding of adhoc filters when jumping to explore (#60691)
* Elasticsearch: Fix adding of adhoc filters when jumping to explore
* Change NOT operator to - as it is preffered solution
(cherry picked from commit c289cd136c)
Co-authored-by: Ivana Huckova <30407135+ivanahuckova@users.noreply.github.com>
Logs: Fix height of logs component when used with topnav (#60669)
fix height for topNav
(cherry picked from commit 01c4783c0b)
Co-authored-by: Sven Grossmann <sven.grossmann@grafana.com>
AzureMonitor: Set Logs portal URL from resource URI (#60583)
Set URL based off of resource URI
(cherry picked from commit f3f043e097)
Co-authored-by: Andreas Christou <andreas.christou@grafana.com>
* Wait for locations call to complete
* Update drone to run cloud suite on tests update
(cherry picked from commit 0367036108)
# Conflicts:
# .drone.yml
# scripts/drone/steps/lib.star
AzureMonitor: Correctly set filter values in portal URL (#60627)
* Correctly set filter values in portal URL
* Refactor to include dimensions as a part of AzureMonitor query
* Correctly set splitting value in URL
- Add type for dimension filters object
* Update tests
* Don't test dimensions
(cherry picked from commit 2e4bc200f5)
Co-authored-by: Andreas Christou <andreas.christou@grafana.com>
ToolbarButtonRow: Overflow button now toggles visibility correctly (#60635)
* only close the overlay if we're interacting with something other than the overflow button/the overlay itself
* use a ref instead of a test id
(cherry picked from commit 44232569a8)
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
Plugins: Fix parsing of Azure settings for plugins (#60611)
Fix parsing of Azure settings for plugins
(cherry picked from commit 96b7fb15de)
Co-authored-by: Sergey Kostrukov <sekost@microsoft.com>
Removing hardcoded Cloud CTA in favor of a programmatic from website (#60179)
* Removing hardcoded Cloud CTA in favor of a programmatic from website
* makes prettier
Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
(cherry picked from commit 17696f8dec)
Co-authored-by: Nicholas Auger <nick@qkombur.com>
RBAC: Fix DeleteUserPermissions not being called on Upsert org sync (#60531)
* fix DeleteUserPermissions not being called on RemoveOrgUser
* do not error out of auth flow
* fix test missing service
(cherry picked from commit 77786f236a)
Co-authored-by: Jo <joao.guerreiro@grafana.com>
RelativeTimeRangePicker: Don't respond to submit event when nested in a form element (#60495)
(cherry picked from commit 68b044fb7c)
Co-authored-by: Gilles De Mey <gilles.de.mey@gmail.com>
Command Palette: Correctly clear button styles when changing theme (#60511)
add topnav feature toggle to new theme created when using 'c t'
(cherry picked from commit bc3d1fdd2a)
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
Prometheus: Fix X-Id-Token and X-ID-Token sent to Prometheus in query requests (#60342)
* Prometheus: Use Set rather than map assignment in sdkHeaderToHttpHeader
Fixes#59940
* Prometheus: Add TestPrometheusCanonicalHeaders
(cherry picked from commit 92c01e416e)
Co-authored-by: Giuseppe Guerra <giuseppe.guerra@grafana.com>
Prometheus: Updating editor value on Monaco's onDidChangeContent performance issues (#60191)
debounce slow function that is running on each keystroke
(cherry picked from commit f7bd85d7f4)
Co-authored-by: Galen Kistler <109082771+gtk-grafana@users.noreply.github.com>
Prometheus: Add POST support to client (#60243)
* Prometheus: Add POST support to client
* Prometheus: Revert client test change from 1c503908
(cherry picked from commit 055c3b7332)
Co-authored-by: Fionera <fionera@fionera.de>
Alerting: Set Dashboard and Panel IDs on rule group replacement (#60374)
* Set Dashboard and Panel IDs on rule group replacement
* fix comments and abbreviate test variable name
* Update pkg/services/ngalert/provisioning/alert_rules.go
Co-authored-by: Jean-Philippe Quéméner <JohnnyQQQQ@users.noreply.github.com>
Co-authored-by: Jean-Philippe Quéméner <JohnnyQQQQ@users.noreply.github.com>
(cherry picked from commit 174c61b949)
Co-authored-by: Alex Moreno <alexander.moreno@grafana.com>
Transformations: Fix bug in convert fields boolean to number (#60277)
* fix bug in convert fields boolean to number
* check for string outside of loop
(cherry picked from commit 286af5a53b)
Co-authored-by: Brendan O'Handley <brendan.ohandley@grafana.com>
Graphite: bug fix, strip white space from queries before comparing them (#60133)
strip white space from queries before comparing them
(cherry picked from commit d5d07894b1)
Co-authored-by: Brendan O'Handley <brendan.ohandley@grafana.com>
Dashboards: Fix 'Make Editable' button not working in Dashboard Settings (#60306)
* Dashboards: Fix 'Make Editable' button not working in Dashboard Settings
* comment
(cherry picked from commit 258696409d)
Co-authored-by: Josh Hunt <joshhunt@users.noreply.github.com>
Dashboards: Wrap MakeEditable in the new Page layout (#60311)
Wrap MakeEditable in the new Page layout
(cherry picked from commit 495fceeeef)
Co-authored-by: Josh Hunt <joshhunt@users.noreply.github.com>
Dashboards: Show error when data source is missing (#60099)
Return caught exceptions to panel as error state
(cherry picked from commit 9a41277ecd)
Co-authored-by: Josh Hunt <joshhunt@users.noreply.github.com>
Traces: Fix for multiple $__tags in trace to metrics (#59641)
* Fix interpolation of multiple in query
* Add another to test case
(cherry picked from commit bf8814749e)
Co-authored-by: Joey Tawadrous <90795735+joey-grafana@users.noreply.github.com>
Influx: Query segment menus now position correctly near the bottom of the screen (#60087)
* only open the menu once options are loaded for better positioning
* use !loadState.loading instead of Boolean(loadState.value)
(cherry picked from commit bb2ecb1468)
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
Command Palette: Fix not being able to type if triggered whilst another modal is open (#59728)
handle command palette in the same way as other modals
(cherry picked from commit 535c4576f7)
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
TimePicker: Fix time picker selection (#60104)
fix time picker selection
(cherry picked from commit 4e7a316903)
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
Dropdown: Menu now closes correctly when selecting options on touch devices (#60181)
update the version of react-popper-tooltip in @grafana/ui
(cherry picked from commit 75a11e92b2)
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
Docs: adds workaround for editing provisioned rules using the HTTP API (#59094)
* Docs: adds workaround for editing provisioned rules using api
* updates text
* updates text take two
(cherry picked from commit 6c6103d573)
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Navigation: Fix some missing pages in admin section (#60143)
* add stats and licensing under admin -> general when topnav is enabled
* add ldap to users and access
* use ID instead of Id
* add enterprise licensing node
(cherry picked from commit 39a4ba4396)
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
Prometheus: Fix exception being thrown when toggling visibility in explore (#60159)
fix error being thrown when frameIndex is out of bounds of dataframe
(cherry picked from commit b0f8e803a1)
Co-authored-by: Galen Kistler <109082771+gtk-grafana@users.noreply.github.com>
TimeZonePicker: Scroll menu correctly when using keyboard controls (#60008)
pass innerRef to TimeZoneOption so the menu scrolls properly
(cherry picked from commit 97fa63d14d)
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
* Use relative aliases for all non-current Grafana aliases
Prevents non-latest documentation "stealing" the page away from latest
and through permanent redirects for latest pages that no longer exist.
The redirected pages are indexed by search engines but our robots.txt
forbids them crawling the non-latest page.
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Remove all current page aliases
find docs/sources -type f -name '*.md' -exec sed -z -i 's#\n *- /docs/grafana/next/[^\n]*\n#\n#' {} \;
find docs/sources -type f -name '*.md' -exec sed -z -i 's#\n *- /docs/grafana/latest/[^\n]*\n#\n#' {} \;
find docs/sources -type f -name '*.md' -exec sed -Ez -i 's#\n((aliases:\n *-)|aliases:\n)#\n\2#' {} \;
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Chore: All tests under pkg/tests should be integration tests (#59521)
* Chore: All tests under pkg/tests should be integrationtests
* run alerting integration tests only for sqlite
(cherry picked from commit 2db8ed9441)
Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
Fix branch filter for release workflows (#59963)
Ensures the workflow is run on every push to all version branches.
This was thought to be working because it was tested with a manual
dispatch, however, that trigger does not consider filters and was not
an accurate test.
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
(cherry picked from commit 6f9ee7acf9)
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
TimePicker: Prevent TimePicker overflowing viewport on small screens (#59808)
* render timepicker in a modal style on small screens
* remove top: -1
* apply styles
* prevent bug where selecting a relative range wouldn't apply if the absolute ranges were expanded
* Revert "prevent bug where selecting a relative range wouldn't apply if the absolute ranges were expanded"
This reverts commit 7090443c12.
(cherry picked from commit 1497ad4760)
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
Navigation: Prevent app crash when importing a dashboard with a uid of `home` (#59874)
* change home id to be more unique, refactor so that home circular reference is never created
* prefix starred dashboards
* update reducer
(cherry picked from commit a589929c92)
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
Login: Fix failure to login a new user via an external provider if quota are enabled (#60015)
* Login: Fix failure to login a new user via an external provider if quota are enabled
(cherry picked from commit 341d7b01ee)
Co-authored-by: Sofia Papagiannaki <1632407+papagian@users.noreply.github.com>
TimeRangePicker: Fix recent ranges not showing all items (#59836)
* Fix not all recently used time ranges showing
* Refactor time picker history to store simpler json objects
* Don't store duplicate items
* update todo tests:
* Add tests for TimePickerWithHistory
* better fix for focus scope issues in test
(cherry picked from commit 6280780e0c)
Co-authored-by: Josh Hunt <joshhunt@users.noreply.github.com>
* Panel Edit: Fix data links edit icons being off screen when provided title is too long (#59829)
* Fix data links edit icons being off screen
* Remove unused imports
* Review
(cherry picked from commit 6f930f4836)
* Fix backport
Update docs regarding Grafana as an alert receiver (#59938)
* Update docs regarding Grafana as an alert receiver
* Add link to AM docs
(cherry picked from commit 64ccbf0a98)
Co-authored-by: Armand Grillet <2117580+armandgrillet@users.noreply.github.com>
Alerting: Use the QuotaTargetSrv instead of the QuotaTarget in quota check (#60026)
Before this change, the alerting provisioning system incorrectly used
the QuotaTarget to check if alerting's request quota had been reached.
The quota service requires the QuotaTargetSrv, which is what's
registered with the service at startup time. This is leading to errors
in the provisioning system.
(cherry picked from commit e6743a7e9a)
Co-authored-by: Joe Blubaugh <joe.blubaugh@grafana.com>
Prometheus: Fix exemplar fill color to match series color in time series. (#59908)
* Implementing new optional color property to ExemplarMarker component
* Refactor some changes from #59743
(cherry picked from commit dfc15163da)
Co-authored-by: Galen Kistler <109082771+gtk-grafana@users.noreply.github.com>
Prometheus: Fix exemplars not respecting corresponding series display status. (#59743)
* Exemplar filtering when series are toggled in legend UI
(cherry picked from commit 22f828300d)
Co-authored-by: Galen Kistler <109082771+gtk-grafana@users.noreply.github.com>
Prometheus: Add traceID field on top of the exemplar popover (#59920)
Prioritize trace link
(cherry picked from commit 694dc60724)
Co-authored-by: Ludovic Viaud <ludovic.viaud@gmail.com>
ServiceAccounts: Do not display warnings about secret scanner when scanner is disabled (#59952)
ServiceAccounts: Fix warnings about secret scanner when scanner is disabled
(cherry picked from commit d833031726)
Co-authored-by: Jo <joao.guerreiro@grafana.com>
Accessibility: Improved keyboard accessibility in BarGauge (#59382)
* Accessibility: Improved keyboard accessibility in BarGauge
* use appropriate elements when rendering bargauge
* added space for focus-visible outline border
* Revert "added space for focus-visible outline border"
This reverts commit 9b83fa3a0b.
(cherry picked from commit d9f697b41e)
Co-authored-by: Leo <108552997+lpskdl@users.noreply.github.com>
Navigation: handle case where navIndex is undefined (#59826)
handle case where navIndex is undefined
(cherry picked from commit 5d0029c647)
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
Loki: Fix wrongly escaped label values when using LabelFilter (#59812)
* change backticks to quotes
* add unescaping to `addFilterAsLabelFilter`
* fix removal of wrong quotes
* change unescape order
(cherry picked from commit 932349b5ab)
TimeseriesPanel: Preserve string fields for data link interpolation (#58424)
* TimeseriesPanel: Preserve string fields for data link interpolation
* clean code
* Modify tests so that string fields are allowed only when a valid time/number dataframe exists
* performance mods
* fix wrong length
* remove console.log
* Check if aligned dataframe has links
(cherry picked from commit 0da77201bf)
Co-authored-by: Victor Marin <36818606+mdvictor@users.noreply.github.com>
Datasource: Fix - apply default query also to queries in new panels (#59625)
* apply default query also to new panels
* add comment
* add tests
(cherry picked from commit 32309a8373)
Tempo: Fix traceQL suggestions for tag names with dots (#59736)
(cherry picked from commit c6840cfdec)
Co-authored-by: Andrej Ocenas <mr.ocenas@gmail.com>
DataSourcePermissions: Handle licensing properly for ds permissions (#59694)
* RBAC: add viewer grand if dspermissions enforcement is not enabled
* RBAC: Change permissions based on role prefix
* RBAC: Add option to for permission service to add a license middleware
* RBAC: Remove actions from query struct
(cherry picked from commit 6d1bcd9f40)
Co-authored-by: Karl Persson <kalle.persson@grafana.com>
AzureMonitor: Fix panic from empty response in ARG (#59691)
AzureMonitor: Avoid panic from empty response in ARG
(cherry picked from commit 231b5b587c)
Co-authored-by: Andres Martinez Gotor <andres.martinez@grafana.com>
TimeSeries: Fix rendering when zooming to time ranges between datapoints (#59444)
(cherry picked from commit e1e858323a)
Co-authored-by: Leon Sorokin <leeoniya@gmail.com>
Packaging: Use rpm-digest sha256 when creating rpm packages (#59510)
* Use rpm-digest sha256 when creating rpm packages
* only append this argument with rpm builds
(cherry picked from commit 76a586195a)
Co-authored-by: Kevin Minehart <kmineh0151@gmail.com>
RBAC: Handle edge case where there is duplicated acl entries for a role on a single dashboard (#58079)
* RBAC: Handle edge case where there is duplicated acl entries for a role
on a single dashboard
(cherry picked from commit 6aaf36776b)
Co-authored-by: Karl Persson <kalle.persson@grafana.com>
Accessibility: Increase badge constrast to be WCAG AA compliant (#59531)
(cherry picked from commit ddc3706f19)
Co-authored-by: Laura Fernández <laura.fernandez@grafana.com>
Fix XSS in runbook URL (#681)
(cherry picked from commit db1548c1491c2f5b522e3c0ceb1832b914a4b2f0)
Co-authored-by: George Robinson <george.robinson@grafana.com>
(cherry picked from commit e9cb2a313e)
Docs: What's New content for v9.3 (#57991)
* initial content for What's New 9.3
* Update docs/sources/whatsnew/whats-new-in-v9-3.md
* Update docs/sources/whatsnew/whats-new-in-v9-3.md
* makes prettier
* docs: add conflict cli tool
* remoed the conflict users tool in favor of not having it completely out yet
* Adds note about pubdash annotations support in 9.3-beta notes
* puts audit table photo back in right section
* Docs: Add OAuth improvements to what's new in 9.3 (#58756)
* Add OAuth improvements to what's new in v9.3
* Update docs/sources/whatsnew/whats-new-in-v9-3.md
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
* Update docs/sources/whatsnew/whats-new-in-v9-3.md
* Update docs/sources/whatsnew/whats-new-in-v9-3.md
Co-authored-by: Mitch Seaman <mjseaman@users.noreply.github.com>
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
* Docs: Add conflict cli tool (#58827)
docs: add conflict cli tool
* docs: add Terraform updates for What's New in Grafana 9.3 (#58858)
* Terraform updates for Grafana 9.3
* Remove empty line
* linting
* Docs: Update OAuth improvements section of what's new in 9.3 (#59045)
Update OAuth improvement docs for 9.3
* fix incorrect version number
* Adds Alerting whats new entries
* Add edge squad 9.3 whats new information
* Docs: Update whats-new 9.3 with auth related news (#59093)
* LDAP role mapping improvements
* RBAC list token's permissions
* Azure force_use_graph_api
* Reorder
* LDAP uniformize
* Update docs/sources/whatsnew/whats-new-in-v9-3.md
Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>
* Update docs/sources/whatsnew/whats-new-in-v9-3.md
Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>
* Update docs/sources/whatsnew/whats-new-in-v9-3.md
Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>
Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>
* adds new nav and new language to what's new
* Add report zoom to What's New in 9.3 (#59345)
* Add report zoom to What's New in 9.3
Still needs a link to docs, a double-check on the name of the feature toggle, and a screenshot.
* Update whats-new-in-v9-3.md
* Apply suggestions from code review
* makes prettier
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
Co-authored-by: Chris Moyer <chris.moyer@grafana.com>
* add report zoom image
* fix typo
* fix link to upload images in template description
* Copy edits
* copy and format updates
* Apply suggestions from code review
* Update docs/sources/whatsnew/whats-new-in-v9-3.md
* Update docs/sources/whatsnew/whats-new-in-v9-3.md
* Update docs/sources/whatsnew/whats-new-in-v9-3.md
* Update docs/sources/whatsnew/whats-new-in-v9-3.md
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
* Update docs/sources/whatsnew/whats-new-in-v9-3.md
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
* Update docs/sources/whatsnew/whats-new-in-v9-3.md
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
* Update docs/sources/whatsnew/whats-new-in-v9-3.md
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
* Update docs/sources/whatsnew/whats-new-in-v9-3.md
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
* Apply suggestions from code review
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
* Fix prettier
* Update whats-new-in-v9-3.md
* update nav wording
* Screenshots for navigation and internazionalization
* adds alerting images
* fixes path to new nav and localization screenshots
Co-authored-by: eleijonmarck <eric.leijonmarck@gmail.com>
Co-authored-by: Owen Smallwood <owen.smallwood@grafana.com>
Co-authored-by: Misi <mgyongyosi@users.noreply.github.com>
Co-authored-by: Mitch Seaman <mjseaman@users.noreply.github.com>
Co-authored-by: Ieva <ieva.vasiljeva@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: nmarrs <nathanielmarrs@gmail.com>
Co-authored-by: Gabriel MABILLE <gamab@users.noreply.github.com>
Co-authored-by: Mitchel Seaman <mitchel.seaman@gmail.com>
Co-authored-by: Zsofia <97596715+zsofiakomaromigrafana@users.noreply.github.com>
(cherry picked from commit 823a40bc85)
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
Alerting: Fix swallowing of errors when attaching images to notifications (#59432)
* Break out image logic and add logging
* Attach alert log context to image attachment
* Fix capitalization
(cherry picked from commit 1481ace528)
Co-authored-by: Alexander Weaver <weaver.alex.d@gmail.com>
Docs: Minor improvements to Preferences documentation (#59498)
Small improvements to Preferences documentation
(cherry picked from commit b2fdf46820)
Co-authored-by: Josh Hunt <joshhunt@users.noreply.github.com>
Tempo: TraceQL table and editor (#59313)
* Tempo: Add the ability to show/hide the Span column in the table when using TraceQL
* Add optional chaining
* Update tests
* Show subcols in a subtable
* Add more space for the subtable
* Remove unused import
* Better expander icon. Improved the subtable styling. Integrated with real data
* Fix expanding the wrong index when table already has an expanded row
* ⚠️ Hack ⚠️ - Fix table links
* Link to spans
* Tempo: [TraceQL] Don't wrap the autocomplete vals for the status tag in quotes
* TraceQL result table improvements and fixes
* Include span name in the subtable
* Loop through data only if it is not nullish
* Integrate traceql with sub-tables
* Added booleans as keywords. Make query editor multiline
* Make date format consistent between trace and span
* Reset expanded indexes when data or subdata change
* Dynamic attributes by trace
* Fix test. Cleanup and refactor
* Tiny refactor
Co-authored-by: Hamas Shafiq <hamas.shafiq@grafana.com>
Co-authored-by: Andrej Ocenas <mr.ocenas@gmail.com>
(cherry picked from commit 8dbde1b921)
Co-authored-by: Andre Pereira <adrapereira@gmail.com>
Docs: Improve Labels and annotations docs (#59325)
This commit makes a number of changes to the docs for Labels and
annotations.
1. It changes the order in which Labels and annotations are mentioned
from Annotations and labels to Labels and annotations as this is
the order shown in the UI when creating and editing alert rules.
It is also the order in the Prometheus documentation.
2. It changes most of the documentation explaining what labels and
annotations are and the differences between them. It also adds
some paragraphs on Custom Labels.
(cherry picked from commit e7316ff13f)
Co-authored-by: George Robinson <george.robinson@grafana.com>
OptionsUI: SliderValueEditor does not get auto focused on slider change (#59209)
(cherry picked from commit 45d3125919)
Co-authored-by: Laura Fernández <laura.fernandez@grafana.com>
Breadcrumbs: Remove semi-bold and change current/last breadcrumb text color (#58875)
(cherry picked from commit c14cbfc65d)
Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
Navigation: Support rbac for new dashboard, import dashboard and new folder (#59303)
RBAC: Support rbac for new dashboard, import dashboard and new folder
page
(cherry picked from commit a53f57cc43)
Co-authored-by: Karl Persson <kalle.persson@grafana.com>
PostgreSQL: Fix missing CA field from configuration (#59280)
* PostgreSQL: Fix missing CA field from configuration
(cherry picked from commit be73418d00)
Co-authored-by: Oscar Kilhed <oscar.kilhed@grafana.com>
User: Optimize signed in user cache management (#59090)
* only access the cache if a user ID is set
* ignore all negative values
(cherry picked from commit d7a652ff7f)
Co-authored-by: Jo <joao.guerreiro@grafana.com>
Explore: Sub-tables support for Table component (#58682)
* First commit with working version of sub-tables using subData array
* Update TableContainer and query result to support a dataframe array for the table result
* Fix border issue by moving the subtable to above the cells in the DOM
* Allow header to be configurable using custom options.
* Update TablePanel to support sub-tables
* Fix main row links
* Added tests
* Fix TablePanel correctly splitting frames and sub-frames by using refId
(cherry picked from commit 183b279274)
Co-authored-by: Andre Pereira <adrapereira@gmail.com>
Internationalization: Enable internationalization by default (#59204)
* Enable internationalization feature flag by default
* Change i18n feature to beta
* Set i18n feature flag to stable
* update features
(cherry picked from commit ba0ac08465)
Co-authored-by: Josh Hunt <joshhunt@users.noreply.github.com>
Azure Monitor Logs: Avoid warning when the response is empty (#59211)
(cherry picked from commit 9d88e14f01)
Co-authored-by: Andres Martinez Gotor <andres.martinez@grafana.com>
Navigation: always show `GetStartedWithPlugin` even if there's install control wa… (#59127)
always show `GetStartedWithPlugin` even if there's install control warnings
(cherry picked from commit c2f31c2685)
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
Solo Panel: Configurable timezone (#59153)
* Allow to set timezone in query
* Use optional timestamp
* Update timeZone
(cherry picked from commit a0334a92f5)
Co-authored-by: Selene <selenepinillos@gmail.com>
Navigation: share logic between `buildBreadcrumbs` and `usePageTitle` (#58819)
* simplify usePageTitle logic a bit
* use buildBreadcrumbs logic in usePageTitle
* always add home item to navTree, fix some tests
* fix remaining unit tests
(cherry picked from commit 824a562b03)
Navigation: use correct id to find cloud access policies page (#59123)
use correct id to find cloud access policies page
(cherry picked from commit 8761a71da2)
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
Heatmap: Fix tooltip y range of top and bottom buckets in calculated heatmaps (#59172)
Co-authored-by: xdavidwu <xdavidwuph@gmail.com>
(cherry picked from commit 2a8706b025)
Co-authored-by: Leon Sorokin <leeoniya@gmail.com>
Geomap: Improve location editor (#58017)
* add custom component for location editor
* FC cleanup
* Apply filter to add location fields call
* Create custom editor for location mode
* Apply validation logic and render warning
* Improve alert styling
* Add help url button to location alert
* Add success alert for auto
* Remove completed TODOs
* Only use alert on error, not success
* Change location mode to dropdown
* Change alert severity to less severe, info
* Prevent auto field selection during manual
* Update location testing to be for auto mode
* Run geo transformer editor init once
* Fix breaking test
* Clean up some anys
* Update styling for alert
* Remove auto success styling
Co-authored-by: Ryan McKinley <ryantxu@gmail.com>
Co-authored-by: nmarrs <nathanielmarrs@gmail.com>
(cherry picked from commit ee8f292c6a)
Co-authored-by: Drew Slobodnjak <60050885+drew08t@users.noreply.github.com>
Internationalization: Translate ViewJSONmodal and ClipboardButton (#58807)
(cherry picked from commit 8f567d57fa)
Co-authored-by: Laura Fernández <laura.fernandez@grafana.com>
Internationalization: Translate 'Hide / show legend' of PanelHeaderMenuItem (#58800)
(cherry picked from commit f2cb248d93)
Co-authored-by: Laura Fernández <laura.fernandez@grafana.com>
AzureMonitor: Separate subscription health check API version (#58253)
Separate subscription health check API version
(cherry picked from commit f8656d269d)
Co-authored-by: Andreas Christou <andreas.christou@grafana.com>
* Fix: Add checkForPathSeparator validation in group name for grafana-managed alerts in form
* Build: Disable flaky RuleEditor frontend test
* trigger CI
Chore: Document theme toggle keybinding (#59031)
* make theme toggle keybinding dev only
* fix bug + add support for theme change keybinding
(cherry picked from commit 6f26668a9f)
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
DataSourceWithBackend - Set postResource method to POST (#59114)
Set postResource method to POST
(cherry picked from commit 4eed56193f)
Co-authored-by: Andreas Christou <andreas.christou@grafana.com>
@grafana/runtime: Avoid calling applyTemplateVariables for the wrong datasource (#57921)
(cherry picked from commit 448358ac66)
Co-authored-by: Andres Martinez Gotor <andres.martinez@grafana.com>
Alerting: Support Prometheus durations in Provisioning API (#58293)
Provisioning API should support Prometheus durations
(cherry picked from commit 57d6adbc7c)
Co-authored-by: Bart Peeters <birtpeeters@hotmail.com>
Prometheus: fix Heatmap y buckets when legendFormat: auto (#59053)
(cherry picked from commit 1f4834a144)
Co-authored-by: Leon Sorokin <leeoniya@gmail.com>
Navigation: Prevent viewer role accessing dashboard creation, import and folder creation (#58842)
hide pages related dashboard import create and folder creation for viewer role
(cherry picked from commit 14fbd44ac0)
Co-authored-by: Leo <108552997+lpskdl@users.noreply.github.com>
Nav: Split Admin into three sections for new IA (#58229)
* start to split admin into two sections
* most of new admin nav implemented
* landing pages
* hide admin for non-admins
* update admin redirects if not topnav
* clean up
* updated IA for admin (still WIP)
* move plugin pages into correct admin sections
* fix backend unit test
* move correlations into the correct section
* add translations for admin sections
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
(cherry picked from commit 5978dc138e)
Co-authored-by: Josh Hunt <joshhunt@users.noreply.github.com>
Navigation: Stop clearing search state when opening a result in a new tab (#58880)
search: only clear search state if not opening in a new tab
(cherry picked from commit 5226a61f67)
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
Navigation: move connections + integrations to be a top level item (#58902)
* move connections + integrations to be a top level item
* add a test to check we can move apps to the root
* split out movePlugin logic into a separate function
* fix linting
* rename movePlugin -> addPluginToSection
(cherry picked from commit d46e3916a1)
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
OAuth: Refactor OAuth parameters handling to support obtaining refresh tokens for Google OAuth (#58782)
* Add ApprovalForce to AuthCodeOptions
* Extract access token validity check to a function
* Refactor
* Oauth: set options internally instead of exposing new function
* Align tests
* Remove unused function
Co-authored-by: Karl Persson <kalle.persson@grafana.com>
(cherry picked from commit 9c98314e9f)
Co-authored-by: Misi <mgyongyosi@users.noreply.github.com>
Navigation: rename Grafana Machine Learning to just Machine Learning (#58893)
rename Grafana Machine Learning to just Machine Learning
(cherry picked from commit ac66e14054)
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
Chore: Extract server lock error so it can be used with errors.As (#58899)
chore: extract server lock Error so it can be used with error.As
(cherry picked from commit 7e9d94cfda)
Co-authored-by: Jo <joao.guerreiro@grafana.com>
Navigation: Change quick add styling (#58854)
Change quick add styling + allow for returning isOpen state to dropdown children
(cherry picked from commit b398e8640d)
Co-authored-by: Ashley Harrison <ashley.harrison@grafana.com>
QueryData: fix header parsing to support expressions (#58826)
fixes#58821
(cherry picked from commit 934fb2f0ee)
Co-authored-by: Ryan McKinley <ryantxu@gmail.com>
AppRootPage: Render app plugins without pages (#58776)
fix: render app plugins that don't have a page in includes
(cherry picked from commit 4ee83a5f2b)
Co-authored-by: Levente Balogh <balogh.levente.hu@gmail.com>
Fix: Bump-version action regex pattern to work with beta1 (#58805)
Fixing bump version regex
(cherry picked from commit 174a039ee1)
Co-authored-by: Timur Olzhabayev <timur.olzhabayev@grafana.com>
title:"Product-Area-Here: short description of bug here"
body:
- type:markdown
attributes:
value:|
Thanks for taking the time to fill out this bug report!
Please try to give your issue a good title. Try using the product-area where you are having an issue and a brief description of the problem. Like this:
- `Dashboards: Template Variables break when I do X` or
- `Alerting: message templating plus Slack channel breaks when I do X`
- type:markdown
attributes:
value:|
**HINT:** Have you tried [searching](https://github.com/grafana/grafana/issues) for similar issues? Duplicate issues are common.
**Are you reporting a security vulnerability?** [Submit it here instead](https://github.com/grafana/grafana/security/policy).
- type:markdown
attributes:
value:|
#
- type:textarea
id:bug-describe
attributes:
label:|
# What went wrong?
description:|
#
Describe your bug. What happened? What did you expect to happen?
**Hot Tip:** Record your screen and add it here as a gif.
placeholder:Tell us what you see!
value:|
**What happened**:
-
**What did you expect to happen**:
-
validations:
required:true
- type:markdown
attributes:
value:|
#
- type:textarea
id:bug-repro
attributes:
label:|
# How do we reproduce it?
description:|
#
Whenever possible, please provide **detailed** steps for reproducing your bug.
**This is very helpful info**
placeholder:"Step 1:..."
value:|
**Step 1**:
- Open Grafana and do X
**Step 2**:
- Now click button Y
**Step 3**:
- Wait for the browser to crash. Error message says: "Error..."
validations:
required:true
- type:markdown
attributes:
value:|
#
- type:input
id:gf-version
attributes:
label:|
# What Grafana version are you using?
description:|
#
- [How do I find my Grafana version info?](https://community.grafana.com/t/how-to-find-your-grafana-version-info-3-different-ways/86857)
placeholder:"ex: v9.5.0, or v9.5.0-cloud.5.a016665c (b2a5d45589)"
validations:
required:true
- type:markdown
attributes:
value:|
#
#
# Optional Questions:
#
- type:textarea
id:get-help
attributes:
label:|
## Optional Questions:
### Is the bug inside a Dashboard Panel?
description:|
If the bug appears inside a [dashboard panel](https://grafana.com/docs/grafana/latest/panels-visualizations/#panels-and-visualizations), please use the ["Get-Help" feature](https://grafana.com/docs/grafana/latest/troubleshooting/send-panel-to-grafana-support/). Select **copy to clipboard** and paste the data below.
No need for backticks--this text will get formatted as a code-block.
What's a [dashboard panel](https://grafana.com/docs/grafana/latest/panels-visualizations/#panels-and-visualizations)?
placeholder:Copy "get-help" data here
value:Copy the panel's ["get-help" data](https://grafana.com/docs/grafana/latest/troubleshooting/send-panel-to-grafana-support/) here
- type:dropdown
id:gf-deployment
attributes:
label:Grafana Platform?
description:|
**How** are you running/deploying Grafana?
options:
- I use Grafana Cloud
- Docker
- Kubernetes
- A package manager (APT, YUM, BREW, etc.)
- A downloaded binary
- Other
- I don't know
validations:
required:false
- type:input
id:user-os
attributes:
label:User's OS?
description:What operating system are you running locally?
placeholder:"ex. MacOS Big Sur 11.7, or Ubuntu 20.04..."
- type:input
id:user-browser
attributes:
label:User's Browser?
description:Is the bug occuring in Grafana's user-interface? If so, what browsers are you seeing the problem on? You may choose more than one.
placeholder:"ex. Google Chrome Version 112.0.5615.137 (Official Build) (arm64)..."
- type:dropdown
id:regression
attributes:
label:Is this a Regression?
description:|
A regression means that the feature was working, then you upgraded, and now it's broken.
options:
- 'No'
- 'Yes'
validations:
required:false
- type:input
id:gf-datasource
attributes:
label:Are Datasources involved?
description:|
Is this issue specific to a datasource plugin / plugins? Please list all that apply:
placeholder:"ex. Elasticsearch 5.0.0 or Infinity 1.4.1 ..."
Please use this template to create your bug report. By providing as much info as possible you help us understand the issue, reproduce it and resolve it for you quicker. Therefore take a couple of extra minutes to make sure you have provided all info needed.
PROTIP: record your screen and attach it as a gif to showcase the issue.
- Questions should be posted to: https://community.grafana.com
- Use query inspector to troubleshoot issues: https://bit.ly/2XNF6YS
- How to record and attach gif: https://bit.ly/2Mi8T6K
-->
**What happened**:
**What you expected to happen**:
**How to reproduce it (as minimally and precisely as possible)**:
about: Create an issue for a chore needing completion
labels: 'type: chore'
---
<!--
Please use this template to create your chore issue. You can use this template if you spot an out-of-date README, discover a misspelling, or happen upon a deeply nested 7-layer for-loop that could be better handled another way. Please use this template for your non-bug related fixes/updates/refactors.
- Questions should be posted to: https://community.grafana.com
- Use query inspector to troubleshoot issues: https://bit.ly/2XNF6YS
- How to record and attach gif: https://bit.ly/2Mi8T6K
@@ -42,9 +42,5 @@ Usage: "Fixes #<issue number>", or "Fixes (paste link of issue)"
Fixes #
**Special notes for your reviewer:**
**Special notes for your reviewer**:
Please check that:
- [ ] It works as expected from a user's perspective.
- [ ] If this is a pre-GA feature, it is behind a feature toggle.
- [ ] The docs are updated, and if this is a [notable improvement](https://grafana.com/docs/writers-toolkit/writing-guide/contribute-release-notes/#how-to-determine-if-content-belongs-in-a-whats-new-document), it's added to our [What's New](https://grafana.com/docs/writers-toolkit/writing-guide/contribute-release-notes/) doc.
@@ -23,7 +23,7 @@ Metrics are configured in [metrics-collector.json](https://github.com/grafana/gr
## Backport PR
To automatically backport a PR to a release branch like v7.3.x add a label named `backport v7.3.x`. The label name should follow the pattern `backport <branch-name>`. Once merged grafanabot will automatically
try to cherry-pick the PR merge commit into that branch and open a PR. You must then add the milestone to your backport PR.
try to cherry-pick the PR merge commit into that branch and open a PR. It will sync the milestone with the source PR so make sure the source PR also is assigned the milestone for the patch release. If the PR is already merged you can still add this label and trigger the backport automation.
If there are merge conflicts the bot will write a comment on the source PR saying the cherry-pick failed. In this case you have to do the cherry pick and backport PR manually.
"comment":" please add one or more appropriate labels. Here are some tips:\r\n\r\n- if you are making an issue, TODO, or reminder for yourself or your team, please add one label that best describes the product or feature area. Please also add the issue to your project board. :rocket:\r\n\r\n- if you are making an issue for any other reason (docs typo, you found a bug, etc), please add at least one label that best describes the product or feature that you are discussing (e.g. `area/alerting`, `datasource/loki`, `type/docs`, `type/bug`, etc). [Our issue triage](https://github.com/grafana/grafana/blob/main/ISSUE_TRIAGE.md#3-categorizing-an-issue) doc also provides additional guidance on labeling. :rocket:\r\n\r\n Thank you! :heart:"
description: 'Needs to match, exactly, the name of a milestone. The version to be released please respect: major.minor.patch or major.minor.patch-beta<number> format. example:7.4.3or 7.4.3-beta1'
required:true
env:
YARN_ENABLE_IMMUTABLE_INSTALLS:false
YARN_ENABLE_IMMUTABLE_INSTALLS:false
jobs:
main:
runs-on:ubuntu-latest
steps:
# This is a basic workflow to help you get started with Actions
# This is a basic workflow to help you get started with Actions
# Checks-out your repository, which is validated in the next step
- uses:actions/checkout@v2
- name:GitHub CODEOWNERS Validator
uses:mszostok/codeowners-validator@v0.7.4
# input parameters
with:
# ==== GitHub Auth ====
# "The list of checks that will be executed. By default, all checks are executed. Possible values: files,owners,duppatterns,syntax"
checks:"files,duppatterns,syntax"
# "The comma-separated list of experimental checks that should be executed. By default, all experimental checks are turned off. Possible values: notowned,avoid-shadowing"
experimental_checks:"notowned,avoid-shadowing"
# The repository path in which CODEOWNERS file should be validated."
repository_path:"."
# Defines the level on which the application should treat check issues as failures. Defaults to warning, which treats both errors and warnings as failures, and exits with error code 3. Possible values are error and warning. Default: warning"
check_failure_level:"error"
# The comma-separated list of patterns that should be ignored by not-owned-checker. For example, you can specify * and as a result, the * pattern from the CODEOWNERS file will be ignored and files owned by this pattern will be reported as unowned unless a later specific pattern will match that path. It's useful because often we have default owners entry at the begging of the CODOEWNERS file, e.g. * @global-owner1 @global-owner2"
not_owned_checker_skip_patterns:""
# Specifies whether CODEOWNERS may have unowned files. For example, `/infra/oncall-rotator/oncall-config.yml` doesn't have owner and this is not reported.
owner_checker_allow_unowned_patterns:"false"
# Specifies whether only teams are allowed as owners of files.
name:When epic issues changed in Platform UX squad projects, check if epic is part of specified child projects and update on Platform UX parent project
description: 'The version to be released please respect: major.minor.patch, major.minor.patch-preview or major.minor.patch-preview<number> format. example:7.4.3,7.4.3-preview or 7.4.3-preview1'
description: 'The version to be released please respect: major.minor.patch or major.minor.patch-beta<number> format. example:7.4.3or 7.4.3-beta1'
description: 'Needs to match, exactly, the name of a milestone. The version to be released please respect: major.minor.patch or major.minor.patch-beta<number> format. example:7.4.3or 7.4.3-beta1'
"io/ioutil"="Deprecated: As of Go 1.16, the same functionality is now provided by package io or package os, and those implementations should be preferred in new code. See the specific function documentation for details."
"gopkg.in/yaml.v2"="Grafana packages are not allowed to depend on gopkg.in/yaml.v2 as gopkg.in/yaml.v3 is now available"
"github.com/pkg/errors"="Deprecated: Go 1.13 supports the functionality provided by pkg/errors in the standard library."
"github.com/xorcare/pointer"="Use pkg/util.Pointer instead, which is a generic one-liner alternative"
"github.com/gofrs/uuid"="Use github.com/google/uuid instead, which we already depend on."
[linters-settings.gocritic]
enabled-checks=["ruleguard"]
@@ -86,11 +82,7 @@ text = "ST1001"
# Use golang.org/x/text/cases instead.
[[issues.exclude-rules]]
linters=["staticcheck"]
text="SA1019: strings.Title"
[[issues.exclude-rules]]
linters=["staticcheck"]
text="use fake service and real access control evaluator instead"
@@ -15,7 +15,7 @@ You can contribute to Grafana in several ways. Here are some examples:
- Organize meetups and user groups in your local area.
- Help others by answering questions about Grafana.
**Please note:** We do not currently accept contributions for translations. Please do not submit pull requests translating grafana.json files - they will be rejected. We do accept contributions to mark up phrases for translation. See [Internationalization](contribute/internationalization.md).
**Please note:** We do not currently accept contributions for translations. Please do not submit pull requests for messages.po files - they will be rejected.
For more ways to contribute, check out the [Open Source Guides](https://opensource.guide/how-to-contribute/).
@@ -96,29 +87,28 @@ Given a certain [issue template](https://github.com/grafana/grafana/issues/new/c
Should explain what happened, what was expected and how to reproduce it together with any additional information that may help giving a complete picture of what happened such as screenshots, [query inspector](https://community.grafana.com/t/using-grafanas-query-inspector-to-troubleshoot-issues/2630) output and any environment related information that's applicable and/or maybe related to the reported problem:
- Grafana version:
- Data source type & version:
- OS Grafana is installed on:
- User OS & Browser:
-Grafana plugins:
-Others:
- Grafana version
- Data source type & version
- Platform & OS Grafana is installed on
- User OS & Browser + versions
-Using docker + what environment
-Which plugins
- Configuration database in use (sqlite, mysql, postgres)
- Reverse proxy in front of Grafana, what version and configuration
- Non-default configuration settings
- Development environment like Go and Node versions, if applicable
#### Enhancement requests
Enhancement requests (aka. feature requests) should be created as a [Github discussion](https://github.com/grafana/grafana/discussions). When submitting an enhancement request we ask that users focus on the problem they'd like to solve and why it’s a problem rather than focusing on the solution itself. To facilitate this we recommend using the following template:
- What would you like to be added?:
- Why is this needed (describe your use case and goals)\*\*?:
Should explain what enhancement or feature that the author wants to be added and why that is needed.
#### Accessibility issues
This is a mix between a bug report and enhancement request but focused on accessibility issues to help make Grafana improve keyboard navigation, screen-reader support and being accessible to everyone. The report should include relevant [WCAG criteria](https://www.w3.org/WAI/WCAG21/quickref/?versions=2.0), if applicable.
Grafana Labs is dedicated to improving our graphical user interfaces and overall experience so that our product becomes usable and accessible for people with disabilities as well as anyone else. Learn more about Grafana's commitment to [A11y](https://grafana.com/accessibility/) (accessibility).
This is a mix between a bug report and enhancement request but focused on accessibility issues to help make Grafana improve keyboard navigation, screen-reader support and being accessible to everyone. The report should include relevant WCAG criteria, if applicable.
#### Support requests
In general, if the issue description and title is perceived as a question no more information is needed. See how to categorize these requests [here](#support-requests-1).
In general, if the issue description and title is perceived as a question no more information is needed.
### Good practices
@@ -132,7 +122,7 @@ To make it easier for everyone to understand and find issues they're searching f
### Do you have all the information needed to categorize an issue?
Depending on the issue, you might not feel all this information is needed. Use your best judgement. If you cannot triage an issue using what its author provided, explain kindly to the author that they must provide the above information to clarify the problem. Label issue with `needs more info` and add any related `area/*` or `datasource/*` labels. Alternatively, use `bot/needs more info` label and the Grafana bot will request it for you.
Depending on the issue, you might not feel all this information is needed. Use your best judgement. If you cannot triage an issue using what its author provided, explain kindly to the author that they must provide the above information to clarify the problem. Label issue with `needs more detail` and add any related `area/*` or `datasource/*` labels.
If the author provides the standard information but you are still unable to triage the issue, request additional information. Do this kindly and politely because you are asking for more of the author's time.
@@ -168,7 +158,7 @@ Make sure it's not a duplicate by searching existing issues using related terms
1. Add a comment `/duplicate of #<issue number>`. GitHub will recognize this and add some additional context to the issue activity.
2. The Grafana bot will do the rest, adding the correct label and closing comment
3. Add `type/duplicate` label. Optionally add any related `area/*` or `datasource/*` labels.
3. Optionally add any related `area/*` or `datasource/*` labels.
### Bug reports
@@ -193,8 +183,8 @@ If it's not perfectly clear that it's an actual bug, quickly try to reproduce it
### Enhancement/feature?
1.Remind the contributor that enhancement/featurerequest should be created as a GitHub discussion. See [Enhancements requests.](https://github.com/grafana/grafana/blob/main/ISSUE_TRIAGE.md#enhancement-requests)
2.Label the issue `type/feature-request` and at least one `area/*` or `datasource/*` label.
1.Label the issue `type/feature-request` and at least one `area/*` or `datasource/*` label.
2.Move on to [prioritizing the issue](#4-prioritization-of-issues).
### Documentation issue?
@@ -225,7 +215,7 @@ There's a minor typo/error/lack of information that adds a lot of confusion for
### Support requests
1. Kindly and politely direct the issue author to the [community site](https://community.grafana.com/) and explain that GitHub is mainly used for tracking bugs and feature requests. If possible, it's usually a good idea to add some pointers to the issue author's question.
2.Label the issue with `bot/question`. The Grafana bot will automatically close the issue, and it will add the type/question label for you.
2.Close the issue and label it with `type/question`.
## 4. Prioritization of issues
@@ -306,7 +296,7 @@ In many cases the issue author or community as a whole is more suitable to contr
## Investigation of issues
When an issue has all basic information provided, but the triage responsible haven't been able to reproduce the reported problem at a first glance, the issue is labeled [`triage/needs-confirmation`](https://github.com/grafana/grafana/labels/triage%2Fneeds-confirmation). Depending on the perceived severity and/or number of [upvotes](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments), the investigation will either be delegated to another maintainer for further investigation or put on hold until someone else (maintainer or contributor) picks it up and eventually starts investigating it.
When an issue has all basic information provided, but the triage responsible haven't been able to reproduce the reported problem at a first glance, the issue is labeled [Needs investigation](https://github.com/grafana/grafana/labels/needs%20investigation). Depending on the perceived severity and/or number of [upvotes](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments), the investigation will either be delegated to another maintainer for further investigation or put on hold until someone else (maintainer or contributor) picks it up and eventually starts investigating it.
Investigating issues can be a very time consuming task, especially for the maintainers, given the huge number of combinations of plugins, data sources, platforms, databases, browsers, tools, hardware, integrations, versions and cloud services, etc that are being used with Grafana. There is a certain number of combinations that are more common than others, and these are in general easier for maintainers to investigate.
@@ -318,16 +308,19 @@ Even if you don't have the time or knowledge to investigate an issue we highly r
We have some automation that triggers on comments or labels being added to issues. Many of these automated behaviors are defined in [commands.json](https://github.com/grafana/grafana/blob/main/.github/commands.json). Or in other [GitHub Actions](https://github.com/grafana/grafana/tree/main/.github/workflows)
- Add /duplicate `#<issue number>` to have Grafana label & close issue with an appropriate message.
- Add `bot/question` and the bot will close it with an appropriate message.
[Read more on bot actions](https://github.com/grafana/grafana/blob/main/.github/bot.md)
## External PRs
Part of issue triage should also be triaging of external PRs. Main goal should be to make sure PRs from external contributors have an owner/reviewer and are not forgotten.
1. Check new external PRs which do not have a reviewer. You can easily search for pull requests made by external contributors by using the label: `pr/external` in your [query search](https://github.com/grafana/grafana/pulls?q=is%3Aopen+is%3Apr+label%3Apr%2Fexternal) Note: external PRs are automatically labeled with `pr/external` upon creation.
2. Check if there is a link to an existing issue. The link to a existing issue should be in the description section, underneath “Which issue(s) does this PR fix?:”.
3. If not and you know which issue it is solving, add the link yourself, otherwise ask the author to link the issue or create one.
4. Assign a reviewer based on who was handling the linked issue or what code or feature does the PR touches (look at who was the last to make changes there if all else fails).
1. Check new external PRs which do not have a reviewer.
1. Check if there is a link to an existing issue.
1. If not and you know which issue it is solving, add the link yourself, otherwise ask the author to link the issue or create one.
1. Assign a reviewer based on who was handling the linked issue or what code or feature does the PR touches (look at who was the last to make changes there if all else fails).
This version of Grafana has big changes that will impact a limited set of plugins. We moved from systemjs to webpack
for built-in plugins and everything internal. External plugins still use systemjs but now with a limited
set of Grafana components they can import. Plugins can depend on libs like lodash & moment and internal components
like before using the same import paths. However since everything in Grafana is no longer accessible, a few plugins could encounter issues when importing a Grafana dependency.
[List of exposed components plugins can import/require](https://github.com/grafana/grafana/blob/main/public/app/features/plugins/plugin_loader.ts#L48)
If you think we missed exposing a crucial lib or Grafana component let us know by opening an issue.
### Deprecated components
The angular directive `<spectrum-picker>` is now deprecated (will still work for a version more) but we recommend plugin authors
upgrade to new `<color-picker color="ctrl.color" onChange="ctrl.onSparklineColorChange"></color-picker>`
## Changes in Grafana v6.0
### DashboardSrv.ts
If you utilize [DashboardSrv](https://github.com/grafana/grafana/commit/8574dca081002f36e482b572517d8f05fd44453f#diff-1ab99561f9f6a10e1fafcddc39bc1d65) in your plugin code, `dash` was renamed to `dashboard`.
@@ -14,6 +14,7 @@ Grafana Labs will send you a response indicating the next steps in handling your
## Security announcements
We will post a summary, remediation, and mitigation details for any patch containing security fixes on the Grafana blog. The security announcement blog posts will be tagged with the [security tag](https://grafana.com/tags/security/).
We maintain a category on the community site called [Security Announcements](https://community.grafana.com/c/support/security-announcements),
where we will post a summary, remediation, and mitigation details for any patch containing security fixes.
You can also track security announcements via the [RSS feed](https://grafana.com/tags/security/index.xml).
You can also subscribe to email updates to this category if you have a grafana.com account and sign on to the community site or track updates via an [RSS feed](https://community.grafana.com/c/support/security-announcements.rss).
# You can configure the database connection by specifying type, host, name, user and password
@@ -147,9 +134,6 @@ path = grafana.db
# For "sqlite3" only. cache mode setting used for connecting to the database
cache_mode=private
# For "sqlite3" only. Enable/disable Write-Ahead Logging, https://sqlite.org/wal.html. Default is false.
wal=false
# For "mysql" only if migrationLocking feature toggle is set. How many seconds to wait before failing to lock the database for the migrations, default is 0.
locking_attempt_timeout_sec=0
@@ -159,9 +143,6 @@ query_retries = 0
# For "sqlite" only. How many times to retry transaction in case of database is locked failures. Default is 5.
transaction_retries=5
# Set to true to add metrics and tracing for database queries.
instrument_queries=false
#################################### Cache server #############################
[remote_cache]
# Either "redis", "memcached" or "database" default is "database"
@@ -173,12 +154,6 @@ type = database
# memcache: 127.0.0.1:11211
connstr=
# prefix prepended to all the keys in the remote cache
prefix=
# This enables encryption of values stored in the remote cache
encryption=
#################################### Data proxy ###########################
[dataproxy]
@@ -224,9 +199,6 @@ response_limit = 0
# Limits the number of rows that Grafana will process from SQL data sources.
row_limit=1000000
# Sets a custom value for the `User-Agent` header for outgoing data proxy requests. If empty, the default value is `Grafana/<BuildVersion>` (for example `Grafana/9.0.0`).
# Upper limit of data sources that Grafana will return. This limit is a temporary configuration and it will be deprecated when pagination will be introduced on the list data sources API.
datasource_limit=5000
################################### SQL Data Sources #####################
[sql_datasources]
# Default maximum number of open connections maintained in the connection pool
# when connecting to SQL based data sources
max_open_conns_default=100
# Default maximum number of idle connections maintained in the connection pool
# when connecting to SQL based data sources
max_idle_conns_default=100
# Default maximum connection lifetime used when connecting
# Default UI theme ("dark" or "light" or "system")
# Default UI theme ("dark" or "light")
default_theme=dark
# Default UI language (supported IETF language tag, such as en-US)
default_language=en-US
# Default locale (supported IETF language tag, such as en-US)
default_locale=en-US
# Path to a custom home page. Users are only redirected to this if the default home dashboard is used. It should match a frontend route and contain a leading slash.
# Enable the Unified Alerting sub-system and interface. When enabled we'll migrate all of your alert rules and notification channels to the new system. New alert rules will be created and your notification channels will be converted into an Alertmanager configuration. Previous data is preserved to enable backwards compatibility but new data is removed when switching. When this configuration section and flag are not defined, the state is defined at runtime. See the documentation for more details.
# The interval string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
alertmanager_config_poll_interval=60s
# The redis server address that should be connected to.
ha_redis_address=
# The username that should be used to authenticate with the redis server.
ha_redis_username=
# The password that should be used to authenticate with the redis server.
ha_redis_password=
# The redis database, by default it's 0.
ha_redis_db=
# A prefix that is used for every key or channel that is created on the redis server
# as part of HA for alerting.
ha_redis_prefix=
# The name of the cluster peer that will be used as identifier. If none is
# provided, a random one will be generated.
ha_redis_peer_name=
# Listen address/hostname and port to receive unified alerting messages for other Grafana instances. The port is used for both TCP and UDP. It is assumed other Grafana instances are also running on the same port.
ha_listen_address="0.0.0.0:9094"
@@ -1048,23 +906,12 @@ max_attempts = 3
# The interval string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
min_interval=10s
# This is an experimental option to add parallelization to saving alert states in the database.
# It configures the maximum number of concurrent queries per rule evaluated. The default value is 1
# (concurrent queries per rule disabled).
max_state_save_concurrency=1
[unified_alerting.screenshots]
# Enable screenshots in notifications. You must have either installed the Grafana image rendering
# plugin, or set up Grafana to use a remote rendering service.
# For more information on configuration options, refer to [rendering].
capture=false
# The timeout for capturing screenshots. If a screenshot cannot be captured within the timeout then
# the notification is sent without a screenshot. The maximum duration is 30 seconds. This timeout
# should be less than the minimum Interval of all Evaluation Groups to avoid back pressure on alert
# rule evaluation.
capture_timeout=10s
# The maximum number of screenshots that can be taken at the same time. This option is different from
# concurrent_render_request_limit as max_concurrent_screenshots sets the number of concurrent screenshots
# that can be taken at the same time for all firing alerts where as concurrent_render_request_limit sets
# Enable the legacy alerting sub-system and interface. If Unified Alerting is already enabled and you try to go back to legacy alerting, all data that is part of Unified Alerting will be deleted. When this configuration section and flag are not defined, the state is defined at runtime. See the documentation for more details.
@@ -1227,8 +1022,6 @@ enabled = true
interval_seconds=10
# Disable total stats (stat_totals_*) metrics to be generated
disable_total_stats=false
# The interval at which the total stats collector will update the stats. Default is 1800 seconds.
total_stats_collector_interval_seconds=1800
#If both are set, basic auth will be required for the metrics endpoints.
# You can configure the database connection by specifying type, host, name, user and password
@@ -149,9 +136,6 @@
# For "sqlite3" only. cache mode setting used for connecting to the database. (private, shared)
;cache_mode = private
# For "sqlite3" only. Enable/disable Write-Ahead Logging, https://sqlite.org/wal.html. Default is false.
;wal = false
# For "mysql" only if migrationLocking feature toggle is set. How many seconds to wait before failing to lock the database for the migrations, default is 0.
;locking_attempt_timeout_sec = 0
@@ -161,9 +145,6 @@
# For "sqlite" only. How many times to retry transaction in case of database is locked failures. Default is 5.
;transaction_retries = 5
# Set to true to add metrics and tracing for database queries.
;instrument_queries = false
################################### Data sources #########################
[datasources]
# Upper limit of data sources that Grafana will return. This limit is a temporary configuration and it will be deprecated when pagination will be introduced on the list data sources API.
@@ -180,12 +161,6 @@
# memcache: 127.0.0.1:11211
;connstr =
# prefix prepended to all the keys in the remote cache
; prefix =
# This enables encryption of values stored in the remote cache
;encryption =
#################################### Data proxy ###########################
[dataproxy]
@@ -231,9 +206,6 @@
# Limits the number of rows that Grafana will process from SQL data sources.
;row_limit = 1000000
# Sets a custom value for the `User-Agent` header for outgoing data proxy requests. If empty, the default value is `Grafana/<BuildVersion>` (for example `Grafana/9.0.0`).
# Default UI language (supported IETF language tag, such as en-US)
;default_language = en-US
# Default locale (supported IETF language tag, such as en-US)
;default_locale = en-US
# Path to a custom home page. Users are only redirected to this if the default home dashboard is used. It should match a frontend route and contain a leading slash.
;home_page =
@@ -469,27 +424,6 @@
# Enter a comma-separated list of users login to hide them in the Grafana UI. These users are shown to Grafana admins and themselves.
; hidden_users =
[secretscan]
# Enable secretscan feature
;enabled = false
# Interval to check for token leaks
;interval = 5m
# base URL of the grafana token leak check service
;base_url = https://secret-scanning.grafana.net
# URL to send outgoing webhooks to in case of detection
;oncall_url =
# Whether to revoke the token if a leak is detected or just send a notification
;revoke = true
[service_accounts]
# Service account maximum expiration date in days.
# When set, Grafana will not allow the creation of tokens with expiry greater than this setting.
; token_expiration_day_limit =
[auth]
# Login cookie name
;login_cookie_name = grafana_session
@@ -517,14 +451,12 @@
# Set to true to attempt login with OAuth automatically, skipping the login screen.
# This setting is ignored if multiple OAuth providers are configured.
# Deprecated, use auto_login option for specific provider instead.
;oauth_auto_login = false
# OAuth state max age cookie duration in seconds. Defaults to 600 seconds.
;oauth_state_cookie_max_age = 600
# Skip forced assignment of OrgID 1 or 'auto_assign_org_id' for social logins
# Deprecated, use skip_org_role_sync option for specific provider instead.
;oauth_skip_org_role_update_sync = false
# limit of api_key seconds to live before expiration
@@ -539,12 +471,6 @@
# Set to true to enable Azure authentication option for HTTP-based datasources.
;azure_auth_enabled = false
# Set to skip the organization role from JWT login and use system's role assignment instead.
; skip_org_role_sync = false
# Use email lookup in addition to the unique ID provided by the IdP
#Enable the Unified Alerting sub-system and interface. When enabled we'll migrate all of your alert rules and notification channels to the new system. New alert rules will be created and your notification channels will be converted into an Alertmanager configuration. Previous data is preserved to enable backwards compatibility but new data is removed.```
@@ -958,26 +852,6 @@
# The interval string is a possibly signed sequence of decimal numbers, followed by a unit suffix (ms, s, m, h, d), e.g. 30s or 1m.
;alertmanager_config_poll_interval = 60s
# The redis server address that should be connected to.
;ha_redis_address =
# The username that should be used to authenticate with the redis server.
;ha_redis_username =
# The password that should be used to authenticate with the redis server.
;ha_redis_password =
# The redis database, by default it's 0.
;ha_redis_db =
# A prefix that is used for every key or channel that is created on the redis server
# as part of HA for alerting.
;ha_redis_prefix =
# The name of the cluster peer that will be used as identifier. If none is
# provided, a random one will be generated.
;ha_redis_peer_name =
# Listen address/hostname and port to receive unified alerting messages for other Grafana instances. The port is used for both TCP and UDP. It is assumed other Grafana instances are also running on the same port. The default value is `0.0.0.0:9094`.
;ha_listen_address = "0.0.0.0:9094"
@@ -1022,56 +896,6 @@
# For example: `disabled_labels=grafana_folder`
;disabled_labels =
[unified_alerting.state_history]
# Enable the state history functionality in Unified Alerting. The previous states of alert rules will be visible in panels and in the UI.
; enabled = true
# Select which pluggable state history backend to use. Either "annotations", "loki", or "multiple"
# "loki" writes state history to an external Loki instance. "multiple" allows history to be written to multiple backends at once.
# Defaults to "annotations".
; backend = "multiple"
# For "multiple" only.
# Indicates the main backend used to serve state history queries.
# Either "annotations" or "loki"
; primary = "loki"
# For "multiple" only.
# Comma-separated list of additional backends to write state history data to.
; secondaries = "annotations"
# For "loki" only.
# URL of the external Loki instance.
# Either "loki_remote_url", or both of "loki_remote_read_url" and "loki_remote_write_url" is required for the "loki" backend.
; loki_remote_url = "http://loki:3100"
# For "loki" only.
# URL of the external Loki's read path. To be used in configurations where Loki has separated read and write URLs.
# Either "loki_remote_url", or both of "loki_remote_read_url" and "loki_remote_write_url" is required for the "loki" backend.
| Proposed | The practice has been proposed and been positively received by the Grafana team. Following the proposal is a discretionary choice for developers. |
| Ongoing, active | The practice is actively being worked on. New code should adhere to the practice where at all possible. |
| Ongoing, passive | There is no immediate active work on refactoring old code. New code should adhere to the practice where at all possible. |
| Completed | The work has been done and there is no, or negligible, legacy code left that need refactoring. New code must adhere to the practice. |
| Abandoned | The practice has no longer any active ongoing work and new code don't need to comply with the practice described. |
## 1 - Idiomatic Grafana code should be idiomatic Go code
**Status:** Ongoing, passive.
It'll be easier for contributors to start contributing to Grafana if our
code is easily understandable. When there isn't a more specific Grafana
recommended practice, we recommend following the practices as put forth
by the Go project for development of Go code or the Go compiler itself
when applicable.
The first resource we recommend everyone developing Grafana's backend to
skim is "[Effective Go](https://golang.org/doc/effective_go.html)",
which isn't updated to reflect more recent changes since Go was
initially released but remain a good source for understanding the
general differences between Go and other languages.
Secondly, the guidelines for [Code Review Comments](https://github.com/golang/go/wiki/CodeReviewComments)
for the Go compiler can mostly be applied directly to the Grafana
codebase. There are idiosyncrasies in Grafana such as interfaces living
closer to its declaration than to its users for services and don't
enforce documentation of public declarations (prioritize high coverage
of documentation aimed at end-users over documenting internals in the
Global state makes testing and debugging software harder, and it's something we want to avoid when possible. Unfortunately, there is quite a lot of global state in Grafana.
We want to migrate away from this by using
[Wire](https://github.com/google/wire) and dependency injection to pack
## 101 - Limit the use of the init() function
**State:** Ongoing, passive.
Only use the init() function to register services/implementations.
## 102 - Settings refactoring
**State:** Ongoing, passive.
The plan is to move all settings to from package level vars in settings package to the [setting.Cfg](https://github.com/grafana/grafana/blob/df917663e6f358a076ed3daa9b199412e95c11f4/pkg/setting/setting.go#L210) struct. To access the settings, services and components can inject this setting.Cfg struct:
We want to migrate away from using GoConvey. Instead, we want to use
stdlib testing with [testify](https://github.com/stretchr/testify),
because it's the most common approach in the Go community, and we think
it will be easier for new contributors. Read more about how we want to
write tests in the [style guide](/contribute/backend/style-guide.md).
## 104 - Refactor SqlStore
**State:** Completed.
The `sqlstore` handlers all use a global xorm engine variable. Refactor them to use the `SqlStore` instance.
## 105 - Avoid global HTTP handler functions
**State:** Ongoing, passive.
Refactor HTTP handlers so that the handler methods are on the HttpServer instance or a more detailed handler struct. E.g (AuthHandler). This ensures they get access to HttpServer service dependencies (and Cfg object) and can avoid global state.
## 106 - Date comparison
**State:** Ongoing, passive.
Store newly introduced date columns in the database as epoch based
integers (i.e. unix timestamps) if they require date comparison. This
permits a unified approach for comparing dates against all the supported
databases instead of handling dates differently for each database. Also,
by comparing epoch based integers, we no longer need error pruning
transformations to and from other time zones.
## 107 - Avoid use of the simplejson package
**State:** Ongoing, passive
Use of the `simplejson` package (`pkg/components/simplejson`) in place
of types (Go structs) results in code that is difficult to maintain.
Instead, create types for objects and use the Go standard library's
**State:** Abandoned: Grafana's file based refactoring is limited to work natively only on on-premise installations of Grafana. We're looking at enhancing the use of the API to enable provisioning for all Grafana instances.
All new features that require state should be possible to configure using config files. For example:
Today it's only possible to provision data sources and dashboards but this is something we want to support all over Grafana.
### 109 - Use context.Context "everywhere"
**State:** Completed.
The package [context](https://golang.org/pkg/context/) should be used
and propagated through all the layers of the code. For example the
`context.Context` of an incoming API request should be propagated to any
other layers being used such as the bus, service and database layers.
Utility functions/methods normally doesn't need `context.Context`.
To follow Go best practices, any function/method that receives a
[`context.Context` argument should receive it as its first parameter](https://github.com/golang/go/wiki/CodeReviewComments#contexts).
To be able to solve certain problems and/or implement and support
certain features making sure that `context.Context` is passed down
through all layers of the code is vital. Being able to provide
contextual information for the full life-cycle of an API request allows
us to use contextual logging, provide contextual information about the
authenticated user, create multiple spans for a distributed trace of
service calls and database queries etc.
Code should use `context.TODO` when it's unclear which Context to use,
or it is not yet available (because the surrounding function has not yet
been extended to accept a `context.Context` argument).
More details in [Services](/contribute/backend/services.md), [Communication](/contribute/backend/communication.md) and [Database](/contribute/backend/database.md).
- [Go: Best Practices for Production Environments](http://peter.bourgon.org/go-in-production/#formatting-and-style)
## Linting and formatting
To ensure consistency across the Go codebase, we require all code to
pass a number of linter checks.
We use [GolangCI-Lint](https://github.com/golangci/golangci-lint) with a
custom configuration [.golangci.toml](/.golangci.toml) to run these
checks.
To run all linters, use the `lint-go` Makefile target:
```bash
make lint-go
```
## Testing
We value clean and readable code, that is loosely coupled and covered by unit tests. This makes it easier to collaborate and maintain the code.
Tests must use the standard library, `testing`. For assertions, prefer using [testify](https://github.com/stretchr/testify).
### Integration Tests
We run unit and integration tests separately, to help keep our CI pipeline running smoothly and provide a better developer experience.
To properly mark a test as being an integration test, you must format your test function definition as follows, with the function name starting with `TestIntegration` and the check for `testing.Short()`:
```
func TestIntegrationFoo(t *testing.T) {
if testing.Short() {
t.Skip("skipping integration test")
}
// function body
}
```
> Warning
> If you do not follow this convention, your integration test may be run twice or not run at all.
### Assertions
Use respectively [`assert.*`](https://github.com/stretchr/testify#assert-package) functions to make assertions that
should _not_ halt the test ("soft checks") and [`require.*`](https://github.com/stretchr/testify#require-package)
functions to make assertions that _should_ halt the test ("hard checks"). Typically you want to use the latter type of
check to assert that errors have or have not happened, since continuing the test after such an assertion fails is
chaotic (the system under test will be in an undefined state) and you'll often have segfaults in practice.
### Sub-tests
Use [`t.Run`](https://golang.org/pkg/testing/#T.Run) to group sub-test cases, since it allows common setup and teardown
code, plus lets you run each test case in isolation when debugging. Don't use `t.Run` to e.g. group assertions.
### Cleanup
Use [`t.Cleanup`](https://golang.org/pkg/testing/#T.Cleanup) to clean up resources in tests. It's a preferable to `defer`, as it can be called from helper functions. It will always execute after the test is over in reverse call order (last `t.Cleanup` first, same as `defer`).
### Mock
Optionally, we use [`mock.Mock`](https://github.com/stretchr/testify#mock-package) package to generate mocks. This is
useful when you expect different behaviours of the same function.
#### Tips
- Use `Once()` or `Times(n)` to make this mock only works `n` times.
- Use `mockedClass.AssertExpectations(t)` to guarantee that the mock is called the times asked.
- If any mock set is not called or its expects more calls, the test fails.
- You can pass `mock.Anything` as argument if you don't care about the argument passed.
- Use `mockedClass.AssertNotCalled(t, "FunctionName")` to assert that this test is not called.
#### Example
This is an example to easily create a mock of an interface.
As a general rule of thumb, avoid using global variables, since they make the code difficult to maintain and reason
about, and to write tests for. The Grafana codebase currently does use a lot of global variables, especially when
it comes to configuration, but that is a problem we're trying to solve.
## Pointers
In general, use value types and only reach for pointers when there's a real need. The reason being that pointers
increase the risk of bugs, since a pointer can be nil and dereferencing a nil pointer leads to a panic (AKA segfault).
Valid reasons to use a pointer include (but not necessarily limited to):
- You might need to pass a modifiable argument to a function
- Copying an object might incur a performance hit (benchmark to check your assumptions, copying is often faster than
allocating heap memory)
- You might _need_`nil` to tell if a variable isn't set, although usually it's better to use the type's zero
value to tell instead
## Database
In database related code, we follow certain patterns.
### Foreign keys
While they can be useful, we don't generally use foreign key constraints in Grafana, for historical and
technical reasons. See this [comment](https://github.com/grafana/grafana/issues/3269#issuecomment-383328548) by Torkel
for context.
### Unique columns
If a column, or column combination, should be unique, add a corresponding uniqueness constraint through a migration.
### Usage of XORM Session.Insert() and Session.InsertOne()
The [Session.Insert()](https://pkg.go.dev/github.com/go-xorm/xorm#Session.Insert) and [Session.InsertOne()](https://pkg.go.dev/github.com/go-xorm/xorm#Session.InsertOne) are poorly documented and return the number of affected rows contrary to a common mistake that they return the newly introduced primary key. Therefore, contributors should be extra cautious when using them.
The same applies for the respective [Engine.Insert()](https://pkg.go.dev/github.com/go-xorm/xorm#Engine.Insert) and [Engine.InsertOne()](https://pkg.go.dev/github.com/go-xorm/xorm#Engine.InsertOne)
## JSON
The simplejson package is used a lot throughout the backend codebase,
but it's legacy, so if at all possible avoid using it in new code.
Use [encoding/json](https://golang.org/pkg/encoding/json/) instead.
DisplayName:"Usage statistics",// display name for the collector in the UI
Description:"Usage statistics of the Grafana instance",// description for the collector in the UI
IncludedByDefault:false,// whether the collector is included by default in the support bundle and can't be deselected. Most times you want this to be false.
Default:false,// whether the collector is selected by default in the support bundle. User can still deselect it.
// Function that will actually collect the file during the support bundle generation.
@@ -154,7 +154,7 @@ A distributed trace is data that tracks an application request as it flows throu
### Usage
Grafana currently supports two tracing implementations, [OpenTelemetry](https://opentelemetry.io/) and [OpenTracing](https://opentracing.io/). OpenTracing is deprecated, but still supported until we remove it. The two different implementations implements the `Tracer` and `Span` interfaces, defined in the _pkg/infra/tracing_ package, which you can use to create traces and spans. To get a hold of a `Tracer` you would need to get it injected as dependency into your service, see [Services](services.md) for more details.
Grafana currently supports two tracing implementations, [OpenTelemetry](https://opentelemetry.io/) and [OpenTracing](https://opentracing.io/). OpenTracing is deprecated, but still supported until we remove it. The two different implementations implements the `Tracer` and `Span` interfaces, defined in the _pkg/infra/tracing_ package, which you can use to create traces and spans. To get a hold of a `Tracer` you would need to get it injected as dependency into your service, see [Services](../../architecture/backend/services.md) for more details.
Some files were not shown because too many files have changed in this diff
Show More
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.