-
Notifications
You must be signed in to change notification settings - Fork 6.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
36 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Status APIs | ||
|
||
Status APIs are a set of APIs that allow you to get the status of the OAP status and measurements of queries. | ||
They are useful for monitoring the health of the OAP server and to diagnose and troubleshoot issues caused by | ||
configurations and performance bottlenecks. | ||
|
||
Since v10, we begin to add status APIs to help users to understand the status of the OAP server, besides looking the raw | ||
logs and self-observability solutions. | ||
|
||
- [Dump Effective Initial Configurations API](../debugging/config_dump.md) | ||
- [Tracing Query Execution APIs](../debugging/query-tracing.md) | ||
- [Get Effective TTL Configurations API](query_ttl_setup.md) | ||
|
||
If you have a proposal about new status API, please don't hesitate | ||
to [create a discussion](https://github.com/apache/skywalking/discussions/new?category=ideas). | ||
The basic principles for a status API are | ||
|
||
1. It should be useful for users to understand the status of the OAP server or the reason of the performance behavior, | ||
rather than a function feature. | ||
2. It should be on-demand and not impact the performance of the OAP server too much, especially in the production | ||
environment. | ||
3. HTTP APIs are preferred unless there is a special reason to use other. | ||
|
||
## Disable Status APIs | ||
|
||
By default, this service is open for helping users to debug and diagnose. If you want to disable it, you need to disable | ||
the whole `status-query` module through setting `selector=-`. | ||
|
||
```yaml | ||
status-query: | ||
selector: ${SW_STATUS_QUERY:default} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters