Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Expand and clarify "Get Started with Prometheus and Grafana" docs page #60599

Closed
bohandley opened this issue Dec 20, 2022 · 0 comments · Fixed by #60803
Closed

Comments

@bohandley
Copy link
Contributor

Part of G10 Getting started with Prometheus

What is this:

This docs page assists a user with starting a Prometheus instance but it is missing key data to connect Prometheus with Grafana.

Image

Who is this for?

New users of Prometheus and Grafana

Why?

Using the Prometheus installation guide asks the user to create a Prometheus instance that is running locally. The docs do not reflect this in the configuration set up. If a user creates a local Prom instance they must do either of the following:

  • run Grafana locally and and configure Prom themselves
  • Use an Prom instance on Grafana.com and remote_write metrics to that instance
    This information is not provided clearly in the tutorial and these two workflows are very different for a new user.

There are two options to simplify this for new users.

1. Instruct users to visit Grafana.com and remote_write local Prom metrics to the Grafana.com prom instance

Pros
  • Directs users to grafana.com, benefit to hosted grafana
  • Streamlines the configuration stage because a hosted prom instance is already configured
Cons
  • Removes the configuration with Grafana step for more custom prom options

2. Add links to downloading grafana for local development and add documentation including the configuration page

Pros
  • Users learn how to configure a Prom plugin instance with Grafana
Cons
  • It is more valuable to direct users to grafana.com than to have them run grafana locally

Suggested updates

a. Explicitly state that if a user is running prom locally, they will need to use option 1 or option 2
b. Give explicit directions for option 1, show flow of signing up for grafana.com, and remote_writing to grafana hosted prom instance, including prom.yml cofiguration information for remote_write
c. Provide light instructions for option 2 providing links to downloading and running grafana locally. Provide links to cofigure options for creating a Prom plugin instance in grafana.
d. A screen shots to navigate to explore
e. Give instructions/screenshots for visualizing a query with query editor

@bohandley bohandley self-assigned this Dec 20, 2022
@bohandley bohandley added this to the 10.0.0 milestone Dec 20, 2022
@bohandley bohandley changed the title Documentation: expand "Get Started with Prometheus and Grafana" docs page Documentation: Expand and clarify "Get Started with Prometheus and Grafana" docs page Dec 20, 2022
@zerok zerok modified the milestones: 10.0.0, 10.0.0-preview May 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants