Skip to content

Commit c5c73d2

Browse files
KarineValencaeabili0
authored andcommitted
updated readme
1 parent 4f1f67f commit c5c73d2

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

+20-1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ request_seconds_count{type, status, isError, method, addr}
1212
request_seconds_sum{type, status, isError, method, addr}
1313
response_size_bytes{type, status, isError, method, addr}
1414
dependency_up{name}
15+
dependency_request_seconds_bucket{name, type, status, isError, errorMessage, method, addr, le}
16+
dependency_request_seconds_count{name, type, status, isError, errorMessage, method, add}
17+
dependency_request_seconds_sum{name, type, status, isError, errorMessage, method, add}
1518
application_info{version}
1619
```
1720

@@ -27,7 +30,13 @@ Details:
2730

2831
5. The `dependency_up` is a metric to register whether a specific dependency is up (1) or down (0). The label `name` registers the dependency name;
2932

30-
6. The `application_info` holds static info of an application, such as it's semantic version number;
33+
6. The `dependency_request_seconds_bucket` is a metric that defines the histogram of how many requests to a specific dependency are falling into the well defined buckets represented by the label le;
34+
35+
7. The `dependency_request_seconds_count` is a counter that counts the overall number of requests to a specific dependency;
36+
37+
8. The `dependency_request_seconds_sum` is a counter that counts the overall sum of how long requests to a specific dependency are taking;
38+
39+
9. The `application_info` holds static info of an application, such as it's semantic version number;
3140

3241
Labels:
3342

@@ -43,6 +52,10 @@ Labels:
4352

4453
6. `isError` lets us know if the status code reported is an error or not;
4554

55+
7. `errorMessage` registers the error message;
56+
57+
8. `name` registers the name of the dependency;
58+
4659
## How to
4760

4861
### Importing dependency
@@ -221,6 +234,12 @@ MonitorMetrics.INSTANCE.addDependencyChecker(fakeChecker, periodIntervalInMillis
221234
> :warning: **NOTE**:
222235
> The dependency checkers will run on a new thread, to prevent memory leak, make sure to call the method ``MonitorMetrics.INSTANCE.cancelAllDependencyCheckers()`` on undeploying/terminating the web app.
223236
237+
You also can monitore a dependency event. Just call `addDependencyEvent` and pass the right params.
238+
239+
```java
240+
MonitorMetrics.INSTANCE.addDependencyEvent(name, type, status, method, address, isError, errorMessage, elapsedSeconds);
241+
```
242+
224243
## Big Brother
225244

226245
This project is part of a more large application called [Big Brother](https://github.com/labbsr0x/big-brother).

0 commit comments

Comments
 (0)