Skip to content

Commit 623953a

Browse files
authored
Merge pull request #3223 from vladak/stats_update_apiary
update Apiary documentation for monitoring
2 parents 07b7410 + 650910a commit 623953a

File tree

1 file changed

+6
-41
lines changed

1 file changed

+6
-41
lines changed

apiary.apib

Lines changed: 6 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,12 @@ see https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html#parse-java
245245
}
246246
]
247247

248+
## Monitoring [/metrics/prometheus]
249+
250+
### retrieves web application metrics in Prometheus format [GET]
251+
252+
+ Response 200 (text/plain)
253+
248254
## Path descriptions [/system/pathdesc]
249255

250256
### updates path descriptions for web application [POST]
@@ -434,47 +440,6 @@ The repository path is relative to source root.
434440
}]
435441
}
436442

437-
## Statistics [/stats]
438-
439-
### returns statistics [GET]
440-
441-
+ Response 200 (application/json)
442-
+ Body
443-
444-
{"requests_per_minute_max":2,"timing":{"authorization":9,"authorization_in_stack_default stack_of_OpenGrok":0,
445-
"authorization_in_stack_default stack_positive":0,"authorization_of_OpenGrok":9,
446-
"authorization_positive_of_OpenGrok":9,"root":1109,"*":1109,"authorization_in_stack_default stack_positive_of_OpenGrok":0,
447-
"authorization_positive":9},"minutes":1,"timing_min":{"authorization":0,"authorization_in_stack_default stack_of_OpenGrok":0,
448-
"authorization_in_stack_default stack_positive":0,"authorization_of_OpenGrok":0,
449-
"authorization_positive_of_OpenGrok":0,"root":4,"*":4,"authorization_in_stack_default stack_positive_of_OpenGrok":0,
450-
"authorization_positive":0},"timing_avg":{"authorization":4.5,"authorization_in_stack_default stack_of_OpenGrok":0.0,
451-
"authorization_in_stack_default stack_positive":0.0,"authorization_of_OpenGrok":4.5,
452-
"authorization_positive_of_OpenGrok":4.5,"root":554.5,"*":554.5,
453-
"authorization_in_stack_default stack_positive_of_OpenGrok":0.0,"authorization_positive":4.5},
454-
"request_categories":{"authorization":2,"authorization_in_stack_default stack_of_OpenGrok":2,
455-
"authorization_in_stack_default stack_positive":2,"authorization_cache_misses":2,
456-
"authorization_of_OpenGrok":2,"authorization_cache_hits":4,
457-
"authorization_positive_of_OpenGrok":2,"root":2,"*":2,
458-
"authorization_in_stack_default stack_positive_of_OpenGrok":2,
459-
"authorization_positive":2},
460-
"day_histogram":[0,0,0,0,0,0,0,0,0,0,0,0,2,0,0,0,0,0,0,0,0,0,0,0],"requests":2,
461-
"requests_per_minute_min":1,"requests_per_minute":2,"requests_per_minute_avg":2.0,
462-
"month_histogram":[0,0,0,2,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0],
463-
"timing_max":{"authorization":9,"authorization_in_stack_default stack_of_OpenGrok":0,
464-
"authorization_in_stack_default stack_positive":0,"authorization_of_OpenGrok":9,
465-
"authorization_positive_of_OpenGrok":9,"root":1105,"*":1105,
466-
"authorization_in_stack_default stack_positive_of_OpenGrok":0,"authorization_positive":9}}
467-
468-
### deletes statistics [DELETE]
469-
470-
+ Response 204
471-
472-
## Statistics reload [/stats/reload]
473-
474-
### reloads statistics (useful when configuration path to statistics changed) [PUT]
475-
476-
+ Response 204
477-
478443
## Suggester [/suggest{?projects,field,caret,full,defs,refs,path,hist,type}]
479444

480445
### returns suggestions [GET]

0 commit comments

Comments
 (0)