Skip to content

Commit a3b563f

Browse files
authored
Add Status APIs docs. (#12852)
1 parent f030184 commit a3b563f

File tree

4 files changed

+36
-11
lines changed

4 files changed

+36
-11
lines changed

docs/en/changes/changes.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,5 +64,6 @@
6464
* Improve component-libraries documentation.
6565
* Improve configuration-vocabulary documentation.
6666
* Add `Get Effective TTL Configurations` API documentation.
67+
* Add Status APIs docs.
6768

6869
All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/224?closed=1)

docs/en/debugging/config_dump.md

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,4 @@ By default, we mask the config keys through the following configurations.
6262
```yaml
6363
# Include the list of keywords to filter configurations including secrets. Separate keywords by a comma.
6464
keywords4MaskingSecretsOfConfig: ${SW_DEBUGGING_QUERY_KEYWORDS_FOR_MASKING_SECRETS:user,password,token,accessKey,secretKey,authentication}
65-
```
66-
67-
## Disable The Config Dump Service
68-
69-
By default, this service is open for helping users to debug and diagnose. If you want to disable it, you need to diable the whole
70-
`debugging-query` module through setting `selector=-`.
71-
72-
```yaml
73-
debugging-query:
74-
selector: ${SW_DEBUGGING_QUERY:-}
75-
```
65+
```

docs/en/status/status_apis.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Status APIs
2+
3+
Status APIs are a set of APIs that allow you to get the status of the OAP status and measurements of queries.
4+
They are useful for monitoring the health of the OAP server and to diagnose and troubleshoot issues caused by
5+
configurations and performance bottlenecks.
6+
7+
Since v10, we begin to add status APIs to help users to understand the status of the OAP server, besides looking the raw
8+
logs and self-observability solutions.
9+
10+
- [Dump Effective Initial Configurations API](../debugging/config_dump.md)
11+
- [Tracing Query Execution APIs](../debugging/query-tracing.md)
12+
- [Get Effective TTL Configurations API](query_ttl_setup.md)
13+
14+
If you have a proposal about new status API, please don't hesitate
15+
to [create a discussion](https://github.com/apache/skywalking/discussions/new?category=ideas).
16+
The basic principles for a status API are
17+
18+
1. It should be useful for users to understand the status of the OAP server or the reason of the performance behavior,
19+
rather than a function feature.
20+
2. It should be on-demand and not impact the performance of the OAP server too much, especially in the production
21+
environment.
22+
3. HTTP APIs are preferred unless there is a special reason to use other.
23+
24+
## Disable Status APIs
25+
26+
By default, this service is open for helping users to debug and diagnose. If you want to disable it, you need to disable
27+
the whole `status-query` module through setting `selector=-`.
28+
29+
```yaml
30+
status-query:
31+
selector: ${SW_STATUS_QUERY:default}
32+
```

docs/menu.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,8 @@ catalog:
336336
path: "/en/api/health-check"
337337
- name: "Status APIs"
338338
catalog:
339+
- name: "Introduction"
340+
path: "/en/status/status_apis"
339341
- name: "Dump Effective Initial Configurations"
340342
path: "/en/debugging/config_dump"
341343
- name: "Tracing Query Execution"

0 commit comments

Comments
 (0)