Skip to content

Commit

Permalink
Add Status APIs docs. (#12852)
Browse files Browse the repository at this point in the history
  • Loading branch information
wu-sheng authored Dec 12, 2024
1 parent f030184 commit a3b563f
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 11 deletions.
1 change: 1 addition & 0 deletions docs/en/changes/changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,5 +64,6 @@
* Improve component-libraries documentation.
* Improve configuration-vocabulary documentation.
* Add `Get Effective TTL Configurations` API documentation.
* Add Status APIs docs.

All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/224?closed=1)
12 changes: 1 addition & 11 deletions docs/en/debugging/config_dump.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,4 @@ By default, we mask the config keys through the following configurations.
```yaml
# Include the list of keywords to filter configurations including secrets. Separate keywords by a comma.
keywords4MaskingSecretsOfConfig: ${SW_DEBUGGING_QUERY_KEYWORDS_FOR_MASKING_SECRETS:user,password,token,accessKey,secretKey,authentication}
```

## Disable The Config Dump Service

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
`debugging-query` module through setting `selector=-`.

```yaml
debugging-query:
selector: ${SW_DEBUGGING_QUERY:-}
```
```
32 changes: 32 additions & 0 deletions docs/en/status/status_apis.md
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}
```
2 changes: 2 additions & 0 deletions docs/menu.yml
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,8 @@ catalog:
path: "/en/api/health-check"
- name: "Status APIs"
catalog:
- name: "Introduction"
path: "/en/status/status_apis"
- name: "Dump Effective Initial Configurations"
path: "/en/debugging/config_dump"
- name: "Tracing Query Execution"
Expand Down

0 comments on commit a3b563f

Please sign in to comment.