* Docs: export dashboard as PDF
* Update docs/sources/enterprise/_index.md
Co-Authored-By: Leonard Gram <leo@xlson.com>
Co-authored-by: Leonard Gram <leo@xlson.com>
line 31 : makes user a superadmin : multiple use of 'a' can be avoided for better reading
line 35: User can belong to : remove 'be' it is incorrect
line 51: allow you : typo correction
* correcting line 15
one typo needs correction
* Update docs/sources/permissions/organization_roles.md
Co-Authored-By: Peter Holmberg <peterholmberg@users.noreply.github.com>
Co-authored-by: Peter Holmberg <peterholmberg@users.noreply.github.com>
* Fix property descriptions, add missing properties
Fixes incorrect property descriptions, adds missing properties, and adds an up-to-date example.
* Update logo descriptions
Updates the "large" and "small" logo descriptions to specify SVG image type requirement, and that they may be identical
* Update docs/sources/plugins/developing/plugin.json.md
* Add fallback to search_base_dns if group_search_base_dns is undefined.
refs: #20862
* removed newline to make lint-go happy
* Added requested changes on ldap.md for last commit
Refs: #21263
This feature would provide a way for administrators to limit the minimum
dashboard refresh interval globally.
Filters out the refresh intervals available in the time picker that are lower
than the set minimum refresh interval in the configuration .ini file
Adds the minimum refresh interval as available in the time picker.
If the user tries to enter a refresh interval that is lower than the minimum
in the URL, defaults to the minimum interval.
When trying to update the JSON via the API, rejects the update if the
dashboard's refresh interval is lower than the minimum.
When trying to update a dashboard via provisioning having a lower
refresh interval than the minimum, defaults to the minimum interval
and logs a warning.
Fixes#3356
Co-authored-by: Marcus Efraimsson <marcus.efraimsson@gmail.com>
* Specify usage of datasource whitelist
Added a sentence explaining the data_source_proxy_whitelist property does not have any effect on pgsql mssql and mysql.
Co-Authored-By: Arve Knudsen <arve.knudsen@gmail.com>
Co-Authored-By: Marcus Efraimsson <marcus.efraimsson@gmail.com>
* trying out api-extractor.
* works with our setup of build.
* wip.
* changed the packages so it works better with the api-extractor.
* Changes to make the api-extractor to work.
* cleaned up the api-extractor config files.
* added some more documentation.
* added tsdoc-metadata to gitignore.
* removed the generated docs (will do that in another PR).
* added execute permission to script for generating dosc.
* added so we will push generated docs to branch.
* will clean packages_api on abort.
* Fixed failing tests.
* fixed formatting issue with typedoc comment.
* temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved
* temporary enabled bable namespaces.
* updated build script.
* updated script.
* updated script with some colors.
* changed to camelCase.
* removed spacing.
* Starting to add documentation guidelines.
* added examples headline.
* added menu options.
* added parameters and return values.
* Fixed merge error.
* Added first version of auto-generated docs.
* changed so we use the eslint ignore syntax.
* changed to correct eslint ingnore comment.
* fixed some spelling errors reported by codespell.
* added script to generate docs in current folder.
* updated api docs.
* lerna bootstrap.
* added eror to the ingore words list.
* removed file that should be ignored.
* updated locKFILE.
* referenced the code comments guidelines.
* updated packages.
* updated deps.
* updated the autogenerated dosc.
* adding missing new line.
* Docs: Add info on active LDAP sync
* Update docs/sources/enterprise/enhanced_ldap.md
Co-Authored-By: Leonard Gram <leo@xlson.com>
* Docs: remove usage of "he" in LDAP sync
Co-authored-by: Leonard Gram <leo@xlson.com>
* Suggesting couple of changes to the document
Line 15 should be modified to use your application instead of an application, same way it is being used in other auth docs.
typo in line 76, can is repeated twice . Correcting that typo
* Update docs/sources/auth/gitlab.md
Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
* Update gitlab.md
Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
* Correcting Line 22
Menu drop down is correct description for the control , rather than the menu that drops down
* Update docs/sources/auth/google.md
Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
* Update docs/sources/auth/google.md
Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
* Couple of changes to the document
Correcting a typo in line 53
Line 226 should be re-written as "To easily configure"
* Update docs/sources/auth/generic-oauth.md
Co-Authored-By: Arve Knudsen <arve.knudsen@gmail.com>
Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
* Update timeseries.md
Update to docs-imagebox for the image link.
* Update docs/sources/guides/timeseries.md
Co-Authored-By: Marcus Olsson <olsson.e.marcus@gmail.com>
Co-authored-by: Marcus Olsson <accounts+github@marcus.se.net>
* Suggesting few changes to the doc
1. Note should be followed by a dot (.)
2. Correcting a typo in default
3. Re-writing sub sentence to make reading better
* Update docs/sources/installation/configuration.md
Co-Authored-By: Arve Knudsen <arve.knudsen@gmail.com>
* Update configuration.md
Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
Idea is to provide information to the user that query can be executed on any data source that is available in grafana, therefore suggested little modification
* Implement Azure AD oauth
* Use go-jose and cleanup
* Update go-jose in go.mod
* cleanup
* Add unit tests
* Fix scopes
* Add documentation page
* Improve documentation
* Convert extract_role into function.
* Do not use upn and replace unique_name with preferred_username
* Configure login button
* Use official microsoft icon and color from branding guideline.
* Add Azure AD config section in sample.ini.
* Docs: add LDAP active sync limitation for single bind
* Docs: update header for LDAP active sync limitation
Co-Authored-By: Leonard Gram <leo@xlson.com>
* Make $__range more precise in Prometheus
It is now always equivalent to `${__range_s}s`, rather than rounding
down to an integer multiple of the biggest possible unit. For example,
a range of 47 hours is now represented as `169200s` rather than `1d`.
Closes#21689.
* Update a unit test to match new __range calc
One has to use "grafana/grafana" image - only using "grafana" will
result in an error message like this:
Error response from daemon: pull access denied for grafana, repository does not exist or may require 'docker login'
It's a good idea to daemonize new container. The install instructions
for Docker do this, and this instructions assume that running container
already is daemonized (otherwise you wouldn't have to stop it).
Best practise would be to create a new container, then stop old one and
start new one - this would reduce downtime. To keep instructions simple
and understandable, I didn't include that.
* Add new global built-in variables #20523
new branch from master
* #20523 Revert change on __from and __to like requested
* #20523 simplify contextSrv access
* #20523 simplify contextSrv access
* #20523 repair jest tests
* Docs: Add information about license expiration
* Docs: Improve clarity of license expiration page
* review comments
* change renewal instructions to a list
* language improvements
* review fixes
This is a small documentation update for the situation that led to
#19842 in the first place. It describes a procedure required to
provide root certificates to the headless Chrome instance used
by the Grafana image renderer plugin.
* Replace bash/json with http in http_api codeblocks
Since http is used elsewhere on the API docs and makes the
markdown rendering look different on the blocks that use bash/json
* Fix the annotations API link on 'Features'
- Noticed the Features/Dashboard Features/Annotations link pointing to
the HTTP API was linking itself instead of '../http_api/annotations.md'.
- Also add a link on Dashboard Export and Import to its HTTP API.
* Add missing links to features in API Index
Noticed there was 3 missing references in the API docs index.
- https://grafana.com/docs/grafana/latest/http_api/playlist
- https://grafana.com/docs/grafana/latest/http_api/datasource_permissions
- https://grafana.com/docs/grafana/latest/http_api/external_group_sync
Last two are Grafana Enterprise -only, so created a separate subsection
for them.
* Add info about meta data labels
* Add part about auto period calculations in cloudwatch
* Minor adjustments
* Updates after feedback
* Add more context
* Clarify what a metadata label is
* Docs: gitlab team-sync documented correctly
* docs: initial docs for whitelabeling
* Docs: enterprise repositories
* Docs: rpm enterprise install
* Docs: re-structured the rpm install page to be more similar to the deb page
* Docs: responded to review feedback
* Docs: recommends the enterprise edition
* Update docs/sources/installation/debian.md
Add support for passing tags to Pagerduty and allow notification
on specific event categories such as Class, Group and Component.
Ref #19912, #19913
Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
* Docs: Whats new updates
* Add cloudwatch and stackdriver paragraphs
* Minor changes
* Add link helper to render gif
* Docs: what's new updates
Co-authored-by: Erik Sundell <erik.sundell87@gmail.com>
* Update mac.md
Reviewed and edited macOS install instructions.
* Updated mac.md and configuration.md
Removed developer build instructions from mac.md and moved configuration information from mac.md to configuration.md.
* Update mac.md
Updated to reflect the new fields on the Downloads page
* Update mac.md
* Update mac.md
Breaking change: If disabled the cookie samesite cookie attribute
will not be set, but if none the attribute will be set and is a
breaking change compared to before where none did not render the
attribute. This was due to a known issue in Safari.
Co-Authored-By: Arve Knudsen <arve.knudsen@gmail.com>
Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
Fixes#19847
* add min_interval_seconds setting to alerting config
It will let operator enforce a minimum time for the scheduler to enqueue evaluations
* Introduce UI modifications
* Update docs
Co-authored-by: Martin <uepoch@users.noreply.github.com>
* Update rpm.md
* Update rpm.md
* Moved content to troubleshooting
Updated rpm.md and moved content from rpm.md to troubleshooting.md
* Update rpm.md
* Update rpm.md
* Update rpm.md
* Update rpm.md
* Update rpm.md
* Update rpm.md
* Update rpm.md
* Update docs/sources/installation/rpm.md
Co-Authored-By: Dan Cech <dcech@grafana.com>
* Update docs/sources/installation/rpm.md
Co-Authored-By: Dan Cech <dcech@grafana.com>
Co-authored-by: Dan Cech <dan@aussiedan.com>
OpsGenie's model works heavily off of the priority of an alert,
e.g. routing and escalation. Currently this plugin only supports
the default "P3".
Setting a tag og_priority to the correct P-value, e.g. P1, P2, P3,
P4 or P5, will call the OpsGenie API with the correct priority value
set.
* Update plugin docs
* Updated plugins installation documentation
Moved all Grafana CLI commands into cli.md, moved API script into user.md, rewrote installation.md as an actual task that refers the user to the plugins installation page
* Update cli.md
* Update cli.md
* Update docs/sources/administration/cli.md
Co-Authored-By: Dan Cech <dcech@grafana.com>
* Update docs/sources/administration/cli.md
Co-Authored-By: Dan Cech <dcech@grafana.com>
* Update docs/sources/http_api/user.md
Co-Authored-By: Dan Cech <dcech@grafana.com>
* Update docs/sources/http_api/user.md
Co-Authored-By: Dan Cech <dcech@grafana.com>
* Update cli.md
* Fixed links
* Update cli.md
* Update cli.md
* Update cli.md
* Update cli.md
Co-authored-by: Dan Cech <dan@aussiedan.com>
* Docs: Update debian.md
Simplified the APT install instructions by bundling the commands into one block, added steps in the .deb instructions to refer to new fields on the installation page.
* Update debian.md
* Update debian.md
* Update debian.md
* Update debian.md
* Update debian.md
* Update debian.md
Besides minor language corrections, this tries in particular to
provide some clarity about the `step` setting in the Prometheus range
query and the `$__interval` variable:
- First of all: They are both always the same.
- What's really confusing (and arguably really un-helpful) is that the
_Min time interval_ is multiplied by the resolution
factor. Therefore, I just state the fact here now but don't add
anything like "This should be the scrape interval" because it is not
true (if resolution is `1/10`, a meaningful _Min time interval_ is
generally a tenth of the scrape interval).
- More helpful is the _Min step_ parameter, because it is not
multiplied by the resolution factor (which I have now stated
explicitly). Of course, the _Min time interval_ has to be set to
something small so that the _Min step_ parameter can kick in.
It would be good if we could also override the _Min time interval_
tool tip because that is where most people will look, and the current,
very Graphite-centric tool tip is very confusing for the Prometheus
query editor, in particular because it doesn't have any hint about the
resolution factor being applied. See #21413.
Signed-off-by: beorn7 <beorn@grafana.com>
I standardized the readme for `sudo` and removed the `$`.
Now you can copy paste the commands and just "install" via the rpm
based distros.
Signed-off-by: JJ Asghar <jjasghar@gmail.com>
Signed-off-by: JJ Asghar <awesome@ibm.com>
* imguploader: add support for non-Amazon S3 endpoints and forcing of path-style S3 addressing
fixes#11240
Co-authored-by: Arve Knudsen <arve.knudsen@gmail.com>
* Edited Windows install instructions
Moved one section from Windows install guide to developer-guide.md. Edited some content in windows.md and will add questions.
* Updated per comments
* Fixed broken links in basic_concepts.md
* Revert "Fixed broken links in basic_concepts.md"
This reverts commit e524ea9e7b.
* Update windows.md
* Pagerduty notifier: configurable severity
Instead of hardcoding `critical` make it configurable per notification channel instance.
* fix html
* Add a test to ensure default severity is correct
* Notifications doc
* Add a non-default test
* Add err check on NewJson (all tests)
* Add default severity (critical) to AlertNotificationEditCtrl class
Adds support for region annotations in Postgres, MySQL and
MSSQL data sources by adding a column named timeend to
annotation query.
Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
Closes#20918
Ref #10589
* Update configuration.md
Updated logs section and clarified some of the file location and commenting information.
* Update docs/sources/installation/configuration.md
Co-Authored-By: Marcus Efraimsson <marcus.efraimsson@gmail.com>
Removes send_client_credentials_via_post oauth setting and
use auto-detect mechanism instead.
By these changes also fixes statichcheck errors
Ref #8968
* feat: adding lookup limit to OpenTSDB settings
Adding lookup to OpenTSDB datasource settings and using it in the datasource for tag value lookup and suggest
* Document the change.
* feat: UI for configuring OpenTSDB lookup limit.
* Apply prettier.
* Fix compilation error.
* Update debian-ubuntu installation
Major rework of debian.md, minor updates to a configuration.md and upgrading.md.
* updated docs
Updated per Torkel's comments
* Update debian.md
Added wget to common properties install command
* Update docs/sources/installation/debian.md
Co-Authored-By: Dan Cech <dcech@grafana.com>
* Update docs/sources/installation/debian.md
Co-Authored-By: Dan Cech <dcech@grafana.com>
* Update docs/sources/installation/debian.md
Co-Authored-By: Dan Cech <dcech@grafana.com>
* Update docs/sources/installation/debian.md
Co-Authored-By: Dan Cech <dcech@grafana.com>
* Update docs/sources/installation/debian.md
Co-Authored-By: Dan Cech <dcech@grafana.com>
* Update docs/sources/installation/debian.md
Co-Authored-By: Dan Cech <dcech@grafana.com>
* Update docs/sources/installation/debian.md
Co-Authored-By: Dan Cech <dcech@grafana.com>
* Apply suggestions from code review
Co-Authored-By: Dan Cech <dcech@grafana.com>
* Update upgrading.md
* Update upgrading.md
* Update debian.md
Added ARM link
Updates the docs to work with the website repo - mainly
relative link updates.
Adds a menu.yaml file to build the sidebar menu (no longer
using front matter weight).
* FieldDisplay: added support for value mapping of no data state.
Committer: Marcus Andersson <marcus.andersson@grafana.com>
* FieldDisplay: fixed issue when switching between modes and display numeric was null.
* ValueMapping: introduced a private function for checking null values.
* FieldDisplay: refactoring of test setup to reduce duplication.
* Docs: added info about new 'no data' value to text mapping.
* Docs: improved according to feedback. Reverted prettier formatting changes.
* FieldDisplay: removed unused import.
Profiling and tracing can now be enabled/disabled separately.
Adds argument for trace file path.
Support overriding profiling and tracing argument using
environment variables.
Update docs.
Fixes#20576
* Add Service Quota part
* Update docs after pr feedback
* Describing new features
* Divide into subheaders
* Changes after feedback
* cloudwatch: add min time interval section to docs
* docs: json format fix
* cloudwatch: move min time interval section in docs
* cloudwatch: docs fix
* docs: cloudwatch fixes
* docs: s/you are/you're
* docs: Cloudwatch - escapes underscores in tables
Adds support for using custom dockerfiles to pre-install image
renderer plugins.
Updates docs for docker and image rendering.
Fixes#20241
Co-Authored-By: Leonard Gram <leo@xlson.com>
* Adding cloudwatch related stuff - images will come later on
* Changes after pr feedback
* Add images
* Update image path
* Remove react migration part - might not be so interesting for our users
* Removing part about curated dashboards since it's not released yet - will be re-added later on
* Remove highres flag since it's not being used
* Remove not used code. Init id field correctly
* Fix broken tests
* Remove GMS related calculations
* Rename period field
* Add breaking changes to changelog. Also update upgrading docs
* Update snapshot
* Update docs after feedback
* Changes after feedback
Adds a new setting disable_admin_user and when true the default
admin user will not be created when Grafana starts for the first
time (or no users exists in the system).
Closes#19038
* AuthProxy: Can now login with auth proxy and get a login token
* added unit tests
* renamed setting and updated docs
* AuthProxy: minor tweak
* Fixed tests and namings
* spellfix
* fix
* remove unused setting, probably from merge conflict
* fix
* Adding grafana plugin version info
It was unclear if one can specify the plugin version to the environment variable. It is possible and works fine. Added it to the plugin information.
* Update typo docs/sources/installation/docker.md
* Applied all comments
Moved the information to make it more readable, fixed typos and added missing punctuation.
* Rewording and better example
More feedback, added example text. Did not manage to get newline for the example.
* added the missing space
Adds support for Generic OAuth role mapping. A new
configuration setting for generic oauth is added named
role_attribute_path which accepts a JMESPath expression.
Only Grafana roles named Viewer, Editor or Admin are
accepted.
Closes#9766
* Docs: Add additional capitalization rules
What this PR does / why we need it:
This updates the Documentation style guide to include more details on the capitalization rules. Capitalization rules get confused easily, especially between terms like Dashboards (menu title) and dashboards (plural).
Which issue(s) this PR fixes:
No fix, just an addition.
* Revert "Docs: Add additional capitalization rules"
This reverts commit 75cbc6303c.
* Docs: Docs: Add additional capitalization rules
* Docs: Simplify headings and make active #19268
* Fix: Fixes searchfilter wildcard char in regular expressions
Fixes: #20006
* Refactor: Uses TemplateSrv and ScopedVars instead
* Docs: Updates docs with new format
* Tests: Corrects test description
In the data sources docs two similar subsection names were used.
This PR renames `Adding the data source to Grafana` subsection to
`Adding data source` so that all data sources have the same
subsection name.
* Add docker-compose example for running grafana with remote renderer
* Update docs/sources/administration/image_rendering.md
Co-Authored-By: Marcus Efraimsson <marcus.efraimsson@gmail.com>
Update Azure AD instructions to follow heading changes in Azure Portal.
> In the legacy experience, an app had Keys page. In the new experience, it has been renamed to Certificates & secrets. In addition, Public keys are referred to as Certificates and Passwords are referred to as Client secrets.
Source: https://docs.microsoft.com/en-us/azure/active-directory/develop/app-registrations-training-guide#keyscertificates--secrets
I verified by logging in Azure AD and walking through the steps.
* Make it clear that role switching is not supported
* Update docs/sources/features/datasources/cloudwatch.md
Co-Authored-By: Marcus Efraimsson <marcus.efraimsson@gmail.com>
* WIP: Initial hardcoded version
* Feature: Introduces SearchFiltering to Graphite
* Feature: Adds searchFiltering to MySql
* Tests: Adds tests to Graphite and MySql
* Feature: Adds $__searchFilter to TestData
* Refactor: Adds searchFilter to Postgres and extracts function
* Tests: Adds tests to variable
* Refactor: Adds debounce and lodash import optimization
* Docs: Adds documentation
* Refactor: Removes unused function and fixes typo
* Docs: Updates docs
* Fixed issue with UI not updating when no was used due to async func and no .apply in the non lazy path
It is now possible to specify a field containing time-end in
Elasticsearch annotations.
Any annotations with a time-end will become a region between
time and time-end. Any annotations without the time-end field
will remain a single-point annotation.
Ref #10589
