The open and composable observability and data visualization platform. Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.
Go to file
axlrosen 79747b419b
Doc: Info about $__rate_interval for naive users (#36576)
* Doc: Info about $__rate_interval for naive users

<!--

Thank you for sending a pull request! Here are some tips:

1. If this is your first time, please read our contribution guide at https://github.com/grafana/grafana/blob/main/CONTRIBUTING.md

2. Ensure you include and run the appropriate tests as part of your Pull Request.

3. In a new feature or configuration option, an update to the documentation is necessary. Everything related to the documentation is under the docs folder in the root of the repository.

4. If the Pull Request is a work in progress, make use of GitHub's "Draft PR" feature and mark it as such.

5. If you can not merge your Pull Request due to a merge conflict, Rebase it. This gets it in sync with the main branch.

6. Name your PR as "<FeatureArea>: Describe your change", e.g. Alerting: Prevent race condition. If it's a fix or feature relevant for the changelog describe the user impact in the title. The PR title is used to auto-generate the changelog for issues marked with the "add to changelog" label.

-->

**What this PR does / why we need it**:

For Prometheus newbies (i.e. most of us), it seems like $__rate_interval should be widely used, but the documentation doesn't tell us that. So I added more about why it's good, and an explicit recommendation that it can be a good default value for use if (like most of us) you don't really understand how to choose an interval. (Let me know if that's not actually the case, but that's what I took away from https://github.com/grafana/grafana/issues/21417)

Also fixed a few typos in the existing doc.

**Which issue(s) this PR fixes**:

<!--

- Automatically closes linked issue when the Pull Request is merged.

Usage: "Fixes #<issue number>", or "Fixes (paste link of issue)"

-->

Fixes #

**Special notes for your reviewer**:

* Edits based on suggestions from @beorn7

* Update docs/sources/datasources/prometheus.md

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>

Co-authored-by: Ivana Huckova <30407135+ivanahuckova@users.noreply.github.com>
Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
Co-authored-by: Ivana <ivana.huckova@gmail.com>
2021-07-20 13:25:24 +02:00
.circleci Chore: Add Circle CI empty config (#35020) 2021-06-01 11:56:11 +02:00
.github Update CODEOWNERS (#35287) 2021-06-04 21:19:30 +02:00
.vscode Dev: include vscode launcher / debugger (#36360) 2021-07-07 00:05:30 -07:00
conf Email: Allow configuration of content types for email notifications (#34530) 2021-07-19 13:31:51 +03:00
contribute E2E: Add support for data-test-id over aria labels and add importDashboard flow (#36483) 2021-07-19 14:01:31 -04:00
cue Scuemata: Add test to validate devenv resources (#35810) 2021-07-15 20:08:03 -04:00
cue.mod Introduce "scuemata" system for CUE-based specification of Grafana objects (#32527) 2021-04-08 01:11:11 -07:00
devenv Devenv: Update troubleshooting documentation (#36846) 2021-07-19 17:23:38 +02:00
docs Doc: Info about $__rate_interval for naive users (#36576) 2021-07-20 13:25:24 +02:00
e2e E2E: Add support for data-test-id over aria labels and add importDashboard flow (#36483) 2021-07-19 14:01:31 -04:00
emails Email: Allow configuration of content types for email notifications (#34530) 2021-07-19 13:31:51 +03:00
grafana-mixin Chore: Add newline at EOF (#36595) 2021-07-09 08:21:59 -07:00
packages Chore: Fix more TypeScript errors (#36918) 2021-07-20 09:57:03 +01:00
packaging Image Renderer: update env variable in docs and custom Docker files (#36501) 2021-07-07 18:05:55 +02:00
pkg live: handle input with NaN sent as a string (#36924) 2021-07-20 10:46:05 +03:00
plugins-bundled Plugins: converted the plugins admin app to a core feature in grafana (#36026) 2021-07-08 17:50:42 +02:00
public Prometheus: Update PromQL typeahead and highlighting (#36730) 2021-07-20 11:19:59 +02:00
scripts Update ci-check-strict.sh (#36943) 2021-07-20 12:21:20 +02:00
tools Image Rendering: Remove PhantomJS support (#23460) 2020-04-15 22:17:41 +02:00
.bra.toml Chore: Upgrade to Go 1.14 (#23371) 2020-04-08 14:13:05 +02:00
.browserslistrc Babel: Target more modern browsers, updates browserlistrc (#32573) 2021-04-01 10:32:00 +02:00
.dockerignore remove duplicated /tmp entry in .dockerignore 2018-08-09 09:10:53 +02:00
.drone.star Sign Drone's configuration YAML file (#36528) 2021-07-14 14:40:28 +02:00
.drone.yml Make validate-schema CLI command work vs. disk (#36863) 2021-07-16 19:53:19 -04:00
.editorconfig Chore: Enable PR testing in Drone (#26189) 2020-07-10 16:09:21 +02:00
.eslintignore Chore: Lint all files for no-only-tests (#30364) 2021-01-19 11:06:27 +01:00
.eslintrc Performance: Standardize lodash imports to use destructured members (#33040) 2021-04-21 09:38:00 +02:00
.gitattributes CRLF (#28822) 2020-11-05 17:20:40 +01:00
.gitignore Dev: ignore vscode folder except launch.json (#36517) 2021-07-07 17:03:10 +02:00
.prettierignore Theming: Updates to select styles and theme model progress (#32797) 2021-04-12 14:23:00 +02:00
.prettierrc.js Prettier: Add prettier config that imports prettier from toolkit (#23729) 2020-04-21 17:23:49 +02:00
api-extractor.json Docs: added code comments for everything in the @grafana/runtime package. (#23456) 2020-04-15 10:46:51 +02:00
build.go remove GO111MODULE (#36235) 2021-06-29 10:01:21 +02:00
CHANGELOG_ARCHIVE.md Automation: Adds new changelog actions (#29142) 2020-11-16 21:34:19 +01:00
CHANGELOG.md ReleaseNotes: Updated changelog and release notes for 7.5.10 (#36802) 2021-07-15 18:04:42 +02:00
CODE_OF_CONDUCT.md Docs: Refactor inconsistent unordered lists (#27826) 2020-10-02 11:02:11 -07:00
CONTRIBUTING.md Chore: Move from master to main branch (#33693) 2021-05-06 16:29:29 +02:00
Dockerfile AccessControl: Add provisioning folder to the packaging process (#34398) 2021-05-20 09:41:39 +02:00
Dockerfile.ubuntu AccessControl: Add provisioning folder to the packaging process (#34398) 2021-05-20 09:41:39 +02:00
embed.go Introduce "scuemata" system for CUE-based specification of Grafana objects (#32527) 2021-04-08 01:11:11 -07:00
go.mod Chore: Upgrade grafana-plugin-sdk-go to v0.110.0 (#36763) 2021-07-15 09:39:25 +02:00
go.sum Chore: Upgrade grafana-plugin-sdk-go to v0.110.0 (#36763) 2021-07-15 09:39:25 +02:00
GOVERNANCE.md Update GOVERNANCE.md (#36223) 2021-06-28 17:55:25 +02:00
ISSUE_TRIAGE.md Chore: Move from master to main branch (#33693) 2021-05-06 16:29:29 +02:00
jest.config.js Geomap: use a common configuration builder to find location fields (#36768) 2021-07-15 12:00:19 -07:00
latest.json Chore: Update latest.json to 8.0.6 (#36805) 2021-07-15 16:13:18 +02:00
lerna.json Update packages version (#34064) 2021-05-13 16:02:18 +02:00
LICENSE Re-license Grafana to AGPLv3 (#33184) 2021-04-20 19:03:30 +02:00
LICENSING.md Put vendored code under their upstream licenses explicitly (#36442) 2021-07-05 21:33:01 +02:00
MAINTAINERS.md Docs: Refactor inconsistent unordered lists (#27826) 2020-10-02 11:02:11 -07:00
Makefile Sign Drone's configuration YAML file (#36528) 2021-07-14 14:40:28 +02:00
metadata.md Docs: Document plugin authentication in metadata schema (#32703) 2021-04-08 18:13:18 +02:00
NOTICE.md Update NOTICE.md 2021-01-06 08:16:50 +01:00
package.json Geomap: add initial openlayers alpha panel (#36188) 2021-07-09 17:53:07 +02:00
PLUGIN_DEV.md Chore: Move from master to main branch (#33693) 2021-05-06 16:29:29 +02:00
README.md 33507_drone_badge: Replace CircleCI badge in readme with drone badge (#33649) 2021-05-04 17:59:52 +08:00
ROADMAP.md Update ROADMAP.md (#19384) 2019-09-25 07:18:35 +02:00
SECURITY.md Docs: Fix broken link (#25664) 2020-06-18 14:08:26 +02:00
SUPPORT.md Update SUPPORT.md (#19383) 2019-09-25 07:17:01 +02:00
tsconfig.json Tests: Adds expects for observables (#28929) 2020-11-18 15:18:55 +01:00
UPGRADING_DEPENDENCIES.md remove GO111MODULE (#36235) 2021-06-29 10:01:21 +02:00
WORKFLOW.md Chore: Move from master to main branch (#33693) 2021-05-06 16:29:29 +02:00
yarn.lock Chore: Sync lock file with package.json (#36667) 2021-07-13 14:23:08 +02:00

Grafana

The open-source platform for monitoring and observability.

License Drone Go Report Card

Grafana allows you to query, visualize, alert on and understand your metrics no matter where they are stored. Create, explore, and share dashboards with your team and foster a data driven culture:

  • Visualize: Fast and flexible client side graphs with a multitude of options. Panel plugins offer many different ways to visualize metrics and logs.
  • Dynamic Dashboards: Create dynamic & reusable dashboards with template variables that appear as dropdowns at the top of the dashboard.
  • Explore Metrics: Explore your data through ad-hoc queries and dynamic drilldown. Split view and compare different time ranges, queries and data sources side by side.
  • Explore Logs: Experience the magic of switching from metrics to logs with preserved label filters. Quickly search through all your logs or streaming them live.
  • Alerting: Visually define alert rules for your most important metrics. Grafana will continuously evaluate and send notifications to systems like Slack, PagerDuty, VictorOps, OpsGenie.
  • Mixed Data Sources: Mix different data sources in the same graph! You can specify a data source on a per-query basis. This works for even custom datasources.

Get started

Unsure if Grafana is for you? Watch Grafana in action on play.grafana.org!

Documentation

The Grafana documentation is available at grafana.com/docs.

Contributing

If you're interested in contributing to the Grafana project:

Get involved

License

Grafana is distributed under AGPL-3.0-only. For Apache-2.0 exceptions, see LICENSING.md.