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: Update prometheus getting started doc #60803

Merged
merged 12 commits into from Jan 13, 2023

Conversation

bohandley
Copy link
Contributor

@bohandley bohandley commented Dec 28, 2022

Part of G10 Getting started with Prometheus

Fixes #60599

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. This draft updates the tutorial to send metrics to Grafana Cloud.

This draft also needs images, so I need to find where we can store those to reference them in the md file.

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.


1. Sign up for [https://grafana.com/](https://grafana.com/auth/sign-up/create-user). Grafana gives you a Prometheus instance out of the box.

SHOW PICTURE HERE
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bohandley , images are stored in the website repo and then you can add a reference to that image here. For image guidelines, take a look at https://grafana.com/docs/writers-toolkit/writing-guide/image-guidelines/.

Copy link
Collaborator

@chri2547 chri2547 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a few suggestions. Thank you very much for working on this! We appreciate it.

@bohandley
Copy link
Contributor Author

Adding image in the website repository, PR is here
https://github.com/grafana/website/pull/11195

@grafanabot grafanabot added the pr/external This PR is from external contributor label Jan 10, 2023
@bohandley bohandley removed the pr/external This PR is from external contributor label Jan 10, 2023
@grafanabot grafanabot added the pr/external This PR is from external contributor label Jan 10, 2023
@bohandley bohandley marked this pull request as ready for review January 10, 2023 23:17
@bohandley bohandley added no-backport Skip backport of PR no-changelog Skip including change in changelog/release notes labels Jan 11, 2023
@bohandley bohandley force-pushed the bohandley/update-prom-getting-started-doc branch from 837d911 to 193be8a Compare January 11, 2023 13:57
```
./prometheus --config.file=./prometheus.yml
```

1. Confirm that Prometheus is running by navigating to `http://localhost:9090`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we want to call out that 9090 is the default port, but could change depending on their prometheus installation? Either that or add the prometheus config above that includes the 9090 target, so it's obvious where that's coming from (not everyone will know that 9090 is the default port for prom like we do)

Copy link
Contributor

@gtk-grafana gtk-grafana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks really good! Thanks for taking the time to get this updated. I had a minor question but I think this is fine to merge whenever you feel good with it

bohandley and others added 12 commits January 13, 2023 10:14
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com>
@bohandley bohandley force-pushed the bohandley/update-prom-getting-started-doc branch from 4e301e8 to 11bf014 Compare January 13, 2023 15:14
@bohandley bohandley merged commit 370272e into main Jan 13, 2023
@bohandley bohandley deleted the bohandley/update-prom-getting-started-doc branch January 13, 2023 15:38
@dsotirakis dsotirakis modified the milestones: 9.4.0, 9.4.0-beta1 Jan 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
datasource/Prometheus enterprise-ok no-backport Skip backport of PR no-changelog Skip including change in changelog/release notes onboarding pr/external This PR is from external contributor type/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation: Expand and clarify "Get Started with Prometheus and Grafana" docs page
6 participants