Skip to content

Commit d416724

Browse files
committed
Document metrics and update overview section
Signed-off-by: yolossn <[email protected]>
1 parent ae52c6b commit d416724

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

content/docs/introduction/overview.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ the project's governance structure, Prometheus joined the
1717
[Cloud Native Computing Foundation](https://cncf.io/) in 2016
1818
as the second hosted project, after [Kubernetes](http://kubernetes.io/).
1919

20+
Prometheus collects and stores its metrics as time series data, i.e. metrics information is stored with the timestamp at which it was recorded, alongside optional key-value pairs called labels.
21+
2022
For more elaborate overviews of Prometheus, see the resources linked from the
2123
[media](/docs/introduction/media/) section.
2224

@@ -33,6 +35,14 @@ Prometheus's main features are:
3335
* targets are discovered via service discovery or static configuration
3436
* multiple modes of graphing and dashboarding support
3537

38+
### What are metrics ?
39+
40+
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.
41+
42+
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.
43+
44+
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?
45+
3646
### Components
3747

3848
The Prometheus ecosystem consists of multiple components, many of which are

0 commit comments

Comments
 (0)