PeterZh6 opened a new pull request, #1056:
URL: https://github.com/apache/inlong-website/pull/1056
Fixes #1055
### Motivation
This PR addresses the lack of documentation for user-defined Flink metrics
in the `inlong-sort` component. Recent updates introduced new metrics
capabilities, but there is limited guidance on how to add and integrate custom
metrics, especially when creating a new connector. This documentation aims to
provide clear development instructions to help developers more easily customize
and extend metrics within `inlong-sort`.
### Modifications
- Added a detailed guide on defining, registering, and utilizing custom
Flink metrics in the `inlong-sort` framework.
- Included examples and code snippets for creating and integrating metrics
with connectors, focusing on deserialization error tracking.
- Provided instructions on testing and verifying new metrics using
`sort-end-to-end-tests`.
- Outlined potential issues and best practices, such as handling null
pointers and ensuring correct metric registration.
### Verifying this change
- [ ] Ensure that the documentation additions are aligned with the latest
metrics capabilities and that they pass CI checks.
*(Please pick either of the following options)*
- [ ] This change is a trivial rework/code cleanup without any test coverage.
- [ ] This change is already covered by existing tests, such as:
- Documentation-only change, with no direct impact on code functionality.
- [x] This change added tests and can be verified as follows:
- N/A (Documentation-only PR)
Demo Screenshots of this change:
**Chinese Version:**
<img width="1280" alt="DocDemoChinese"
src="https://github.com/user-attachments/assets/84763877-20e1-4383-9766-2c7d63c04fbb";>
**English Version:**
<img width="1280" alt="DocDemoENg"
src="https://github.com/user-attachments/assets/d163ba50-524d-4793-8803-2ff643a5a75f";>
### Documentation
- Does this pull request introduce a new feature? No
- If yes, how is the feature documented? N/A
- If a feature is not applicable for documentation, explain why?
Documentation is the primary focus of this PR.
- If a feature is not documented yet in this PR, please create a followup
issue for adding the documentation: N/A
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
