kyuubi/docs/monitor/index.rst
dnskr d33aa0be9c
[KYUUBI #6938] [DOC] Refine monitoring docs
### Why are the changes needed?

The PR is needed to make monitoring docs more clear and aligned with [General Style](https://kyuubi.readthedocs.io/en/master/contributing/doc/style.html#general-style):
 - Used unordered list instead of ordered (similar to other menus)
 - Deleted empty `events.md` page
 - Pages renamed to shorter versions
 - Fixed `Trouble Shooting` typo

### How was this patch tested?
Tested by building documentation locally.

**Before changes**
<img width="1189" alt="image" src="https://github.com/user-attachments/assets/9cd8e55e-9bf3-4667-b7d0-0188a71402a8" />

**After changes**
<img width="1213" alt="image" src="https://github.com/user-attachments/assets/2f51f24e-d997-45b4-b335-af9142d6ee08" />

### Was this patch authored or co-authored using generative AI tooling?

No

Closes #6938 from dnskr/refine-monitoring-docs.

Closes #6938

7ac8dcb2c [dnskr] [DOC] Refine monitoring docs

Authored-by: dnskr <dnskrv88@gmail.com>
Signed-off-by: Cheng Pan <chengpan@apache.org>
2025-02-25 22:20:05 +08:00

28 lines
983 B
ReStructuredText

.. Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
.. http://www.apache.org/licenses/LICENSE-2.0
.. Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Monitoring
==========
In this section, you will learn how to monitor Kyuubi with logging, metrics etc..
.. toctree::
:maxdepth: 2
:glob:
logging
metrics
troubleshooting