* 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>
* Fix alerting relref anchor format
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Avoid ambiguous relref lookups by forcing relative resolution
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Remove reference to non-existent shared page
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Fix links broken in Grafana Cloud using absolute relrefs
By resolving the relref absolutely, it refers to the same location
regardless of mounted directory.
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Remove trailing slash for bundle independent resolution
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Fix typo
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* For now, avoid Hugo checking cross repository /docs/grafana-cloud link
The path is unlikely to change in the short term and this makes CI
completely green for now.
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* No need to specify path for in page anchors
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Fix prose
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
* Set correct products labels on Grafana Cloud and Enterprise pages
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Add cloud label to all alerting docs
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* 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
**What is this feature?**
Simply a documentation update.
**Why do we need this feature?**
Clarify the doc, so people don't waste time integrating the wrong key,
e.g. #8979, #9036, https://community.librenms.org/t/19013
**Who is this feature for?**
Developers doing a PagerDuty integration.
This adds provisioning endpoints for downloading alert rules and alert rule groups in a
format that is compatible with file provisioning. Each endpoint supports both json and
yaml response types via Accept header as well as a query parameter
download=true/false that will set Content-Disposition to recommend initiating a download
or inline display.
This also makes some package changes to keep structs with potential to drift closer
together. Eventually, other alerting file structs should also move into this new file
package, but the rest require some refactoring that is out of scope for this PR.
* Fix recording rules form steps not showing alert information
* Fix docs about creating cloud and recording rules
* Update docs with suggested changes
This commit renames "Message templates" to "Notification templates"
in the user interface as it suggests that these templates cannot
be used to template anything other than the message. However, message
templates are much more general and can be used to template other fields
too such as the subject of an email, or the title of a Slack message.
Docs: Clarify feature flag for Grafana Cloud
Images in Alerts requires a feature flag for hosted Grafana instances. This change directs users to contact Support for access to this feature.
This commit renames contact point type to integration in the user interface
as "New contact point type" suggests that you are creating a new type,
when instead you are just creating a new integration of a pre-determined type,
such as email or Slack. You can also have two or more integrations of the same
type, something which is not apparent from the current text.
This change will also make it easier to explain the difference between
a contact point integration, and how to configure an integration of a certain type,
such as email.
* 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 aliases from shared pages
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Rewrite all current latest aliases to be next
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Fix typo in latest alias
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 -Ez -i 's#\n((aliases:\n *-)|aliases:\n)#\n\2#' {} \;
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Prettier
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
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.
* refactors config panels and visualizations, corrects relrefs
* adds an alias
* Remove some old content
* moves visualizations topic to the root
* moves out panels and visualization topics to the root
* adds move and resize panel to add/organize panel; creates a create dashboard topic under build dashboards; adjusts context of add a panel to be from within an existing dashboard
* updates aliases
* creates search at root, moves dashboard preview to search, creates standalone search dashboard topic
* moves Set dashboard time range to use-dashboards, creates modify dashboard settings and adds moves Modify dashboard time settings to that topic
* moves existing query-options topic from working with panels to configure-panel-visualizations, moves panel time overrides and timeshift content to query options
* Moving things to better category, fixing links, improving ordering
* Move panel inspector to main panel topic
* completes partial fix of relrefs
* relref fixes con't
* restructures remaining panels topics
* more relref fixes
* Minor fix
* Minor tweak
* finishes fixing relrefs
Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Documentation: clarify label matching
Behaviour in case of multiple matchers is not documented, but my experiments show they are reduced using logical AND. Please validate the updated description.
* Accept wording suggestion
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Accept suggestion for docs/sources/alerting/fundamentals/annotation-label/labels-and-label-matchers.md
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Improve wording according to review suggestions
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Docs: adding setup, provisioning docs
* add set up, alertmanager
* Adds link to provisioning from set up page
* renames topics in set up section
* fixes alertmanager link
* removing article for alertmanager
* first connection to oncall
* updating armands intro text
* getting rid of blank line
* Alerting: Sanitize invalid label/annotation names for external alertmanagers
Grafana's built-in Alertmanager supports both Unicode label keys and values; however, if using an external
Prometheus Alertmanager label keys must be compatible with their data model.
This means label keys must only contain ASCII letters, numbers, as well as underscores and match the regex
`[a-zA-Z_][a-zA-Z0-9_]*`.
Any invalid characters will now be removed or replaced by the Grafana alerting engine before being sent to
the external Alertmanager according to the following rules:
- `Whitespace` will be removed.
- `ASCII characters` will be replaced with `_`.
- `All other characters` will be replaced with their lower-case hex representation.
* Prefix hex replacements with `0x`
* Refactor for clarity
* Apply suggestions from code review
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Documentation: Updated links to landing pages for the respective notifiers in alerting
Updated links for listed notifiers to correctly redirect to their landing pages
* Ran prettier
* Alerting: Add config disabled_labels to disable reserved labels
[unified_alerting.reserved_labels]
disabled_labels
* Replace IsGrafanaFolderDisabled with more generic IsReservedLabelDisabled
* Simplify SchedulerCfg by including UnifiedAlertingSettings
* Docs: new version of landing page for Alerting
* deletes about topic and adds alias
* Update docs/sources/alerting/_index.md
Co-authored-by: Gilles De Mey <gilles.de.mey@gmail.com>
Co-authored-by: Gilles De Mey <gilles.de.mey@gmail.com>
Because some contact points only support a single image, and the order
of alerts sent to a contact point is not guaranteed, which alert rule's
image is attached to a notification can change from alert to alert. This
documents that behavior.
* Alerting: Add first Grafana reserved label g_label
g_label holds the title of the folder container the alert. The intention of this label
is to use it as part of the new default notification policy groupBy.
* Add nil check on updateRule labels map
* Disable gocyclo lint on schedule.ruleRoutine
will remove later in a separate refactoring PR to reduce complexity.
* Address doc suggestions
* Update g_folder for rules in folder when folder title changes
* Remove global bus in FolderService
* Modify tests to fit new common g_folder label
* Add changelog entry
* Fix merge conflicts
* Switch GrafanaReservedLabelPrefix from `g_` to `grafana_`
* Move data source management to administration
* Move RBAC to administration
* Move team management up a docs org level
* Combine and rename admin preferences docs
* Move plugin management to administration
* Combine plugin management docs
* Combine API key docs
* Combine service account docs
* Combine server user management docs
* Move datasource management to administration
* Move enterprise licenses to administration
* Move CLI out of admin, update links to admin
* Merge org user management docs
* Restructure to Torkel's plan
* Fix typo
* Weigh admin topics for navigation
* Weigh administration topics and align to Torkel's plan
* Move server user management from server admin to admin/user management
* Move configure docker image to setup guide
* Move the remaining server admin docs to the root admin directory
* Reweight docker config
Co-authored-by: Brenda Muir <brenda.muir@grafana.com>
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Brenda Muir <brenda.muir@grafana.com>
* builds out refactored setup topics
* Automatically fix some relrefs with mv-manager
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Use refs for tutorials content which is outside of this repository
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Manually fix complicated relrefs
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* consolidates team sync and db encryption topics
* Fix relrefs
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* updates setup index file
* Convert TOML to YAML
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Add current alias for new alerting content
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Add current aliases to new setup-grafana and configure-security pages
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Update docs/sources/setup-grafana/configure-grafana/_index.md
Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
* moves saml docs, updates order in TOC
* Manually fix relrefs
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* added usage insights topics, adjusted weights
* corrected relrefs
* Fix relrefs broken in rebase
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Torkel Ödegaard <torkel@grafana.com>
This change adds documentation about how the configuration of Grafana
Alerting affects the performance of the Grafana backend, and how to
control the load that Grafana Alerting generates.
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Lots of changes, including new topic, also fixed all alerting relrefs
* Push stashed change.
* Updated content to reflect that Grafana alerting is enabled during upgrade.
* Fix typo
* Update docs/sources/alerting/migrating-alerts/_index.md
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
* Checkin changes.
* Updates from Chris's review.
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
* Moved annotation and labels topic to fundamentals and added label matching to the same section
* Cosmetic updates to "How label matching works topic"
* Few more changes to annotations and label section. Also added stem sentence to silences topics.
* Fixed one more broken relref.
* Update docs/sources/alerting/fundamentals/_index.md
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
* Add aliases to all files
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Prettify front matter
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Remove What's new reference.
* Moved messaging templates to under contact points. fixed broken relrefs.
* Fixed some more reflrefs
* Fixed a few more broken relrefs and adjusted weight
* Initial commit
* Moved files, ad fixed broken relrefs.
* Fixed other broken relrefs
* More changes.
* Fixing broken relrefs
* More changes.
* Fixed last of the broken links
* More re-org.
* Added aliases and some weight adjustments
* More aliases.
* Fix fundamentals topic.
* Fixed remaining metadata issues
* Ran prettier
* make clear that the two templates work in conjunction
* PR review changes
* Update docs/sources/alerting/unified-alerting/message-templating/_index.md
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
* Update docs/sources/alerting/unified-alerting/message-templating/_index.md
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
* make numbered steps
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
* Initial commit
* Added some refinement to the alerting HA topics.
* Update docs/sources/administration/set-up-for-high-availability.md
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
* Updates from Chris's review. Also fixed a couple of broken relrefs
* Ran prettier
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
* OK notifications using previous evaluation data
* copy rule.EvalMatches to avoid changes to the underlying array
* test cases added/modified
* delete trailing newline
* fix double newline in go import
* add change to the changelog
* specify that this only affects legacy alerting (changelog)
* use current eval data instead of prev eval data
* create evalMatch just once
* code comments, renamings, getTemplateMatches() function
* changelog and docs updated
* wip: add form inputs for creating mute timing
* form for mute timings
* add action for submitting config
* fix bug in payload
* add table for viewing mute timings
* remove mute timing from routes when deleted
* attach mute timing to route
* edit a mute timing
* use field array for multiple intervals
* Add confirmation modal for deleting mute timing
* add default values to form inputs
* fetch am config prior to renderring form
* validation for mute timing fields
* fix tests
* tests for mute timing form
* small ui fixes for the form and table
* pass mute name as query param
* make time fields inline
* fix validation for an existing alert and overwrite on edit
* rename mute timing in routes on edit
* fix validation for time inputs
* make time interval its own component
* add descriptions for mute timings
* refactor time interval parsing functions
* fix linting and tests
* refactor makeAmLink
* docs for mute timings
* reorganize docs and add intro for mute timings
* doc review edits
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
* run prettier
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
* Replaced "Grafana 8 alerting" with "Grafana alerting". Added support matrix for Grafana alerting.
* Few more changes and added deprecation notice to legacy alerting landing page.
* Added more content from Yuri's PR.
* Ran prettier.
* Added code review changes.
* One more change.
* Fixed linked texts.
* Alerting: Update docs on using the Prometheus Datasource with the Ruler
* Update docs/sources/alerting/unified-alerting/alerting-rules/create-cortex-loki-managed-rule.md
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
* Support custom annotations and labels when testing contact points
* Add modal for testing contact point
* add option for custom notification type
* use annotation and labels fields from rule editor
* update receivers test for new contact point testing method
* rename modal and remove reserved keys for annotations
* add docs for testing contact points
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
Co-authored-by: George Robinson <george.robinson@grafana.com>
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
* Added an option to discord notifier to use discord's webhook name (useful for customizing notifications).
* Support ngalert system with discord username toggle
* Added ngalert discord test
* Apply suggestions from code review
Co-authored-by: gotjosh <josue.abreu@gmail.com>
* Docs updated with discord username setting
* Fix api integration test
Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
Co-authored-by: gotjosh <josue.abreu@gmail.com>
* Alerting: (wip) add template funcs
* Alerting: (wip) numeric template functions
* Alerting: (wip) template functions
* Test for the "args" function
* Alerting: (wip) Documentation for template functions
* Alerting: template functions - refactor
* code review changes
* disable linter error
* Use Prometheus implementation of TemplateExpander
* Update docs/sources/alerting/unified-alerting/alerting-rules/create-grafana-managed-rule.md
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
* change templateCaptureValue to support using template functions
* Update pkg/services/ngalert/state/template.go
Co-authored-by: gotjosh <josue.abreu@gmail.com>
* Test and documentation added for reReplaceAll template function
* complete missing functions, documentation and tests
* Use the alert instance's evaluation time for expanding the template
* strvalue graphlink and tablelink functions
* delete duplicate test
* make strvalue return an empty string
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
Co-authored-by: gotjosh <josue.abreu@gmail.com>
* Pipeline: Add wait prop into pa11y configuration for all the pages
* Pa11y: Use e2e instance to generate html report local environment
* Pipeline: use pa11y-ci hash commit
* Pipeline: Update Pa11y thresholds
* Update package.json
* Update yarn.lock
Co-authored-by: Leon Sorokin <leeoniya@gmail.com>
* Update silences.md
minor correction in not equals regex
* Update docs/sources/alerting/unified-alerting/silences.md
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
* Alerting: Persist notification log and silences to the database
This removes the dependency of having persistent disk to run grafana alerting. Instead of regularly flushing the notification log and silences to disk we now flush the binary content of those files to the database encoded as a base64 string.
* convert SQLs to use sdk contracts
* make draft
* postgres
* intermedia
* get datasourceinfo filled at the beginning of the service
* move the interval into package because of cyclict import and fix all postgres tests
* fix mysql test
* fix mssql
* fix the test for pr https://github.com/grafana/grafana/issues/35839
* fix some issue about intervalv2 package
* update sql test
* wire migration for SQLs
* add sqls to the background process
* make it register instead of register and start
* revert formatting
* fix tests
* fix linter
* remove integration test
* Postgres test fix
Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
* Removed an unecessary webhook listing and modified some text to reduce promotion for specific tooling.
* Updated doc content with Eve and Ursula's review.
* Removed "the".
Co-authored-by: achatterjee-grafana <aparajita.chatterjee@grafana.com>
* Additional fix: Resized two images in 8.1 what's new to make them smaller
* Fixed some broken links and deleted another empty Grafana 8 alert topic.
* Replaced reference to troubleshooting with state and health check.
* Add filter parsing to rule list filters
* Add unit tests for label parsing
* Make label operators an enum
* add example for parsing function
* Update labels operator regex
* Add tests to rule list for filtering
* add additional test for testing alert instances filtering
* Use tooltip for query syntax example
* refactor to use Matchers for filtering
* Update docs for label filtering on rules list
* style fixes
* Expand the value of math and reduce expressions in annotations and labels
This commit makes it possible to use the values of reduce and math
expressions in annotations and labels via their RefIDs. It uses the
Stringer interface to ensure that "{{ $values.A }}" still prints the
value in decimal format while also making the labels for each RefID
available with "{{ $values.A.Labels }}" and the float64 value with
"{{ $values.A.Value }}"
Jack Baldry
George Robinson
brendamuir
Gilles De Mey
Matt Dodson
Santiago
Sonia Aguilar
ismail simsek
Andre Miras
Matthew Jacobson
Armand Grillet
Alex Moreno
gotjosh
Ryan Cole
melGL
Karen Germond
Christopher Moyer
Alex Pakalniskis
Labesse Kévin
Daniel Lee
Yuriy Tseretyan
Vladimir
Martin Lehmann
ceh
Eve Meelan
Robin Tönniges
Med Amine Amara
sunb3am
Garrett Guillotte
Joe Blubaugh
JitaC
Karl Persson
Atrbear
Jens Oliver Meiert
juschm
Alexander Weaver
Andreas Fitzek
Nathan Rodman
Torkel Ödegaard
David Parrott
smallpath
Jean-Philippe Quéméner
gotjosh
Peter Holmberg
Alexandre de Verteuil
Skye
Ursula Kallio
Anne E. Ulrich
Sofia Papagiannaki
Maria Alexandra
Agnès Toulet
Andrew Burian
Michael Kopinsky
Yuriy Tseretyan
ying-jeanne
Domas
Kyle Brandt
Petros Kolyvas
Dominik Eckelmann
Connor Lindsey
George Robinson
Dan Cech
Ganesh Vernekar
Dawnpool
Nolan Crooks