* Use fixed `/docs/grafana-cloud/alerting-and-irm` URLs for cloud references
* Fix `docs/grafana-cloud/` data sources links
* Fix `docs/grafana-cloud/` Panel & Visualization links
* Fix `/docs/grafana-cloud/` link to Dashboard page
* Set root directory `docs/reference` for non-cloud pages
* Fix `admonition` cannot use a `docs/reference` relative link
* Update `doc-validator`
https://github.com/grafana/technical-documentation/releases/tag/doc-validator%2Fv4.1.0
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Alerting: Remove start page of upgrade preview
Alerting upgrade page will now always show the summary table even before
upgrading any alerts or notification channels. There a few reasons for this:
- The information on the start page is redundant as it's now contained in the
documentation.
- Previously, if some unexpected issue prevented performing a full upgrade, a
user would have limited to no means to using the preview tool to help fix the
problem. This is because you could not see the summary table until the full
upgrade was performed at least once. Now, you can upgrade individual alerts and
notification channels from the beginning.
* Special alerts for NoData and Error
To avoid confusion why there is no additional label added when setting `Alerting` or `OK` in the No Data and Error handling
* ran prettier
---------
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* Alerting: Add clean_upgrade config and deprecate force_migration
Upgrading to UA and rolling back will no longer delete any data by default.
Instead, each set of tables will remain unchanged when switching between
legacy and UA. As such, the force_migration config has been deprecated
and no extra configuration is required to roll back to legacy anymore.
If clean_upgrade is set to true when upgrading from legacy alerting to Unified
Alerting, grafana will first delete all existing Unified Alerting resources,
thus re-upgrading all organizations from scratch. If false or unset,
organizations that have previously upgraded will not lose their existing Unified
Alerting data when switching between legacy and Unified Alerting.
Similar to force_migration, it should be kept false when not needed as it may
cause unintended data-loss if left enabled.
---------
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
* Docs: adds info on location for mute timings
* ran prettier
* Update docs/sources/alerting/manage-notifications/mute-timings.md
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
* Update docs/sources/alerting/manage-notifications/mute-timings.md
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
* Adds note on not being able to retrieve alerting resources once deleted
---------
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
* Updated links in what's new 10.2 and what's new next
* Attempted to add alias
* Fix alias
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Alerting docs: adds and reworks contact points content
* gh cli to get build to work
* contact point docs rework
* fixes canonicals with new folder name
* adds integrations to index md
* deletes pagerduty anchor
* ran prettier
* updates mute timing section with redesign
* Updates alert rules with menu paths and export features
* updates menu paths on notification templates tab
* updates notification policy with new redesign menu paths
* updates time interval tag
* ran prettier
* corrects typo
The previous version of this page I wrote with the expectation that
readers would first learn the templating language and then write
their templates. This doesn't seem to have worked out as well as I
had expected, and so I've rewritten the documentation to explain
the language using relevant and useful examples instead.
* Update _index.md
* Update _index.md
Run through Prettier
* Update _index.md
ran Prettier again
* Prettier
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Alerting docs: fixes next and latest link errors
* fixes bracket
* more link fixes
* fixes numbering
* prettier
* Fix build errors, a broken link, and use more appropriate destination for Grafana Cloud OnCall links
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* fixes for jacks feedback
* fixes note
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Add comments to indicate which page I believe each alias is intending to redirect
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Remove difference-old-new redirect from migrating-alerts page since an alternative page exists
The alternative page is `docs/sources/alerting/difference-old-new.md`.
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Add comment to show intended absolute path redirect
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Remove `unified-alerting/difference-old-new/` redirect because it already exists in `docs/sources/alerting/difference-old-new.md`.
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Remove `unified-alerting/` alias since the absolute URL already redirects to `/docs/grafana/latest/alerting/`
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Fix `/docs/grafana/<GRAFANA VERSION>/alerting/migrating-alerts/` redirect
The following example uses `latest` as _`GRAFANA VERSION`_ for simplicity and readability.
The desire is the following redirect:
```
src: /docs/grafana/latest/alerting/migrating-alerts/
dst: /docs/grafana/latest/alerting/set-up/migrating-alerts/
```
`dst` is the Hugo pretty URL for the current page (`docs/sources/alerting/set-up/migrating-alerts/_index.md`).
When constructing Hugo aliases we are working from the page's containing directory and not the page itself.
The path element `.` represents that directory.
For example:
```
page: /docs/grafana/latest/alerting/set-up/migrating-alerts/
alias: ./
dst: /docs/grafana/latest/alerting/set-up/
```
The path element `..` represents the parent directory of the page's containing directory.
For example:
```
page: /docs/grafana/latest/alerting/set-up/migrating-alerts/
alias: ../
dst: /docs/grafana/latest/alerting/
```
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Add datasources link for Grafana Cloud
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Use inferred labels to reduce typing
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Page has been moved to the website repository
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Update .codespellignore to ignore 'Operator Windrose' and fix typo
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Alerting docs: adds oncall integration docs and release note
* adds oncall integ to structure
* corrects link
* updates links
* Update docs/sources/alerting/monitor/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* updates metamonitoring link
* update to product name
* Update docs/sources/alerting/alerting-rules/manage-contact-points/configure-oncall.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Update docs/sources/alerting/alerting-rules/manage-contact-points/configure-oncall.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Modify reference links to ensure that `doc-validator` ignores them
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* breaks up sentence
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Docs alerting: adds insights logs and updates metamonitoring topic
* updates meta monitoring
* Update docs/sources/alerting/monitor/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Update docs/sources/alerting/monitor/meta-monitoring/_index.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* removes alias
* Update docs/sources/alerting/monitor/meta-monitoring/_index.md
Co-authored-by: Jennifer Villa <jvilla2013@gmail.com>
* Update docs/sources/alerting/monitor/meta-monitoring/_index.md
Co-authored-by: Jennifer Villa <jvilla2013@gmail.com>
* Update docs/sources/alerting/monitor/meta-monitoring/_index.md
Co-authored-by: Jennifer Villa <jvilla2013@gmail.com>
* Update docs/sources/alerting/monitor/meta-monitoring/_index.md
Co-authored-by: Jennifer Villa <jvilla2013@gmail.com>
* updates numbering
* adds codeblock
* updates
* Update docs/sources/alerting/monitor/meta-monitoring/_index.md
Co-authored-by: George Robinson <george.robinson@grafana.com>
* Update docs/sources/alerting/monitor/meta-monitoring/_index.md
Co-authored-by: George Robinson <george.robinson@grafana.com>
---------
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Jennifer Villa <jvilla2013@gmail.com>
Co-authored-by: George Robinson <george.robinson@grafana.com>
* Alerting docs: link fixes and a note for expressions
* changes format of note
* fixes extra space
* Update docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* update prometheus link
---------
Co-authored-by: Jack Baldry <jack.baldry@grafana.com>
* Fix different broken links and missing pages
* Pin version in docs link for release announcements
* fixing validator error
---------
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
* Set every page to have defaults of 'Enterprise' and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration pages to have of 'Cloud', 'Enterprise', and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/enterprise-licensing pages to have 'Enterprise' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/organization-management pages to have 'Enterprise' and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/provisioning pages to have 'Enterprise' and 'Open source' labels
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/recorded-queries pages to have labels cloud,enterprise
* Set administration/roles-and-permissions/access-control pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set administration/stats-and-license pages to have labels cloud,enterprise
* Set alerting pages to have labels cloud,enterprise,oss
* Set breaking-changes pages to have labels cloud,enterprise,oss
* Set dashboards pages to have labels cloud,enterprise,oss
* Set datasources pages to have labels cloud,enterprise,oss
* Set explore pages to have labels cloud,enterprise,oss
* Set fundamentals pages to have labels cloud,enterprise,oss
* Set introduction/grafana-cloud pages to have labels cloud
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Fix introduction pages products
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set panels-visualizations pages to have labels cloud,enterprise,oss
* Set release-notes pages to have labels cloud,enterprise,oss
* Set search pages to have labels cloud,enterprise,oss
* Set setup-grafana/configure-security/audit-grafana pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set setup-grafana/configure-security/configure-authentication pages to have labels cloud,enterprise,oss
* Set setup-grafana/configure-security/configure-authentication/enhanced-ldap pages to have labels cloud,enterprise
* Set setup-grafana/configure-security/configure-authentication/saml pages to have labels cloud,enterprise
* Set setup-grafana/configure-security/configure-database-encryption/encrypt-secrets-using-hashicorp-key-vault pages to have labels cloud,enterprise
* Set setup-grafana/configure-security/configure-request-security pages to have labels cloud,enterprise,oss
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set setup-grafana/configure-security/configure-team-sync pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set setup-grafana/configure-security/export-logs pages to have labels cloud,enterprise
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Set troubleshooting pages to have labels cloud,enterprise,oss
* Set whatsnew pages to have labels cloud,enterprise,oss
* Apply updated labels from review
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
* Provisioning landing page
* Move editing bit to view page
* Specify API vs File, and provide terraform example
* Improvements around notif policies
* Docs around contact points
* Use h2 instead of h1
* Address feedback
* Move text about policy granularity
* Alerting: No longer silence paused alerts during legacy migration
Now that we migrate paused legacy alerts to paused UA alert rules, we no longer need to silence them.
* Replace all alerting links with docs/reference style links
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Fix broken docs/reference style link
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Update all alerting links to go to Grafana Cloud resources when the page is published in Grafana Cloud
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Prettier
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Replace another link
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Docs: adds evaluation doc
* Adds note on classic condition
* fixes link
* fixes link
* fixes link
* fixes data source
* link fix
* fixes rbac link
* adds aliases
* Update cascading front matter to use sequence form
The map form does not override the sequence form that is used in the website repository to specify the default labels.
For more information, refer to https://github.com/grafana/writers-toolkit/pull/234.
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Remove useless alias
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Update labels for pages noted in code review
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Move all product labeling to the project index file
All changes can be made in a single place.
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Move all individual page product labels to project index file
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Shorten YAML
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Add newlines to aid readability
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Document front matter ordering
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Rewrite labels for breaking-changes pages
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* updated labels for whats new and breaking changes
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: Isabel <76437239+imatwawana@users.noreply.github.com>
* Enable doc-validator for alerting directories
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Adds missing description frontmatter
* Fix some more links
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Fix some more links
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
* Fixes anchors
---------
Signed-off-by: Jack Baldry <jack.baldry@grafana.com>
Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
* adds stale alert note
* Update docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md
Co-authored-by: Alexander Weaver <weaver.alex.d@gmail.com>
* alex feedback
---------
Co-authored-by: Alexander Weaver <weaver.alex.d@gmail.com>
* nav related notes for videos
* wording edit
Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
* wording edits
Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
---------
Co-authored-by: Eve Meelan <81647476+Eve832@users.noreply.github.com>
* Alerting: Respect "For" Duration for NoData alerts
This change modifies `resultNoData` to be more inline with the logic of the other state handlers.
The main effects of this are:
1) NoData states with NoDataState config set to Alerting will respect "For" duration.
2) Prevents zero value in StartsAt and EndsAt for alerts that have only even been in normal state. This includes state transitions from NoDataState=OK and ExecErrState=OK.
3) Better state transition logging.
* Alerting: Add CustomDetails for PagerDuty
* fix default value for 'severity' from 'error' to 'critical'
* minimal docs for notifiers, specifying config for PagerDuty
* replace notifier -> integration
* replace notifier -> integration
* navigation related updates - text only
* navigation related updates
* navigation related text updates
* navigation related text updates
* navigation related text and image updates
* 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