Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-01-25 00:07:47 +01:00
Code Issues Projects Releases Wiki Activity

docs: Documentation around metrics API (#4134)

Browse Source 
## About the changes
Mark some legacy endpoints as deprecated (they are long deprecated but
documentation was out of date) and fix some of the URLs
This commit is contained in:
Gastón Fournier 2023-07-04 11:16:05 +02:00 committed by GitHub
parent 0b18491237
commit 13def9a3a3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
website/docs/reference/api/legacy/unleash/admin/metrics.md
View File

@ -8,8 +8,13 @@ title: /api/admin/metrics
# This document describes the metrics endpoint for admin ui
### Seen-toggles {#seen-toggles}
:::caution Deprecation notice
`GET http://unleash.host.com/api/admin/seen-toggles`
This endpoint has been deprecated
:::
`GET http://unleash.host.com/api/admin/metrics/seen-toggles`
This enpoints returns a list of applications and what toogles unleash has seen for each application. It will only guarantee toggles reported by client applications within the last hour, but will in most cases remember seen toggles for applications longer.
@ -84,9 +89,9 @@ This endpoint gives _last minute_ and _last hour_ metrics for all active toggles
### Applications {#applications}
`GET http://unleash.host.com/api/admin/applications`
`GET http://unleash.host.com/api/admin/metrics/applications`
This endpoint returns a list of known applications (seen the last two days) and a link to follow for more details.
This endpoint returns a list of known applications (seen in the last day) and a link to follow for more details.
```json
{
@ -115,11 +120,11 @@ This endpoint returns a list of known applications (seen the last two days) and
You can also specify the query param: _strategyName_, which will return all applications implementing the given strategy.
`GET http://unleash.host.com/api/admin/applications?strategyName=someStrategyName`
`GET http://unleash.host.com/api/admin/metrics/applications?strategyName=someStrategyName`
### Application Details {#application-details}
`GET http://unleash.host.com/api/admin/applications/:appName`
`GET http://unleash.host.com/api/admin/metrics/applications/:appName`
This endpoint gives insight into details about a client application, such as instances, strategies implemented and seen toggles.
@ -152,7 +157,13 @@ This endpoint gives insight into details about a client application, such as ins
### Seen applications {#seen-applications}
`GET http://unleash.host.com/api/admin/seen-apps`
:::caution Deprecation notice
This endpoint has been deprecated
:::
`GET http://unleash.host.com/api/admin/metrics/seen-apps`
This endpoint gives insight into details about application seen per feature toggle.