Document metrics and update overview section by yolossn · Pull Request #1950 · prometheus/docs

yolossn · 2021-05-16T06:51:56Z

No description provided.

andrewpollack · 2021-05-16T16:11:04Z

Thank you for the initiative @yolossn 😄

I've made some grammar suggestions to help with the overall flow, and this is a fantastic resource for people who are starting out. Apologies if I over-commented as this is my first PR review for this project, and hope this was helpful!

yolossn · 2021-05-16T16:56:40Z

@andrewpollack sorry I am not able to see any suggestions. Am I missing something here?

andrewpollack · 2021-05-16T16:06:03Z

content/docs/introduction/overview.md

 [Cloud Native Computing Foundation](https://cncf.io/) in 2016
 as the second hosted project, after [Kubernetes](http://kubernetes.io/).

+Prometheus collects and stores all the metrics data as time series, i.e metrics information 


Suggested change

Prometheus collects and stores all the metrics data as time series, i.e metrics information

Prometheus collects and stores its metrics as time series data, i.e. metrics information

andrewpollack · 2021-05-16T16:06:37Z

content/docs/introduction/overview.md

 as the second hosted project, after [Kubernetes](http://kubernetes.io/).

+Prometheus collects and stores all the metrics data as time series, i.e metrics information 
+is stored along with the timestamp at which it was recorded, optional key-value pairs 


Suggested change

is stored along with the timestamp at which it was recorded, optional key-value pairs

is stored with the timestamp at which it was recorded, alongside optional key-value pairs

andrewpollack · 2021-05-16T16:07:13Z

content/docs/introduction/overview.md


+Prometheus collects and stores all the metrics data as time series, i.e metrics information 
+is stored along with the timestamp at which it was recorded, optional key-value pairs 
+called as labels can also be stored along with metrics.


Suggested change

called as labels can also be stored along with metrics.

called labels.

andrewpollack · 2021-05-16T16:08:16Z

content/docs/introduction/overview.md


+### What are metrics ?
+
+Metrics in layman terms is a standard for measurement. What we want to measure differs from application to application. For a web server it can be request times, for a database it can be number of active connections or number of active queries etc.


Suggested change

Metrics in layman terms is a standard for measurement. What we want to measure differs from application to application. For a web server it can be request times, for a database it can be number of active connections or number of active queries etc.

In layperson terms, metrics are a standard for measurement. What we want to measure differs from application to application. For a web server it can be request times for a database it can be number of active connections or number of active queries etc.

s/layman/layperson

andrewpollack · 2021-05-16T16:09:39Z

content/docs/introduction/overview.md

+
+Metrics in layman terms is a standard for measurement. What we want to measure differs from application to application. For a web server it can be request times, for a database it can be number of active connections or number of active queries etc.
+
+Metrics play an important role in understanding why your application is working in a certain way. Lets assume you are running a web application and find that the application is slow. You will need some information to find out what is happening with your application. For example the application can become slow when the number of requests are high. If you have the request count metric you can spot the reason and increase the number of servers to handle the heavy load. Whenever you are defining the metrics for your application you must put on your detective hat and ask this question what all information will be important for me to debug if any issue occurs in my application?


Suggested change

Metrics play an important role in understanding why your application is working in a certain way. Lets assume you are running a web application and find that the application is slow. You will need some information to find out what is happening with your application. For example the application can become slow when the number of requests are high. If you have the request count metric you can spot the reason and increase the number of servers to handle the heavy load. Whenever you are defining the metrics for your application you must put on your detective hat and ask this question what all information will be important for me to debug if any issue occurs in my application?

Metrics play an important role in understanding why your application is working in a certain way. Let's assume you are running a web application and find that the application is slow. You will need some information to find out what is happening with your application. For example, the application can become slow when the number of requests are high. If you have the request count metric, you can spot this reason and increase the number of servers to handle the heavy load.

Whenever you are defining the metrics for your application, you must put on your detective hat and ask this question: what information will be important for me to debug if any issue occurs in my application?

I wonder if it would help here if we would be more explicit with the example. So, rather than talking in general about a web app and requests, how about a concrete example using HTTP API, GET requests, etc.?

@mhausenblas I think giving a simple yet generic example will be more apt than getting into something specific.

andrewpollack · 2021-05-16T17:38:37Z

@andrewpollack sorry I am not able to see any suggestions. Am I missing something here?

My bad, I think I forgot to publish! Try checking now

mhausenblas

LGTM!

mhausenblas · 2021-05-17T08:21:10Z

content/docs/introduction/overview.md


+### What are metrics ?
+
+Metrics in layman terms is a standard for measurement. What we want to measure differs from application to application. For a web server it can be request times, for a database it can be number of active connections or number of active queries etc.


s/layman/layperson

mhausenblas · 2021-05-17T08:23:08Z

content/docs/introduction/overview.md

+
+Metrics in layman terms is a standard for measurement. What we want to measure differs from application to application. For a web server it can be request times, for a database it can be number of active connections or number of active queries etc.
+
+Metrics play an important role in understanding why your application is working in a certain way. Lets assume you are running a web application and find that the application is slow. You will need some information to find out what is happening with your application. For example the application can become slow when the number of requests are high. If you have the request count metric you can spot the reason and increase the number of servers to handle the heavy load. Whenever you are defining the metrics for your application you must put on your detective hat and ask this question what all information will be important for me to debug if any issue occurs in my application?


I wonder if it would help here if we would be more explicit with the example. So, rather than talking in general about a web app and requests, how about a concrete example using HTTP API, GET requests, etc.?

Signed-off-by: yolossn <nssvlr@gmail.com>

hdost · 2021-06-14T08:21:59Z

Relates to #1856

content/docs/introduction/overview.md

RichiH · 2021-06-16T12:28:10Z

content/docs/introduction/overview.md

+
+Metrics play an important role in understanding why your application is working in a certain way. Lets assume you are running a web application and find that the application is slow. You will need some information to find out what is happening with your application. For example the application can become slow when the number of requests are high. If you have the request count metric you can spot the reason and increase the number of servers to handle the heavy load. 
+
+Whenever you are defining the metrics for your application you must put on your detective hat and ask this question what all information will be important for me to debug if any issue occurs in my application?


That feels weird in an intro section.

content/docs/introduction/overview.md

Co-authored-by: Richard Hartmann <RichiH@users.noreply.github.com>

yolossn force-pushed the master branch from 74296a9 to a457dbf Compare May 16, 2021 06:57

andrewpollack suggested changes May 16, 2021

View reviewed changes

mhausenblas reviewed May 17, 2021

View reviewed changes

Document metrics and update overview section

d416724

Signed-off-by: yolossn <nssvlr@gmail.com>

yolossn force-pushed the master branch from a457dbf to d416724 Compare May 18, 2021 19:56

RichiH requested changes Jun 16, 2021

View reviewed changes

RichiH reviewed Jul 27, 2021

View reviewed changes

content/docs/introduction/overview.md Outdated Show resolved Hide resolved

yolossn and others added 3 commits July 27, 2021 14:19

Update content/docs/introduction/overview.md

f5f3006

Co-authored-by: Richard Hartmann <RichiH@users.noreply.github.com>

Update content/docs/introduction/overview.md

c788046

Co-authored-by: Richard Hartmann <RichiH@users.noreply.github.com>

Update content/docs/introduction/overview.md

5d4d615

Co-authored-by: Richard Hartmann <RichiH@users.noreply.github.com>

RichiH merged commit 2ea2e45 into prometheus:master Jul 27, 2021

	Prometheus collects and stores all the metrics data as time series, i.e metrics information
	Prometheus collects and stores its metrics as time series data, i.e. metrics information

	is stored along with the timestamp at which it was recorded, optional key-value pairs
	is stored with the timestamp at which it was recorded, alongside optional key-value pairs

	called as labels can also be stored along with metrics.
	called labels.


		### What are metrics ?

		Metrics in layman terms is a standard for measurement. What we want to measure differs from application to application. For a web server it can be request times, for a database it can be number of active connections or number of active queries etc.

	Metrics in layman terms is a standard for measurement. What we want to measure differs from application to application. For a web server it can be request times, for a database it can be number of active connections or number of active queries etc.
	In layperson terms, metrics are a standard for measurement. What we want to measure differs from application to application. For a web server it can be request times for a database it can be number of active connections or number of active queries etc.


		Metrics in layman terms is a standard for measurement. What we want to measure differs from application to application. For a web server it can be request times, for a database it can be number of active connections or number of active queries etc.

		Metrics play an important role in understanding why your application is working in a certain way. Lets assume you are running a web application and find that the application is slow. You will need some information to find out what is happening with your application. For example the application can become slow when the number of requests are high. If you have the request count metric you can spot the reason and increase the number of servers to handle the heavy load. Whenever you are defining the metrics for your application you must put on your detective hat and ask this question what all information will be important for me to debug if any issue occurs in my application?

-Metrics play an important role in understanding why your application is working in a certain way. Lets assume you are running a web application and find that the application is slow. You will need some information to find out what is happening with your application. For example the application can become slow when the number of requests are high. If you have the request count metric you can spot the reason and increase the number of servers to handle the heavy load. Whenever you are defining the metrics for your application you must put on your detective hat and ask this question what all information will be important for me to debug if any issue occurs in my application?
+Metrics play an important role in understanding why your application is working in a certain way. Let's assume you are running a web application and find that the application is slow. You will need some information to find out what is happening with your application. For example, the application can become slow when the number of requests are high. If you have the request count metric, you can spot this reason and increase the number of servers to handle the heavy load.
+Whenever you are defining the metrics for your application, you must put on your detective hat and ask this question: what information will be important for me to debug if any issue occurs in my application?


		Metrics play an important role in understanding why your application is working in a certain way. Lets assume you are running a web application and find that the application is slow. You will need some information to find out what is happening with your application. For example the application can become slow when the number of requests are high. If you have the request count metric you can spot the reason and increase the number of servers to handle the heavy load.

		Whenever you are defining the metrics for your application you must put on your detective hat and ask this question what all information will be important for me to debug if any issue occurs in my application?

Conversation

yolossn commented May 16, 2021

Uh oh!

andrewpollack commented May 16, 2021

Uh oh!

yolossn commented May 16, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andrewpollack May 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andrewpollack commented May 16, 2021

Uh oh!

mhausenblas left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hdost commented Jun 14, 2021

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

andrewpollack May 16, 2021 •

edited

Loading